This is the Server Side / Part Two of the Rabbit Sky. It job is to run WebSocket server to connects all players.
We recommend using Linux for the server side. Works well on Linux (Tested on CentOS 7 and Ubuntu 18), also tested on Windows, but haven't tested it on Mac yet since we don't have one.
Click here to see the Static Web / Part One
Please refer to Release Page to download the latest binary.
./rabbitsky [-port num] [-tick num] [-max-players num] [-origin string]
| Args | Type | Default | Description |
|---|---|---|---|
| -port | number | 8080 | Port this app will listen to. |
| -tick | number | 10 | Server tick in Hz. How often the client and server communicate to each other. Please note that increasing the value will increase the usage of bandwidth for both client and server. We recommend to not increase or decrease the value. Increasing it to more than 30 can cause some problems, and we do not allow it to be set more than 60. |
| -max-players | number | 100 | Maximum players this server can serve. Please note that the more players in the server, the more bandwidth is used by both the client and the server. Default is the best for both, increasing it to more than 250 can cause some problems. |
| -origin | string | https://demo.rabbitsky.io | URL of the domain you use for the static file (rabbitsky-web). This is used for CORS. Please remember to input the scheme (http:// or https://) and remove trailing slash. |
| -admin-password | string | Set admin password to use slash command. Set it on in-game chat using /admin [password]. Leaving it empty will make slash command unusable. | |
| -limit-position-min | string | 0,0,0 | Set player limit minimum of player position. If position less than this limit, user will be disconnected. Format is X,Y,Z. |
| -limit-position-max | string | 4000,100,3000 | Set player limit maximum of player position. If position more than this limit, user will be disconnected. Format is X,Y,Z. |
| Args | Type | Default | Description |
|---|---|---|---|
| -add-bots | number | 0 | Add x numbers of bots in the server. Bot will randomly moving. It's for debugging only and it is recommended to not use this in production. |
Sometime the server can crash during the event, so if you want it to be automatically restart when crash, you can create a script or service.
If you're using Linux we recommend you to create your own service using systemd. Please refer to this post to start: How to create systemd service?.
| Command | Description |
|---|---|
| /admin [password] | Set the admin password for the server. If the admin password is valid, you are marked as admin and can do other commands below. |
| /fly on|off | Enable flying for current player. To enable you can use /fly or /fly on, and to disable you can use /fly off. |
| /size [number] | Set the size of player. Default is 1. Range 1-9. |
| /sky [color] | Set the sky color of the server. Color can be HEX, RGB, HSL or valid color name like blue, red, white etc. |
| /skyflash [time tick] (time fade) [color1] [color2] (color3) (color4) | Set the sky color of the server, but with continues changing every time tick. Time is in Milliseconds. Best to use HEX color instead of RGG, HSL, or valid color name. Time fade, color 3 and color 4 are optional. Time fade is how fast the transition between two colors. If time fade is empty, fade is set to be the same value as time tick. |
| /light off|on|flash (time tick) (time fade) (color) | Set the light color of the server. There are 3 types, off, on and flash. Off will not accept anymore argument. On will only accept color argument. Flash accept time tick, fade (optional) and color. Time tick and fade is on millisecond. Color is better in HEX, but can use any type of color (RGB, HSL, Color Name) |
| /botadd | Add bot to your position, also fill the server. |
| /botremove | Remove all bots created. |
It's relatively easy. We created a Makefile just for that! All you have to do is to have golang on your PC / Mac. Click here to see how to install golang.
If you have golang already, you can try command make on Linux / Mac. If you're using another OS, you can use command go build .
If it works, you can test your build with command ./rabbitsky -help
We haven't found a perfect way to secure the WebSocket connection, except using Origin header.
Token is the only thing we consider during the creation of the server, but it only best with user authentication / login. Generating token for each non-authenticated user is kinda useless, because everyone can create a token easily, so it's easy to break in. Also we don't really want to use Cookie.
Let me know if you have an idea for this matter!
Liking this and having a spare of money? Consider donating!
Yes