Skip to content

Latest commit

 

History

History
80 lines (55 loc) · 2.2 KB

README.rst

File metadata and controls

80 lines (55 loc) · 2.2 KB

Whirl

Whirl: The Open-Source WorldServer

A Worlds United


Whirl is an open-source implementation of Worlds' WorldServer protocol, written in the modern and safe Rust.

Purpose

Two main reasons;

  1. Worlds' official servers are old, slowly deteriorating, and probably unmaintained.
  2. Worlds is old; the shutdown of the servers is inevitable.

TLDR: To keep Worlds' legacy alive for future generations.

Usage

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

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`

Development Dependencies

Required

Optional

Licence

This project is licensed with the GNU General Public License v3.0.