Whirl is an open-source implementation of Worlds' WorldServer protocol, written in the modern and safe Rust.
Two main reasons;
- Worlds' official servers are old, slowly deteriorating, and probably unmaintained.
- Worlds is old; the shutdown of the servers is inevitable.
TLDR: To keep Worlds' legacy alive for future generations.
Use in production environments is not recommended as this project is currently under heavy development.
As stability increases, periodic updates regarding production use will be released (via Discord or blog).
Documentation about the entire Whirlsplash ecosystem can be found here.
If you are looking for explicit documentation of only Whirl's source code, you may generate them yourself be cloning the repository and running the doc Cargo subcommand:
$ cargo +nightly doc --open --document-private-items --no-deps # or `cargo make gen-docs`- Rust — The backbone of it all.
- diesel_cli — Database migrations, setup, et cetera
- cargo-make — Cross-platform make substitute
- cargo-watch — Recompilation on file-system changes
- sqlfluff — SQL linting
- Valgrind — Benchmarking
This project is licensed with the GNU General Public License v3.0.