blob: 48a90b4f64f24f25d4ac7e8a9a97c65722be8745 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
|
.. raw:: html
<p align="center">
<a href="https://github.com/Whirlsplash/whirl">
<img src="https://raw.githubusercontent.com/Whirlsplash/assets/master/Whirl.png"
alt="Whirl" width="220">
</a>
</p>
<h1 align="center">The Open-Source WorldServer.</h1>
<p align="center">
.. image:: https://img.shields.io/discord/821938182274154506
:alt: Discord
:target: https://discord.com/invite/8hn6padWF6
.. image:: https://www.codefactor.io/repository/github/whirlsplash/whirl/badge
:alt: CodeFactor
:target: https://www.codefactor.io/repository/github/whirlsplash/whirl
.. image:: https://img.shields.io/badge/Say%20Thanks-!-1EAEDB.svg
:alt: Say Thanks
:target: https://saythanks.io/to/[email protected]
.. image:: https://img.shields.io/github/license/Whirlsplash/whirl
:alt: License
:target: ./LICENSE
.. raw:: html
</p>
Whirl, an open-source
`WorldServer <http://dev.worlds.net/private/GammaDocs/WorldServer.html>`__
implementation in `Rust <https://www.rust-lang.org/>`__.
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 going 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.
Documentation
-------------
https://whirlsplash.org/docs/
Known issues
------------
- https://github.com/Whirlsplash/whirl/issues/2
Contributing
------------
Please reference the `contribution guidelines <./CONTRIBUTING.md>`__ of this repository.
Development Dependencies
------------------------
Required
~~~~~~~~
- `diesel\_cli <https://crates.io/crates/diesel_cli>`__
- `cargo-make <https://github.com/sagiegurari/cargo-make>`__
Optional
~~~~~~~~
- `cargo-watch <https://crates.io/crates/cargo-watch>`__
*These development dependencies will automatically be satisfied if you are using the Nix shell
configuration as provided.*
License
~~~~~~~
`GNU General Public License v3.0 <./LICENSE>`__
|