-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add documentation to config.ini + some new fields
They still need to be parsed but it's there for now Signed-off-by: emneo <emneo@kreog.com>
- Loading branch information
Showing
1 changed file
with
57 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,60 @@ | ||
[network] | ||
; The ip the server needs to bind to (supports ipv4 and ipv6) | ||
; 0.0.0.0 | available outside of the running machine (default) | ||
; 127.0.0.1 | only available from the running machine | ||
; ::1 | shorter way to express the previous example | ||
ip=0.0.0.0 | ||
|
||
; The port the server needs to bind to | ||
; 2105 | (default) | ||
port=2105 | ||
|
||
[game] | ||
; The size of the board on which the game is played | ||
; 20 | The game will be played on a 20x20 board (default) | ||
board-size=20 | ||
|
||
; The maximum time per player to play, a player loses if they exceed this limit | ||
; The value is in milliseconds | ||
; -1 | no timeout, the match will take as long as it needs to take | ||
; 0 | the first player to play will lose instantly | ||
; 300000 | each player as 300000ms or 5min to play the match (default) | ||
timeout-match=300000 | ||
|
||
; The maximum time per player to play each turn, a player loses if they exceed | ||
; this limit | ||
; The value is in milliseconds | ||
; -1 | no timeout, each player can take as much time as they want per turn | ||
; 0 | the first player to play will lose instantly | ||
; 10000 | each player as 10000ms or 10s to play their turn (default) | ||
timeout-turn=10000 | ||
|
||
; The maximum memory allowed per player | ||
; There is no way to reliably this setting on the players if they are not | ||
; controlled directly by the server | ||
; The value is in KB | ||
; 0 | no limit (default) | ||
; 5000 | each player can use 5MB on RAM each | ||
max-memory=0 | ||
|
||
[other] | ||
; How many spectators should be allowed at most on the server | ||
; -1 | Unlimited (Not recommended) | ||
; 0 | No spectators allowed (No graphical feedback) | ||
; 10 | 10 spectators allowed at most (default) | ||
spectator-slots=10 | ||
|
||
; The message of the day every client will see when connecting | ||
; h | (default) | ||
; Frieren is really good you should watch it | facts (recommended) | ||
motd=h | ||
|
||
[log] | ||
; Minimum log level | ||
; debug | All logs are shown (Lots of data) | ||
; info | All logs at info or above are shown (default) | ||
; warn | All logs at warn or above are shown | ||
; error | All logs at error or above are shown (almost nothing) | ||
; fatal | All logs at fatal are shown (Only happens once at most) | ||
; none | No logs are shown ever | ||
log-level=info |