Documentation
Here you will find all the necessary information to set up and manage your Surge core.
Installation
Follow these steps to get your NullHQ Practice Premade up and running quickly.
- Download the latest files from the designated updates channel on our Discord server.
- Ensure your server's Java version is set to 8 for optimal compatibility.
- Navigate to plugins/Alpine/config.yml in your server files.
- Paste your unique license key in LICENSE:.
- Fill up the MongoDB & Redis database connection credentials in this configuration file. (or use FlatFile)
- Start your Minecraft server using the start.bat script.
Placeholders
Integrate dynamic player and server statistics into your chat, scoreboards, or other plugins using these available placeholders.
| Placeholder | Description |
|---|---|
| %alpine_player_global_elo% | Displays the player's overall ELO rating. |
| %alpine_player_global_wins% | Shows the total number of wins a player has. |
| %alpine_player_global_kills% | Represents the player's total kill count. |
| %alpine_player_global_losses% | Indicates the total number of losses for a player. |
| %alpine_player_global_winstreaks% | Current highest win streak of the player. |
| %alpine_player_theme% | Shows the player's selected theme. |
| %alpine_player_coins% | Displays the player's current coin balance. |
| %alpine_player_experience% | Represents the player's experience points. |
| %alpine_player_league% | Shows the player's current league name. |
| %alpine_player_league_color% | Provides the color code for the player's current league. |
| %alpine_player_league_bar% | Displays a visual representation of the player's league progress. |
| %alpine_top_<rank>_<kit>_elo% | Displays the ELO of a specific rank for a given kit. |
| %alpine_top_<rank>_<kit>_winstreak% | Shows the win streak of a specific rank for a given kit. |
| %alpine_top_<rank>_<kit>_win% | Displays the wins of a specific rank for a given kit. |
| %alpine_top_<rank>_<kit>_kill% | Shows the kills of a specific rank for a given kit. |
Permissions
Grant your players and staff specific access to features and administrative tools using these permissions.
| Permission Node | Description |
|---|---|
| practice.event.host.tntrun | Allows hosting TNT Run events. |
| practice.event.host.tnttag | Allows hosting TNT Tag events. |
| practice.event.host.lms | Allows hosting Last Man Standing events. |
| practice.event.host.spleef | Allows hosting Spleef events. |
| practice.event.host.stoplight | Allows hosting Stoplight events. |
| practice.event.host.parkour | Allows hosting Parkour events. |
| practice.event.host.gulag | Allows hosting Gulag events. |
| practice.event.host.knockout | Allows hosting Knockout events. |
| practice.event.host.sumo | Allows hosting Sumo events. |
| practice.event.host.brackets | Allows hosting Brackets events. |
| practice.arena.select | Grants access to the arena selection tool (wand). |
| practice.setting.join | Allows access to general join settings. |
| practice.setting.staff | Allows access to staff-specific settings. |
| practice.setting.sidebar | Allows customization of the player's sidebar. |
| practice.effect.flash | Grants access to flash effects. |
| practice.effect.body | Grants access to body effects. |
| practice.effect.drop | Grants access to drop effects. |
| practice.effect.slowmo | Grants access to slow-motion effects. |
Kits
Manage and configure combat kits for various game modes.
| Command | Permission | Description |
|---|---|---|
| /kit | practice.kit.admin | Displays kit help message. |
| /kit manage | practice.kit.admin | Opens the kit management menu. |
| /kit save | practice.kit.admin | Saves all configured kits. |
| /kit list | practice.kit.admin | Lists all available kits. |
| /kit cleardesc <kit> | practice.kit.admin | Clears a kit's description. |
| /kit create <kit> | practice.kit.admin | Creates a new kit. |
| /kit delete <kit> | practice.kit.admin | Deletes an existing kit. |
| /kit setdesc <kit> <description> | practice.kit.admin | Sets a kit's description. |
| /kit getloadout <kit> | practice.kit.admin | Gets a kit's loadout. |
| /kit setloadout <kit> | practice.kit.admin | Sets a kit's loadout from your inventory. |
| /kit goldenhead | practice.kit.admin | Gives you a golden head item. |
| /kit seticon <kit> | practice.kit.admin | Sets a kit's icon. |
| /kit setkb <kit> <knockback> | practice.kit.admin | Sets a kit's knockback value. |
Arenas
Manage and configure battle arenas for matches.
- Run the command /arena wand to get the arena selection tool. Use it to select two corners to define your arena boundaries.
- Execute /arena create <arena> <type>. Use "standalone" for kits allowing building (e.g., Bridge), and "shared" for non-building kits (e.g., NoDebuff).
- To associate kits with this arena, run /arena addkit <arena> <kit>.
- Finally, run /arena save to save all changes.
| Command | Permission | Description |
|---|---|---|
| /arena | practice.arena.admin | Displays arena help message. |
| /arena manage | practice.arena.admin | Opens the arena management menu. |
| /arena save | practice.arena.admin | Saves all current arenas. |
| /arena list | practice.arena.admin | Lists all available arenas. |
| /arena wand | practice.arena.admin | Gives the arena selection tool. |
| /arena status <arena> | practice.arena.admin | Shows the status of an arena. |
| /arena teleport <arena> | practice.arena.admin | Teleports you to an arena. |
| /arena addkit <arena> <kit> | practice.arena.admin | Adds a kit to an arena. |
| /arena create <arena> <type> | practice.arena.admin | Creates a new arena. |
| /arena delete <arena> | practice.arena.admin | Deletes an arena. |
| /arena removekit <arena> <kit> | practice.arena.admin | Removes a kit from an arena. |
| /arena setsafezone <arena> | practice.arena.admin | Sets the safezone for an FFA arena. |
| /arena setspawn <arena> <type> | practice.arena.admin | Sets a spawn point for an arena. |
Events
Control and manage various in-game events.
| Command | Permission | Description |
|---|---|---|
| /event | practice.event.admin | Displays event help message. |
| /event cancel | practice.event.admin | Cancels the active event. |
| /event cleardc | practice.event.admin | Clears the global event cooldown. |
| /event forcestart | practice.event.admin | Force starts the event. |
| /event host | Hosts an event (permission varies by event type). | |
| /event info | Displays information about the current event. | |
| /event join | Joins an active event. | |
| /event leave | Leaves the current event. | |
| /event status <event> | practice.event.admin | Gets the status of an event map. |
| /event setfinish <event> <type> | practice.event.admin | Sets the finish line for Stop Light events. |
| /event setlobby <event> | practice.event.admin | Sets the lobby location for an event. |
| /event setmainspawn <event> | practice.event.admin | Sets the main spawn for FFA events. |
| /event setspawn <event> <type> | practice.event.admin | Sets a spawn point for an event. |
| /event setstart <event> <type> | practice.event.admin | Sets the start line for Stop Light events. |
Tournaments
Organize and manage competitive tournaments.
| Command | Permission | Description |
|---|---|---|
| /tournament | Displays tournament help message. | |
| /tournament cancel | practice.tournament.admin | Cancels the active tournament. |
| /tournament forcestart | practice.tournament.admin | Force starts the tournament. |
| /tournament host <kit> <size> | practice.tournament.admin | Hosts a new tournament. |
| /tournament join | Joins an active tournament. | |
| /tournament leave | Leaves the current tournament. |
Clans
Manage player clans and their interactions.
| Command | Permission | Description |
|---|---|---|
| /clan | Displays clan help message. | |
| /clan list | Lists all active clans. | |
| /clan captain <player> | Promotes a member to captain. | |
| /clan create <clan> | Creates a new clan. | |
| /clan demote <player> | Demotes a clan member. | |
| /clan disband | Disbands your clan. | |
| /clan forcejoin <clan> | practice.clan.admin | Forcefully joins a player to a clan. |
| /clan forceleader <player> | practice.clan.admin | Forcefully sets a player as clan leader. |
| /clan info <clan> | Displays information about a clan. | |
| /clan invite <player> | Invites a player to your clan. | |
| /clan join <clan> | Joins an invited clan. | |
| /clan kick <player> | Kicks a member from your clan. | |
| /clan leave | Leaves your current clan. | |
| /clan rename <new_name> | Renames your clan. | |
| /clan reset | Deletes all clans (console only). |
FFA
Commands for managing Free-For-All zones.
- Run the command /arena wand to get the arena selection tool. Use it to select two corners to define your FFA area.
- Execute /arena create FFA shared. The name "FFA" is important for system recognition.
- (Optional) To define a safe zone within the FFA arena, use the /arena wand again to select two corners for the safe zone area.
- (Optional) Once the safe zone is selected, run /arena setsafezone FFA to apply it.
- Finally, run /arena save to save all changes.
| Command | Permission | Description |
|---|---|---|
| /ffa | Displays FFA help message. | |
| /ffa join | Joins the FFA zone. | |
| /ffa leave | Leaves the FFA zone. | |
| /ffa setkit <kit> | practice.ffa.admin | Sets the default kit for FFA. |
Texture Area
Instructions for configuring a dedicated area for texture pack rendering or display.
- Run the command /arena wand to get the arena selection tool. Use it to select two corners to define your texture pack display area.
- Execute /arena create TexturePack shared. The name "TexturePack" is important for system recognition.
- Finally, run /arena save to save all changes.
Tokens
Manage player tokens and their balances.
| Command | Permission | Description |
|---|---|---|
| /tokens | Checks your token balance and displays help. | |
| /tokens add <player> <token_amount> | practice.tokens.admin | Adds tokens to a player's balance. |
| /tokens remove <player> <token_amount> | practice.tokens.admin | Removes tokens from a player's balance. |
| /tokens set <player> <token_amount> | practice.tokens.admin | Sets a player's token balance. |
Coins
Manage player coins and access the coin shop.
| Command | Permission | Description |
|---|---|---|
| /coins | Checks your coin balance and displays help. | |
| /coins add <player> <coin_amount> | practice.coins.admin | Adds coins to a player's balance. |
| /coins remove <player> <coin_amount> | practice.coins.admin | Removes coins from a player's balance. |
| /coins set <player> <coin_amount> | practice.coins.admin | Sets a player's coin balance. |
| /coinshop | Opens the coin shop menu. |
Ranked
Administer ranked queues and player bans.
| Command | Permission | Description |
|---|---|---|
| /ranked ban <player> <reason> | practice.ranked.admin | Bans a player from ranked queues. |
| /ranked | practice.ranked.admin | Displays ranked help message. |
| /ranked idcheck <id> | practice.ranked.admin | Checks a player's ban status by ID. |
| /ranked playercheck <player> | practice.ranked.admin | Checks a player's ban status by name. |
| /ranked unban <player> | practice.ranked.admin | Unbans a player from ranked queues. |
Match
Commands related to duels, spectating, and match management.
| Command | Permission | Description |
|---|---|---|
| /duel <player> | Sends a duel request to a player. | |
| /duel accept <player> | Accepts a duel request. | |
| /leave | Instantly leaves the current match. | |
| /rematch | Requests a rematch with your last opponent. | |
| /follow <player> | practice.follow.admin | Follows a player and tracks their queues. |
| /matchhistory | Views your recent matches. | |
| /spectate <player> | Spectates another player's match. | |
| /stopspectating | Leaves spectator mode. | |
| /viewinv <id> | Views a match-end inventory by ID. |
Parties
Commands for managing player parties.
| Command | Permission | Description |
|---|---|---|
| /party | Displays party help message. | |
| /party create | Creates a new party. | |
| /party disband | Disbands your party. | |
| /party chat | Sends a message to your party. | |
| /party leave | Leaves your current party. | |
| /party kick <player> | Kicks a member from your party. | |
| /party join <player> | Joins an invited party. | |
| /party invite <player> | Invites a player to your party. | |
| /party info | Displays information about your party. |
Timer
Manage custom timers for various actions.
| Command | Permission | Description |
|---|---|---|
| /timer | practice.timers.admin | Displays timer help message. |
| /timer create <timer> <prefix> <duration> <command> | practice.timers.admin | Creates a new custom timer. |
| /timer delete <timer> | practice.timers.admin | Deletes an existing timer. |
| /timer list | practice.timers.admin | Lists all active timers. |
Admin
Administrative commands for server and player management.
| Command | Permission | Description |
|---|---|---|
| /practice | Displays plugin information. | |
| /practice reload | practice.admin | Reloads all plugin configurations. |
| /practice resetdata | practice.admin | Resets and deletes all player profiles. |
| /practice savedata | practice.admin | Saves all player profiles. |
| /practice forcequeue <player> <type> <kit> | practice.admin | Forcefully queues a player into a specified kit. |
| /practice setkb <type> <value> <amount> | practice.knockback.admin | Sets knockback values for specific types. |
| /practice setkb <type> <amount> | practice.knockback.admin | Sets knockback values for robots. |
| /elo set <player> <kit> <elo> | practice.stats.admin | Sets a player's ELO for a specific kit. |
| /exp set <player> <exp> | practice.stats.admin | Sets a player's experience points. |
| /kills set <player> <kit> <type> <kills> | practice.stats.admin | Sets a player's kills for a specific kit. |
| /wins set <player> <kit> <type> <wins> | practice.stats.admin | Sets a player's wins for a specific kit. |
| /winstreaks set <player> <kit> <type> <winstreaks> | practice.stats.admin | Sets a player's winstreak for a specific kit. |
Misc
Various utility and player commands.
| Command | Permission | Description |
|---|---|---|
| /fly | practice.fly | Toggles flight mode. |
| /spawn | Teleports you to the main spawn. | |
| /setspawn <type> | practice.spawn.admin | Sets the server spawn point. |
| /divisions | Opens the divisions menu. | |
| /leaderboards | Opens the leaderboards menu. | |
| /settings | Opens your personal settings menu. | |
| /quests | Opens the quests menu. | |
| /stats <player> | Opens a player's statistics menu. |