Skip to content

Commit ade98a5

Browse files
committed
Add example server_config.yml to README
1 parent b225f3b commit ade98a5

File tree

1 file changed

+24
-4
lines changed

1 file changed

+24
-4
lines changed

README.md

+24-4
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,11 @@ released apart from the actual server.
1313
## Features
1414

1515
* ``stop``-Command to stop the server (Permission: ``command.stop``)
16-
* Asynchronous writing of Log files
17-
* ColorCode support in the Console
18-
* Proxy support with Configuration (BungeeCord, Waterfall, Velocity)
19-
* Project structure to support API building
16+
* Asynchronous writing of log-files
17+
* [ColorCode](https://minecraft.fandom.com/wiki/Formatting_codes) support in the Console
18+
* Proxy support (BungeeCord, Waterfall, Velocity)
19+
* Structure to publish separate API
20+
* YAML configuration file (``server_config.yml``)
2021

2122
## Publishing
2223

@@ -39,3 +40,22 @@ open-sourcing [Sabre](https://github.com/Project-Cepi/Sabre)!
3940
## Contributions
4041

4142
If you want to contribute, pull requests are always welcome!
43+
44+
## Server Configuration
45+
46+
This is the default configuration when the server gets started for the first time:
47+
48+
````yaml
49+
server:
50+
# The host address of the server
51+
host: 0.0.0.0
52+
# The listening port of the server
53+
port: 25565
54+
# Toggle online-mode (mojang authentication) of the server
55+
online-mode: true
56+
proxy:
57+
# Toggle proxy-mode of the server (options: NONE, BUNGEECORD, VELOCITY)
58+
proxy-mode: NONE
59+
# Set your velocity-secret
60+
velocity-secret: ''
61+
````

0 commit comments

Comments
 (0)