Skip to content

A lightweight Minecraft server written from scratch in Rust supporting Minecraft versions from 1.7.2 up to 1.21.5.

License

Notifications You must be signed in to change notification settings

Quozul/PicoLimbo

Repository files navigation

PicoLimbo

GitHub CI Latest Release License Discord

An ultra-lightweight, multi-version Minecraft limbo server written in Rust. It currently supports all Minecraft versions from 1.7.2 through 1.21.5.


Community & Support

If you have any questions or suggestions, join the Discord server!

Introduction

PicoLimbo is a lightweight limbo server 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.

When idle, PicoLimbo uses almost no resources: 0% CPU and less than 10 MB of memory, making it extremely lightweight.

While not aiming to replicate every Minecraft server feature, PicoLimbo supports all Minecraft versions from 1.7.2 through 1.21.5, excluding snapshots, with only 24 implemented packets covering over 45 Minecraft versions.

Features

Velocity Modern Forwarding

Supports Velocity Modern Forwarding, allowing it to receive forwarded player information from the Velocity proxy. To enable this, pass the secret key as a command line argument to the pico_limbo binary:

pico_limbo --address 127.0.0.1:25565 --secret-key MyForwardingSecret

Multiple Version Support

Supports all major Minecraft versions from 1.7.2 to 1.21.5 with a single binary, no need for ViaVersion or ViaBackwards. Snapshots are not supported.

PicoLimbo.png
Only a few of the supported versions are on the above screenshot.


Getting Started

Pterodactyl (recommended)

For users of the Pterodactyl panel, deployment is simplified with the included egg file.
Velocity Modern Forwarding can be enabled by setting the corresponding environment variable from Pterodactyl panel.

Using Docker

Start the server easily with Docker:

docker run --rm -p "25565:25565" ghcr.io/quozul/picolimbo:latest

Using Docker Compose

For a more managed and scalable setup, use Docker Compose. A sample docker-compose.yml file is available in the repository. Simply download the docker-compose.yml file and run:

docker compose up

Binary / Standalone

Important

Ensure the assets directory is placed alongside the PicoLimbo binary, as it contains essential files required for server execution.

GitHub Releases

Download pre-compiled binaries for multiple platforms from the GitHub releases page. No Java or other dependencies required.

Compiling from Source with Cargo

To build PicoLimbo from source, you can use Cargo:

cargo install --git https://github.com/Quozul/PicoLimbo.git pico_limbo

Similar Projects


Contributing

Contributions are welcome! If you encounter any issues or have suggestions for improvement, please submit an issue or pull request on GitHub. Make sure to follow the existing code style and include relevant tests.

  1. Fork the repository.
  2. Create a new branch git checkout -b <branch-name>.
  3. Make changes and commit git commit -m 'Add some feature'.
  4. Push to your fork git push origin <branch-name>.
  5. Submit a pull request.

About

A lightweight Minecraft server written from scratch in Rust supporting Minecraft versions from 1.7.2 up to 1.21.5.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Languages