diff --git a/README.md b/README.md index e122948..0a0c043 100644 --- a/README.md +++ b/README.md @@ -14,112 +14,112 @@ config.ini is a good starting point, and contains the important available settin ### Server -Property | Explanation ------------------------| ------------- -name | Name of the server that will be visible in the server list -port | Port number, must be a number between 0 and 65535. 27585 is the default, and most servers are in the 27585-27599 range. -mode | Game mode. Currently supported values are "match" (play matches), "warmup" (warmup mode forever), "russian" (Russian 1v1/2v2), and "shootout" (shootout mode). -public | If true, the server will notify the master server so that clients can find this server easily in the server list. -public_address | (optional) Master server address. -log_name | (optional) Log name prefix. Log files will end up in a "log" folder in the current working directory, and be named *log_name*-*date*. Default log name prefix is the server name + ".log". -team_max | Number of players allowed in each team. -player_max | Number of players allowed in the server. -password | Administrator password. -welcome | Welcome message that is sent to all players when they're joining. \n will create a new line. The client can only show 7 chat lines at a time, and it is not recommended to have more than three lines. -replays | (optional) If true, all matches that start will be saved as replays. Games that ended before the warmup ended will not be saved. -service | Service name for Linux based systems. Command /serverrestart for restarting the service. -replay_endpoint | If configured (and replays are enabled), the server will send the replay data as a HTTP POST request (multipart form) to the given URL when matches end. +| Property | Explanation | +|-----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| name | Name of the server that will be visible in the server list | +| port | Port number, must be a number between 0 and 65535. 27585 is the default, and most servers are in the 27585-27599 range. | +| mode | Game mode. Currently supported values are "match" (play matches), "warmup" (warmup mode forever), "russian" (Russian 1v1/2v2), and "shootout" (shootout mode). | +| public | If true, the server will notify the master server so that clients can find this server easily in the server list. | +| public_address | (optional) Master server address. | +| log_name | (optional) Log name prefix. Log files will end up in a "log" folder in the current working directory, and be named *log_name*-*date*. Default log name prefix is the server name + ".log". | +| team_max | Number of players allowed in each team. | +| player_max | Number of players allowed in the server. | +| password | Administrator password. | +| welcome | Welcome message that is sent to all players when they're joining. \n will create a new line. The client can only show 7 chat lines at a time, and it is not recommended to have more than three lines. | +| replays | (optional) If true, all matches that start will be saved as replays. Games that ended before the warmup ended will not be saved. | +| service | Service name for Linux based systems. Command /serverrestart for restarting the service. | +| replay_endpoint | If configured (and replays are enabled), the server will send the replay data as a HTTP POST request (multipart form) to the given URL when matches end. | ### Game -Property | Explanation ------------------------| ------------- -spawn | Spawn point for players who join a team. Allowed values are "center" (default, spawns players at the center faceoff circle) and "bench" (spawns players right next to the "bench", opposite side of the spectator camera) -limit_jump_speed | If true, nerfs jump speed, effectively nerfing double-jumping. If false, it should work like vanilla. -offside | Offside setting. Allowed values are "off" (default, no offside), "on", (offside rule enabled) and "immediate", which will call offside immediately instead of warning when the puck has entered the offensive zone in an offside situation. -offsideline | Offside line setting. Allowed values are "blue" (default, offensive blue line), and "center" (center line) -icing | Icing setting. Allowed values are "off" (default, no icing), "on" (touch icing rule enabled) and "notouch" (no-touch icing rule enabled) -twolinepass | Two-line pass setting. Allowed values are "off" (default, no two-line pass rule), "on" (passes through own blue and center red line disallowed), "forward" (passes through center red line and offensive blue line disallowed), "both" (both "on" and "forward" at the same time) and "three" (passes through all three lines disallowed) -time_period | (Match mode only) Period length in seconds. -time_warmup | (Match mode only) Warmup length in seconds. -time_intermission | (Match mode only) Intermission length in seconds. -warmup_pucks | Number of pucks in warmup. Only 32 objects (pucks+players) are allowed on the ice at the time, so at warmup there can never be more players than (32 minus number of pucks) on the ice. -periods | (Match mode only) Number of regular periods. Default is 3 for regular match mode and 1 for multi-puck match mode. -mercy | (Match mode only) Mercy rule setting. If 0, mercy rule will be disabled. Otherwise, games will automatically end if a team scores and leads by at least X goals. -first | (Match mode only) First-to-goals rule setting. If 0, first-to-goals rule will be disabled. Otherwise, games will automatically end if a team scores and and reaches at least X goals scored. -attempts | (Russian 1v1 or shootout mode only) How many attempts each team will get. Default is 5 for shootout mode and 10 for Russian 1v1 mode. -blue_line_location | (Match or Russian 1v1 only) Distance between the end boards and the edge of the blue line closest to the neutral zone in meters. Default is 22.86, as in official IIHF rules. -use_mph | (Match mode only) If true, print puck speeds in miles per hour. -goal_replay | (Match mode) Show goal replays after scored goals. +| Property | Explanation | +|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| spawn | Spawn point for players who join a team. Allowed values are "center" (default, spawns players at the center faceoff circle) and "bench" (spawns players right next to the "bench", opposite side of the spectator camera) | +| limit_jump_speed | If true, nerfs jump speed, effectively nerfing double-jumping. If false, it should work like vanilla. | +| offside | Offside setting. Allowed values are "off" (default, no offside), "on", (offside rule enabled) and "immediate", which will call offside immediately instead of warning when the puck has entered the offensive zone in an offside situation. | +| offsideline | Offside line setting. Allowed values are "blue" (default, offensive blue line), and "center" (center line) | +| icing | Icing setting. Allowed values are "off" (default, no icing), "on" (touch icing rule enabled) and "notouch" (no-touch icing rule enabled) | +| twolinepass | Two-line pass setting. Allowed values are "off" (default, no two-line pass rule), "on" (passes through own blue and center red line disallowed), "forward" (passes through center red line and offensive blue line disallowed), "both" (both "on" and "forward" at the same time) and "three" (passes through all three lines disallowed) | +| time_period | (Match mode only) Period length in seconds. | +| time_warmup | (Match mode only) Warmup length in seconds. | +| time_intermission | (Match mode only) Intermission length in seconds. | +| warmup_pucks | Number of pucks in warmup. Only 32 objects (pucks+players) are allowed on the ice at the time, so at warmup there can never be more players than (32 minus number of pucks) on the ice. | +| periods | (Match mode only) Number of regular periods. Default is 3 for regular match mode and 1 for multi-puck match mode. | +| mercy | (Match mode only) Mercy rule setting. If 0, mercy rule will be disabled. Otherwise, games will automatically end if a team scores and leads by at least X goals. | +| first | (Match mode only) First-to-goals rule setting. If 0, first-to-goals rule will be disabled. Otherwise, games will automatically end if a team scores and and reaches at least X goals scored. | +| attempts | (Russian 1v1 or shootout mode only) How many attempts each team will get. Default is 5 for shootout mode and 10 for Russian 1v1 mode. | +| blue_line_location | (Match or Russian 1v1 only) Distance between the end boards and the edge of the blue line closest to the neutral zone in meters. Default is 22.86, as in official IIHF rules. | +| use_mph | (Match mode only) If true, print puck speeds in miles per hour. | +| goal_replay | (Match mode) Show goal replays after scored goals. | ### Physics -Property | Explanation ---------------------------|---------------- -gravity | Gravitational acceleration in meters per second squared. Default is 6.80555. -player_acceleration | Player acceleration in meters per second squared. Default is 2.08333. -player_deceleration | Player deceleration in meters per second squared. Default is 5.55555. -max_player_speed | Maximum player speed in meters per second. Default is 5. -max_player_shift_speed | Some shift-turning related maximum speed in meters per second. Default is 3.33333. -puck_rink_friction | Friction rotation between puck and rink (both ice and boards). Default is 0.05. -player_turning | Player turning acceleration in meters per second squared. Default is 4.1666666. -player_shift_turning | Player shift-turning acceleration in meters per second squared. Default is 3.88888. -player_shift_acceleration | Some shift-turning related acceleration in meters per second squared. Default is 2.7777. +| Property | Explanation | +|---------------------------|------------------------------------------------------------------------------------------| +| gravity | Gravitational acceleration in meters per second squared. Default is 6.80555. | +| player_acceleration | Player acceleration in meters per second squared. Default is 2.08333. | +| player_deceleration | Player deceleration in meters per second squared. Default is 5.55555. | +| max_player_speed | Maximum player speed in meters per second. Default is 5. | +| max_player_shift_speed | Some shift-turning related maximum speed in meters per second. Default is 3.33333. | +| puck_rink_friction | Friction rotation between puck and rink (both ice and boards). Default is 0.05. | +| player_turning | Player turning acceleration in meters per second squared. Default is 4.1666666. | +| player_shift_turning | Player shift-turning acceleration in meters per second squared. Default is 3.88888. | +| player_shift_acceleration | Some shift-turning related acceleration in meters per second squared. Default is 2.7777. | ## Commands ### Available for all -Commands | Explanation ------------------------|-------------- -/t | Write a message that will only be seen by your team mates. -/list | Lists up to 5 player IDs. These IDs are used for a few other commands to uniquely determine a player. -/list *ID* | Lists up to 5 player IDs, starting from *ID*, which must be a number. -/search *S* | Lists up to 5 player IDs of players who have the substring S in their player name. -/view *ID* | Enters first person view of player with ID *ID*. If you're on the ice, your player will be removed and you will become a spectator. -/views *S* | Searches for player with name *S* and enters first person view of that player if a unique match is found. If multiple matches are found, they are listed instead. -/restoreview | Restores first person view. -/ping *ID* | Get server-side ping of player with ID *ID* -/pings *S* | Searches for player with name *S* and gets server-side ping for that player if a unique match is found. If multiple matches are found, they are listed instead. -/lefty | Makes player left-handed. If done during play, it will only be applied after play has stopped. -/righty | Makes player right-handed. If done during play, it will only be applied after play has stopped. -/rules | Shows current offside/icing rule settings. -/admin *PASSWORD* | Logs in as administrator, if the password is correct. -/chatextend | Show some additional chat messages when players join or leave teams in matches +| Commands | Explanation | +|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| /t | Write a message that will only be seen by your team mates. | +| /list | Lists up to 5 player IDs. These IDs are used for a few other commands to uniquely determine a player. | +| /list *ID* | Lists up to 5 player IDs, starting from *ID*, which must be a number. | +| /search *S* | Lists up to 5 player IDs of players who have the substring S in their player name. | +| /view *ID* | Enters first person view of player with ID *ID*. If you're on the ice, your player will be removed and you will become a spectator. | +| /views *S* | Searches for player with name *S* and enters first person view of that player if a unique match is found. If multiple matches are found, they are listed instead. | +| /restoreview | Restores first person view. | +| /ping *ID* | Get server-side ping of player with ID *ID* | +| /pings *S* | Searches for player with name *S* and gets server-side ping for that player if a unique match is found. If multiple matches are found, they are listed instead. | +| /lefty | Makes player left-handed. If done during play, it will only be applied after play has stopped. | +| /righty | Makes player right-handed. If done during play, it will only be applied after play has stopped. | +| /rules | Shows current offside/icing rule settings. | +| /admin *PASSWORD* | Logs in as administrator, if the password is correct. | +| /chatextend | Show some additional chat messages when players join or leave teams in matches | ### Administrators only -Commands | Explanation --------------------------|-------------- -/disablejoin | Prevents new players from joining the server. -/enablejoin | Enables new players to join the server. -/kick *ID* | Kicks player with ID *ID*. -/ban *ID* | Kicks and IP-bans player with ID *ID*. -/fs *ID* | Forces player with ID *ID* off ice. -/mute *ID* | Mutes player with ID *ID*. -/unmute *ID* | Unmutes player with ID *ID*. -/mutechat | Mutes all chat. -/unmutechat | Unmutes all chat, individual user chat mutes still apply. -/start | Starts game. -/reset | Resets game. -/pause | Pauses game. -/unpause | Unpauses game. -/faceoff | Calls center-ice faceoff. -/set clock *M*:*S* | Sets game clock. -/set period *N* | Sets period. OT1 is 4, OT2 is 5, etc. 0 is warmup. -/set periodnum *N* | Sets number of periods. -/set redscore *N* | Sets red score. -/set bluescore *N* | Sets blue score. -/set icing *S* | Sets icing rule. Allowed values are "off", "on" (touch icing" and "notouch" (no-touch icing) -/set offside *S* | Sets offside rule. Allowed values are "off", "on" (delayed offside) and "imm" or "immediate" (immediate offside, no offside warnings). -/set offsideline *S* | Sets offside line settings. Allowed values are "blue" (default, offensive blue line), and "center" (center line). -/set twolinepass *S* | Two-line pass setting. Allowed values are "off" (default, no two-line pass rule), "on" (passes through own blue and center red line disallowed), "forward" (passes through center red line and offensive blue line disallowed), "both" (both "on" and "forward" at the same time) and "three" (passes through all three lines disallowed) -/set teamsize *N* | Sets team size. -/set replay *on/off* | Enables/disables server-side replays. -/set mercy *N/off* | Sets mercy rule setting. If 0 or off, mercy rule will be disabled. Otherwise, games will automatically end if a team scores and leads by at least N goals. -/set first *N/off* | Sets first-to-goals rule setting. If 0, first-to-goals rule will be disabled. Otherwise, games will automatically end if a team scores and and reaches at least N goals scored. -/set goalreplay *on/off* | Enables/disabled goal replays. -/kickall *S* | Kicks all players with a player name equal to *S* (case-insensitive). % can be used as wildcards at the start and end of *S* to match players with similar names. For example, migo%, %mipo and %gomi% all match MigoMipo. -/banall *S* | Same as /kickall, but also IP-bans. -/serverrestart | Restarting the server service in Linux based OS (see "service" at "Server" section) +| Commands | Explanation | +|--------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| /disablejoin | Prevents new players from joining the server. | +| /enablejoin | Enables new players to join the server. | +| /kick *ID* | Kicks player with ID *ID*. | +| /ban *ID* | Kicks and IP-bans player with ID *ID*. | +| /fs *ID* | Forces player with ID *ID* off ice. | +| /mute *ID* | Mutes player with ID *ID*. | +| /unmute *ID* | Unmutes player with ID *ID*. | +| /mutechat | Mutes all chat. | +| /unmutechat | Unmutes all chat, individual user chat mutes still apply. | +| /start | Starts game. | +| /reset | Resets game. | +| /pause | Pauses game. | +| /unpause | Unpauses game. | +| /faceoff | Calls center-ice faceoff. | +| /set clock *M*:*S* | Sets game clock. | +| /set period *N* | Sets period. OT1 is 4, OT2 is 5, etc. 0 is warmup. | +| /set periodnum *N* | Sets number of periods. | +| /set redscore *N* | Sets red score. | +| /set bluescore *N* | Sets blue score. | +| /set icing *S* | Sets icing rule. Allowed values are "off", "on" (touch icing" and "notouch" (no-touch icing) | +| /set offside *S* | Sets offside rule. Allowed values are "off", "on" (delayed offside) and "imm" or "immediate" (immediate offside, no offside warnings). | +| /set offsideline *S* | Sets offside line settings. Allowed values are "blue" (default, offensive blue line), and "center" (center line). | +| /set twolinepass *S* | Two-line pass setting. Allowed values are "off" (default, no two-line pass rule), "on" (passes through own blue and center red line disallowed), "forward" (passes through center red line and offensive blue line disallowed), "both" (both "on" and "forward" at the same time) and "three" (passes through all three lines disallowed) | +| /set teamsize *N* | Sets team size. | +| /set replay *on/off* | Enables/disables server-side replays. | +| /set mercy *N/off* | Sets mercy rule setting. If 0 or off, mercy rule will be disabled. Otherwise, games will automatically end if a team scores and leads by at least N goals. | +| /set first *N/off* | Sets first-to-goals rule setting. If 0, first-to-goals rule will be disabled. Otherwise, games will automatically end if a team scores and and reaches at least N goals scored. | +| /set goalreplay *on/off* | Enables/disabled goal replays. | +| /kickall *S* | Kicks all players with a player name equal to *S* (case-insensitive). % can be used as wildcards at the start and end of *S* to match players with similar names. For example, migo%, %mipo and %gomi% all match MigoMipo. | +| /banall *S* | Same as /kickall, but also IP-bans. | +| /serverrestart | Restarting the server service in Linux based OS (see "service" at "Server" section) |