aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: c9db56b5715e91d4f5f840b722c57d18e0fdeb30 (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
<p align="center">
  <a href="https://github.com/Whirlsplash/whirl">
    <img src="https://raw.githubusercontent.com/Whirlsplash/assets/master/Whirl.png" alt="Whirl icon" width="220" />
  </a>
</p>
<h1 align="center">
  Whirl, an open-source <a href="http://dev.worlds.net/private/GammaDocs/WorldServer.html">WorldServer</a> implementation in <a href="https://www.rust-lang.org/">Rust</a>.
</h1>

<p align="center">
  <a href="https://discord.com/invite/8hn6padWF6" title="Discord">
    <img src="https://img.shields.io/discord/821938182274154506">
  </a>
  <a href="./LICENSE" title="License">
    <img src="https://img.shields.io/github/license/Whirlsplash/whirl">
  </a>
</p>

## 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 a work-in-progress. As we begin to become more stable and add new features, we will release periodic updates regarding production use.

## Documentation
[https://www.whirlsplash.org](https://www.whirlsplash.org)

## Development
1. Navigate to your `/etc/hosts` file, on Windows, this usually is located at `C:\Windows\System32\drivers\etc\hosts`.
2. Add these rules;
```
0.0.0.0				www.3dcd.com
0.0.0.0				test.3dcd.com
```
3. Build and run the Cargo project.
4. Profit.

## Contributing
Work-in-progress.

### License
[GNU General Public License v3.0](./LICENSE)