Skip to content
This repository was archived by the owner on Jan 11, 2024. It is now read-only.

Server Administration

Kilian edited this page Feb 13, 2023 · 2 revisions

How to Use

Similar to Administration Systems in other game (ex: ULX, SourceMod, Minecraft Server) Breaker uses commands with a Target and Parameters.

The Target decides which players the command will have an effect on. (Some commands only allow one target) A Target can be specified with a SteamID64, a Steam Username (If the player is online) or a selector.

The Parameters of a command change the effect of a command in various ways. Some commands have Parameters for which action to execute (ex: add / remove) while others have Parameters to change the severity of an effect. (ex: Ban Duration)

You can execute commands with this syntax: brk [command name] [parameter1] [parameter2] [parameter...]

Selectors

This list contains all Selectors included with Breaker by default. Single-User:

  • @me | Selects the caller of the command
  • @random | Selects a random player

Multi-User:

  • @all | Selects all users

Enabling features

  • To enable whitelist, use the breaker_enable_whitelist convar.
    • You can manage the whitelist with the Whitelist command.
  • To enable reserved slots, set breaker_reserved_slots to the number of reserved slots you want.
    • To allow people to use reserved slots, add them to a group which has the breaker.useslot permission.

Commands

This list contains parameters and descriptions for each command. The Commands are specified in a format of name (required parameters) [optional parameters] Required permissions are listed below the syntax.

Basic Commands

Help

help [page] Permissions: None

Prints out a list of commands.

Reload

reload Permissions: breaker.reload

Reloads config and user information from files.

Announce

announce (message) Permissions: breaker.announce

Announces a message to all players.

Moderation

Kick

kick (players) [reason] Permissions: breaker.kick

Kicks a player from the server with a specified reason attached.

Ban

kick (players) [time] [reason] Permissions: breaker.ban

Bans a player from the server for a certain amount of time with a specified reason attached. (Time defaults to permanent)

Unban

unban (steamid) Permissions: breaker.unban

Unbans a player from the server.

User Management

Get Users

getusers Permissions: None

Prints out a list of all users and their groups.

User Group

usergroup (add|remove) (target) (group) Permissions: breaker.user.group

Adds or removes a user from a specific group by steamid.

Group Management

Get Groups

getgroups Permissions: None

Prints out a list of all groups and their permissions.

Add Group

groupadd (id) (weight) [permissions] Permissions: breaker.group.create

Creates a new group with a specified id, weight and permissions. (seperated with ;)

Remove Group

groupremove (id) Permissions: breaker.group.remove

Removes a group with the specified id.

Edit Permissions

groupperms (add|remove) (id) (permission) Permissions: breaker.group.edit.permissions

Adds or removes a specified permission from the group.

Edit Weight

groupperms (id) (weight) Permissions: breaker.group.edit.weight

Sets the weight of a specified group to a certain value.

Whitelist

Whitelist

whitelist (add|remove) (targets) Permissions: breaker.whitelist.manage

Adds or removes a player from the whitelist.

Whitelistoffline

whitelistoffline (add|remove) (steamid) Permissions: breaker.whitelist.manage

Adds or removes a player from the whitelist by steamid.

Clone this wiki locally