<div align="center">
# PicoLimbo Java Wrapper
A Java wrapper around PicoLimbo, a lightweight, multi-version Minecraft limbo server written in Rust. This allows you to run the PicoLimbo server directly inside your proxy or as a standalone jar file.
[⭐ Star the project on GitHub](https://github.com/Quozul/PicoLimbo) • [💬 Join Discord](https://discord.gg/M2a9dxJPRy) • [📖 Read Docs](https://picolimbo.quozul.dev/)
*Schematic from [Limbo](https://modrinth.com/mod/limbo-server), another great project*
</div>
PicoLimbo is a lightweight [limbo server](https://quozul.dev/posts/2025-05-14-what-are-minecraft-limbo-servers/) written in Rust, designed primarily as an AFK or waiting server. Its core focus is on efficiency by implementing only essential packets required for client login and maintaining connection (keep-alive) without unnecessary overhead.
While not aiming to replicate every Minecraft server feature, PicoLimbo supports **all Minecraft versions from 1.7.2 up until the latest stable version**, excluding snapshots.
## 🚀 Getting Started
Choose the installation method that best fits your setup:
### 📦 [The Easy Way (Recommended)](https://modrinth.com/project/picolimbo-java-wrapper)
**Best for: Most users, home hosting, and simple setups.**
Download the `.jar` wrapper from **[Modrinth](https://modrinth.com/project/picolimbo-java-wrapper)**. This is the easiest way to get up and running and helps support the development of the project.
### ⚡ The High-Performance Way
**Best for: Dedicated servers, high-traffic environments, and power users.**
For maximum performance and the lowest possible overhead, download the **native binaries** directly from our [GitHub Releases](https://github.com/Quozul/PicoLimbo/releases). This method bypasses the JVM for the core process.
---
### 💻 Platform Compatibility (Java Wrapper)
The Java wrapper is designed to be highly compatible. It works on:
- **Windows** (x64)
- **macOS** (M-series/Apple Silicon)
- **GNU/Linux** (x64 AMD/Intel or arm64/Raspberry Pi)
*Note: If you are using **Docker** or **Pterodactyl**, it is recommended to use the specific installation guides provided in the [official documentation](https://picolimbo.quozul.dev/about/installation.html).*
<div align="center"><h1><strong>Documentation</strong></h1></div>
Please read the [installation instructions for the Java Wrapper](https://picolimbo.quozul.dev/about/installation.html#java-wrapper) and [how to configure forwarding for PicoLimbo](https://picolimbo.quozul.dev/config/proxy-integration.html) before reporting any issues.
## 🛠 Features
### Wide Version Compatibility
Supports all Minecraft versions from **1.7.2 to 26.2** (and beyond) natively, no need for ViaVersion or additional compatibility layers.
### Built-in Proxy Support
Integrates with all major Minecraft proxies:
- Velocity (Modern Forwarding)
- BungeeCord (Legacy Forwarding)
- BungeeGuard & BungeeGuardPlus authentication
### Ultra-Lightweight & Highly Scalable
When running natively, PicoLimbo uses near 0% CPU while idle and can handle hundreds of players under 10 MB RAM.
[View benchmarks](https://picolimbo.quozul.dev/about/benchmarks.html).
### Skin Support
Player skins are supported out of the box.
### Highly Configurable
Customize your server using a simple TOML configuration file, including welcome messages, spawn dimensions, server list MOTDs, and more. [View configuration docs](https://picolimbo.quozul.dev/config/introduction.html).
### Schematic World (Experimental)
Load a custom world from a schematic file and customize the spawn location (1.16+ only).
## Community & Support
If you have any questions, suggestions, or simply want to stay updated, please join the [Discord server](https://discord.gg/M2a9dxJPRy)!
