Fifty.ServerUtils

A framework for chat command based server mods. Doesn't spam the chat, doesn't cover your HUD with unnecessarily large messages, doesn't have a dogwater auto-balance.

The mod is separated into modules all of which have extensive settings and apart from the core can be entirely disabled.

Core

The core module implements a chat and a poll handler. For more information on the API check the API section.

Welcome message example:

Poll example:

Other

• Map voting
  • Adds map voting functionality at the end of the match or with the command !rtv
• Spam filter
  • Filters repeating messages
  • Filters messages sent too fast
• Team Shuffle/Balance
  • Shuffle teams on game start
  • Auto balance mid-game
• Admin utils
  • Mute/Unmute players

Commands

!help <page> - Lists commands the player is allowed to see ( check the API section ). Is paged to not spam the chat.

!name - Returns the name of the server ( ns_server_name ).

!owner - Returns the owner ( fsu_owner ).

!mods <page> - Lists installed mods ( fsu_mods ).

!rules <page> - Lists rules ( fsu_rules ).

!vote - Allows you to vote if a poll is active.

!usage <command> - Returns the command usage ( check the API section ).

!discord - Returns the discord message ( fsu_discord ).

!rtv - Rock the vote, if enough players vote ( FSU_MAPCHANGE_FRACTION ) a map vote will start.

!skip - If enough players vote ( FSU_MAPCHANGE_FRACTION ) the map will be skipped based on playlist.

!report <player> - Creates a valid report in the calling players console

!switch - Allows you to switch teams ( FSU_ENABLE_SWITCH)

Admin commands

!login - Allows you to use the rest of admin commands

!logout - Logout

!mute <player> - Mute player

!unmute <player> - Unmute player

Settings

API

Chat callbacks support ANSI escape codes, these allow you to change the colour of your text. An example of such a code is \x1b[113m which changes the colour to orange.

Global functions

void function FSU_RegisterCommand ( string command, string usage, string group, void functionref( entity, array < string > ) callbackFunc, array < string > abbreviations = [], bool functionref( entity ) visibilityFunc = null )

Registers your custom command

1. command
   • Your command, needs to have a "!"at the start
   • Example: "!help"
2. usage
   • Explanation of what the command does
   • Example: "\x1b[113m!vote\x1b[0m <number> Allows you to vote on polls"
3. group
   • Currently unused, but in the future it'll be used to categorize the commands
   • Something like !help <page/group> is planned
4. callbackFunc
   • This function gets called when the player calls your command
   • entity is player
   • array < string > is an array of arguments, args[0] would be the first argument, the command isn't passed in
5. abbreviations
   • Abbreviations of the command
   • Example: [ "!dc", "!dikord", "!dicsord" ]
6. visibilityFunc
   • Decides if the player can see the command ( For example if the !help command only shows allowed commands, same goes for !usage )

bool function FSU_CanCreatePoll ()

Returns true if you can create a poll, there can only be one poll at a time so to not conflict make sure you check this!

void function FSU_CreatePoll ( array < string > options, string before, float duration, bool show_result )

Creates the poll. It is not recommended to pass an array larger than 7.

1. options
   • A list of options
2. before
   • A string put on the first line. An example use of this would be "Vote for a map!"
3. duration
   • Duration of the poll in seconds
4. show_result
   • Decides if a message announcing the poll winner should be broadcast

int function FSU_GetPollResultIndex ()

Returns the index of the option which won the poll.

If the 1st option won it will return 0.

If there were no votes cast it returns -1.

( For more such as FSU_Mute Check code for global functions )