All the basic modules for the modular BattleBit API https://github.com/RainOrigami/BattleBitAPIRunner
- ModeratorTools - Module for basic in-game moderation tools
- MOTD - Module for displaying a message to every player who joins the server
- PlayerFinder - Library module for finding players
- PlayerPermissions - Library module for basic persistent player permissions (Roles)
- CommandHandler - Library module for easy command handling
- PermissionsCommands - Module for adding and removing permissions using in-game chat
- DiscordWebhooks - Module for sending messages to discord webhooks
- RichText - Library module for creating rich text messages
This module provides in-game chat commands to moderate the server.
All commands require the Moderator role to execute.
say message- Sends a message to all players.announceshort message- Sends a short announcement to all players.announcelong message- Sends a long announcement to all players.message player message- Sends a message to the player.clear- Clears the chat.kick player [reason]- Kicks the player from the server.ban player- Bans the player from the server.kill player- Kills the player.gag player- Gags the player preventing them from using text chat.ungag player- Un-gags the player.mute player- Mutes the player preventing them from using voice chat.unmute player- Un-mutes the player.silence player- Silences the player preventing them from using both voice and text chat.unsilence player- Un-silences the player.lockspawn [player]- Locks the spawn of the player or all players.unlockspawn [player]- Unlocks the spawn of the player or all players.
This module shows a configurable message to each player when they join a server. The following placeholders are available:
{0}- Player name{1}- Player ping in ms{2}- Server name{3}- Gamemode{4}- Map name{5}- Day or Night{6}- Map size{7}- Current player count{8}- In queue player count{9}- Max player count
setmotd "message of the day"- Sets a new MOTD. Requires Admin role to execute.motd- Shows the current MOTD again.
This module can be used by other modules to find players by different means. It doesn't do anything by itself.
- None
RunnerPlayer? ByExactName(string exactName, bool caseSensitive)- Find a player by their exact name, case sensitive or insensitive. Returns aRunnerPlayerinstance or null, if no player was found.public RunnerPlayer? ByNamePart(string namePart)- Find a player by part of their name, case insensitive. First tries exact match case sensitive, then insensitive, then partial search. If multiple players match thenamePartaManyPlayersMatchExceptionexception is thrown containing a list of matching players. Returns aRunnerPlayerinstance or null, if no player was found.RunnerPlayer? BySteamId(ulong steamId)- Find a player by their steam64id. Returns aRunnerPlayerinstance or null, if no player was found.public RunnerPlayer[] AllByNamePart(string namePart)- Find all players matching part of their name.
This module stores player roles (Admin, Moderator, Vip, Special) to a config file and will load and apply previously assigned roles to players when they join. It can also be used by other modules to get, set and check for roles of a player.
Roles are stored and shared globally across all connected servers. Every time a user role is changed, the configuration is saved.
- None
bool HasPlayerRole(ulong steamID, Roles role)- Returns true if the roles of a player include the specified role or set of roles.Roles GetPlayerRoles(ulong steamID)- Returns the players assigned roles.void SetPlayerRoles(ulong steamID, Roles roles)- Set the set of roles of a player.void AddPlayerRoles(ulong steamID, Roles role)- Adds the set of roles to the existing roles of a player.void RemovePlayerRoles(ulong steamID, Roles role)- Removes the set of roles from the existing roles of a player.
This module provides in-game chat commands to add and remove roles of players.
addperm player role- Adds the role to the player. Requires Admin role to execute.removeperm player role- Removes the role from the player. Requires Admin role to execute.
This module can be used by other modules to create easy to use chat commands and automatically parse and provide the required parameters.
The default command prefix is ! and can be changed in the global configuration.
To create a new command in your module, register your module with CommandHandler in OnModulesLoaded:
[RequireModule(typeof(CommandHandler))]
public class MyModule : BattleBitModule
{
[ModuleReference]
public CommandHandler CommandHandler { get; set; }
public override void OnModulesLoaded()
{
this.CommandHandler.Register(this);
}
}Commands are public void methods that take zero or many.
They require the [CommandCallback("name")] attribute:
name- The name of the command that the player has to enter in chat (prefixed by the command prefix).Description- A short description of the command for use in thehelpcommand.AllowedRoles- A set of roles that are allowed to see and execute the command. Only works if PlayerPermissions is loaded.
The first method parameter must always be of type RunnerPlayer and contains the player who has called this command.
Other parameters are automatically parsed. Parameters of type RunnerPlayer will try to find a player using the PlayerFinder.ByNamePart if available, otherwise uses exact case-insensitive matching. Enums, such as Roles are parsed. Simple types, such as string, int, float, double, bool, are parsed.
Optional parameters and subcommands are supported
Example
[CommandCallback("ping", Description = "Ping Pong", AllowedRoles = Roles.Vip)]
public void PingCommand(RunnerPlayer commandSource, int time, string? message = null)
{
Thread.Sleep(time);
commandSource.Message($"Pong{(message is null ? "" : " ")}{message}!");
}
[CommandCallback("boop", Description = "Boop!", AllowedRoles = Roles.Vip)]
public void BoopCommand()
{
this.Server.SayToChat("Booping!");
}
[CommandCallback("test one", Description = "Subcommands", AllowedRoles = Roles.Vip)]
public void TestOneCommand()
{
this.Server.SayToChat("Subcommands!");
}
[CommandCallback("test two", Description = "Subcommands", AllowedRoles = Roles.Vip)]
public void TestTwoCommand()
{
this.Server.SayToChat("Subcommands!");
}help- Lists all available and accessible commands.help command- Shows the description and parameters of a command.
- (Optional) PlayerPermissions
- (Optional) PlayerFinder
void Register(BattleBitModule module)- Registers the commands of the specified module
This module sends player connect and disconnect, server connect and disconnect, and player chat messages to a discord webhook which is specified in DiscordWebhooks.json.
It can also be used by other modules to send raw webhook messages.
- Newtonsoft JSON -
Bin\net6.0\Newtonsoft.Json.dll - System.Net.Http - Copy from your dotnet6 installation, for example
C:\Program Files\dotnet\shared\Microsoft.NETCore.App\6.0.*\System.Net.Http.dll
void SendMessage(string message)- Send the message to the webhook
This module provides a simple way for other modules to create rich text messages for chat, announcements or messages. It doesn't do anything by itself.
- None
string NewLine()- Make a new line.string Color(string? color = null)- Sets the color of the text. Color must be hashtag prefixed hex value (eg.#22FF38). Color is optional can be null to reset the color to the default color white.string FromColorName(string colorName)- Sets the color of the text to a color based on its name. SeeBattleBitBaseModules.ColorsinRichText.csfor available color names.string SpriteByName(string spriteName, string? color = null)- Returns a sprite by name. SeeBattleBitBaseModules.SpritesinRichText.csfor available sprites. Color must be hex value (eg.#22FF38). If no color is specified, the default color is used.string Bold(bool bold)- Sets the boldness of the text. True to bold, false to unbold.string Italic(bool italic)- Sets the italicness of the text. True to italic, false to unitalic.string Underline(bool underline)- Sets the underlineness of the text. True to underline, false to ununderline.string Strikethrough(bool strikethrough)- Sets the strikethroughness of the text. True to strikethrough, false to unstrike.string Size(int size)- Sets the size of the text. Size is percentage (eg.150for 150% text size).string Mark(bool mark, string color = "#ffff00aa")- Sets the text as marked (highlighter). True to mark, false to unmark. Color must be hex value and can include alpha (eg.#22FF38AA).