Notes

GitHub - Feather-rs/feather: A Minecraft Server Implementation In Rust

A Minecraft server implementation written in Rust.



Status



The project is still at an infancy stage. Many, many features are unimplemented. We are open to any and all help!



Supported Minecraft versions



Feather supports world saves and clients with 1.16.5. We don't currently plan on supporting multiple versions at once but we may look into this in the future.
MY CITY


Goals



The Feather project aims to provide a Minecraft server that is fast, modular, and paired with an ergonomic plugin API.



Our mid-term goal is to make Feather usable on hub and minigame servers. These servers only require a limited number of vanilla features, so the limitations of Feather's gameplay features are not a problem. These servers can benefit from Feather's modularity, performance, and flexibility. We are currently focusing on creating a rich plugin interface to support these use cases.



Feather could be used long-term on larger, more survival-like servers. This would allow many players to simultaneously use the same world, requiring very few resources.



Ecosystem



The Feather ecosystem includes several repositories.



libcraft is a set Rust containers that provide Minecraft functionality. Quill is our in-progress plugin API. Quill plugins were written in Rust. They are compiled to WebAssembly. Feather runs them in a sandboxed WebAssembly VM. feather is the server software that was built on top libcraft, quill.



Performance



Feather has so few features that comparisons to vanilla performance are extremely misleading. But you can have them if you really need them.



- Feather can handle 1,000,000 entities spawned by a plugin before it starts to max out the CPU. The vanilla server will croak well before that. - Feather can manage 500 concurrent player connections. Each player walks in a random way.



These results could change as Feather adds new features. Take them with a grain.



Memory usage in Feather is proportional not to player counts but to the number loaded chunks. The server uses 40MiB of RAM for the 500 player test. After that, the server starts to spread out. It uses 400MiB of RAM for the 1,000,000 entities testing without any chunks.



Running



We offer precompiled binaries on Windows, Linux and macOS at Github Actions. NB! Do not use github release, they are very outdated



To run Feather



- Extract the archive. - Run it. - On Linux and macOS: ./feather-server in the server directory - On Windows: double-click feather-server.exe



The server will create configuration files (config.toml), that you can modify.



Feather will create a world automatically. If you want to load a vanilla world, copy the world save to the server directory under the name "world" (by default).



Warning: Feather world persistence, which is relatively new, can cause problems when trying open Feather planets in vanilla. Do not let Feather touch worlds you care about unless they have been backed up.



Compiling



If you are on a different platform, compile the server by yourself to test it out.



Compiling from source requires the latest stable version of Rust. Older Rust versions may be able to compile Feather, but they are not guaranteed to keep working.



The target/release location will contain the executable for the server.



Architecture



We have a work in progress explanation of Feather’s architecture for contributors here.



- Is Feather production ready?



Not yet. There are many bugs and missing features that still need to be fixed. The codebase is not yet tested enough to allow for server production.



- How can I contribute?



To see what needs to be done, visit our issue tracker. Feel free to join our Discord and ask questions whenever you need. Thanks for your interest in contributing!



- Are there other ways I can help?



Yes! Yes! If you find anything that doesn't seem right to you, please submit an issue on the issue tracker.


Website: https://city2020.com/