> For the complete documentation index, see [llms.txt](https://wiki.elytrium.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.elytrium.net/limboapi/info.md).

# Info

{% embed url="<https://github.com/Elytrium/LimboAPI>" %}

[![Join our Discord](https://camo.githubusercontent.com/1185af6012f25cc9e1ec012ea5d7f0ed129d525a35def95f54c322f3d7526fff/68747470733a2f2f696d672e736869656c64732e696f2f646973636f72642f3737353737383832323333343730393738302e7376673f6c6f676f3d646973636f7264266c6162656c3d446973636f7264)](https://ely.su/discord) [![Proxy Stats](https://camo.githubusercontent.com/170b7b7ac089ce27e5a4df66e9c2ac1707549f3e3809390e625f29ad7d02ff7a/68747470733a2f2f696d672e736869656c64732e696f2f6273746174732f736572766572732f31323533303f6c6f676f3d6d696e656372616674266c6162656c3d53657276657273)](https://bstats.org/plugin/velocity/LimboAPI/12530) [![Proxy Stats](https://camo.githubusercontent.com/8110161e87c80e4317f8549b42182fc558a398924ad9ecdff26b609f26e814ce/68747470733a2f2f696d672e736869656c64732e696f2f6273746174732f706c61796572732f31323533303f6c6f676f3d6d696e656372616674266c6162656c3d506c6179657273)](https://bstats.org/plugin/velocity/LimboAPI/12530)

Library for sending players to virtual servers (called limbo)\
[MC-Market](https://www.mc-market.org/resources/21097/)\
[SpigotMC.org](https://www.spigotmc.org/resources/limboapi-limboauth-limbofilter.95748/)\
[Описание и обсуждение на русском языке (spigotmc.ru)](https://spigotmc.ru/resources/limboapi-limboauth-limbofilter-virtualnye-servera-dlja-velocity.715/)\
[Описание и обсуждение на русском языке (rubukkit.org)](http://rubukkit.org/threads/limboapi-limboauth-limbofilter-virtualnye-servera-dlja-velocity.177904/)

Test server: [`ely.su`](https://hotmc.ru/minecraft-server-203216)

### See also

* [LimboAuth](https://github.com/Elytrium/LimboAuth) - Auth System built in virtual server (Limbo). Uses BCrypt, has TOTP 2FA feature. Supports literally any database due to OrmLite.
* [LimboFilter](https://github.com/Elytrium/LimboFilter) - Most powerful bot filtering solution for Minecraft proxies. Built with LimboAPI.

### Features of LimboAPI

* Send to the Limbo server during login process
* Send to the Limbo server during play process
* Send maps, items to player's virtual inventory
* Display player's XP
* Send Title, Chat, ActionBar
* Load world from world files like .schematic
* and more...

### How to

* Include `limboapi-api` to your Maven/Gradle project as compile-only
* Subscribe to `LoginLimboRegisterEvent` to send players to the Limbo server during login process
* Use `LimboFactory` to send players to the Limbo server during play process

### How to include it

**Setup your project via adding our maven repository to your pom.xml or build.gradle file.**

* Maven:

```
    <repositories>
        <repository>
            <id>elytrium-repo</id>
            <url>https://maven.elytrium.net/repo/</url>
        </repository>
    </repositories>

    <dependencies>
        <dependency>
            <groupId>net.elytrium.limboapi</groupId>
            <artifactId>api</artifactId>
            <version>1.1.0</version>
            <scope>provided</scope>
        </dependency>
    </dependencies>
```

* Gradle:

```
    repositories {
        maven {
            setName("elytrium-repo")
            setUrl("https://maven.elytrium.net/repo/")
        }
    }

    dependencies {
        compileOnly("net.elytrium:limboapi-api:1.0.7")
    }
```

### Used Open Source projects

* [ProtocolSupport](https://github.com/ProtocolSupport/ProtocolSupport) - for modern->legacy block mappings
* [ViaVersion](https://github.com/ViaVersion/ViaVersion) - for modern string->integer block mappings

### Demo

* [LimboAuth](https://github.com/Elytrium/LimboAuth) - The auth plugin, that uses LimboAPI as a dependency at the basic level.
* [LimboFilter](https://github.com/Elytrium/LimboFilter) - The antibot solution, that uses LimboAPI as a dependency, using almost all available API methods, like Low-level Minecraft packet control.