Commands and Permissions

Waarschuwing

These docs have not been fully updated to SpongeAPI 8 and may be out of date. If you feel like you can help update them, please submit a PR!

Commando’s zijn een manier waarop server operatoren hun server kunnen beheren en waarop spelers kunnen interageren met de server.

In Sponge, commands follow a system of Permissies. Permissions allow server operators to control who can access what commands. By default, all commands are granted to players with OP status. Players without operator status do not have access to administrative commands or commands that require an assigned permission node. A server operator can fine-tune who can access what commands by adding/negating permission nodes through a permissions plugin.

Notitie

Sponge is geen permissie-beheer plugin. Om permissies toe te voegen en te verwijderen voor individuele spelers of groepen moet je een permissie-beheer plugin zoeken.

Operator Commando’s

Deze commando’s, als toevoeging op de standaard spelercommando’s, zijn beschikbaar voor server operatoren.

Sponge

De volgende commando’s zijn beschikbaar voor spelers met de operator status (of de correcte permissie knoop) op servers gebruik makend van Sponge.

Commando

Omschrijving

Permissie

/sponge audit

Forces loading of unloaded classes to enable mixin debugging.

sponge.command.audit

/sponge blockinfo

Shows the type and some additional information about the block you are looking at.

sponge.command.blockinfo

/sponge chunks

Print de chunk gegevens voor een wereld, een dimensie of globaal.

sponge.command.chunks

/sponge config

Past de globale configuratie aan of de configuratie van een wereld of een dimensie.

sponge.command.config

/sponge entityinfo

Shows the type and some additional information about the entity you are looking at.

sponge.command.entityinfo

/sponge heap

Dumpt de JVM heap.

sponge.command.heap

/sponge metrics

Gets or sets whether metric (also known as server stats) collection is enabled for a given plugin.

sponge.command.metrics

/sponge mods

Lists currently installed forge mods. (SpongeForge only)

sponge.command.mods

/sponge plugins list

Lists currently installed Sponge plugins.

sponge.command.plugins

/sponge plugins refresh

Vraagt plugins om hun eigen herlaadprocedures uit te voeren.

sponge.command.plugins.refresh

/sponge reload

Herlaadt de globale, wereld of dimensie configuratie.

sponge.command.reload

/sponge save

Slaagt de globale, wereld of dimensie configuratie op.

sponge.command.save

/sponge tps

Geef ticks per seconde voor elke wereld weer.

sponge.command.tps

/sponge version

Print de Sponge/SpongeAPI versies naar de console.

sponge.command.version

/sponge which

Prints which plugin provided the command, it’s aliases and alternatives.

sponge.command.which

/sponge:callback

Internally used for callback actions on Components (such as pagination). Not intended to be invoked by hand.

/sponge:help

View information on commands used on the server.

sponge.command.help


Sponge commando parameters

  • /sponge chunks [-g] [-d dim] [-w world]

  • /sponge config [-g] [-d dim] [-w world] key value

  • /sponge save [-g] [-d dim|*] [-w world|*]

  • /sponge reload [-g] [-d dim|*] [-w world|*]

Command Conflicts

In cases of command conflict, Sponge provides a primary alias mechanism to specify which command is to be used. For example, Minecraft provides the reload command and Sponge provides the reload command. To specify which command to use, prefix it with minecraft or sponge and a :. So, to use Sponge’s reload command above, type in /sponge:reload. This approach can also be used to handle conflicts between mods and/or plugins. Do the same thing, just use the mod-id or the plugin-id and a :. An example is /examplemodid:tp.

Furthermore, the primary alias mechanism can be used to overcome incompatibilities. Let’s say a plugin registers a command, but the command is incompatible with your mod. If you can configure your mod to use a Minecraft native command or another plugin’s command, you can restore the expected behavior or prevent unexpected behaviors.

Notitie

The /sponge audit command forces loading of any classes which have not yet been loaded, allowing the full output from all mixin debugging environment variables to be captured. This also requires the mixins.checks variable, see the Mixin wiki for more information.

Tip

Here are a few simple examples of the sponge config command in action. Note that at least one target flag must be specified. Please see Sponge configureren for a more detailed explanation.

  1. /sponge config -d minecraft:nether logging.chunk-load true

Since a dimension type was specified, this would alter the nether dimension config (and hence all nether worlds).

  1. /sponge config -w DIM1 logging.chunk-load true

Dit zou de configuratie van de wereld met de naam DIM1 veranderen.

Sponge provides two permissions for debugging purposes:

  • Allow using Sponge’s block and entity tracking message channel: sponge.debug.block-tracking This message channel is used by the client (if the SpongeForge mod is installed) to display the block and entity owner and notifier in the debug view.

  • Allow hovering of command execution errors to get the stacktrace: sponge.debug.hover-stacktrace

Forge

The following commands are available only when using the SpongeForge coremod on Forge. Other implementations of the SpongeAPI, such as SpongeVanilla, do not include these commands.

Commando

Omschrijving

Permissie

/forge tps

Geef ticks per seconde voor elke wereld weer.

forge.command.forge

/forge track

Schakel tegel entiteit volgen in.

forge.command.forge


For any Forge mods that use the vanilla command API, command permissions are provided in the form <modid>.command.<commandname>.

Vanilla

There are several commands built-in to vanilla Minecraft that are also available on servers powered by Sponge. The list below is not comprehensive, but it includes the most commonly used commands. These commands are available to players with operator status (or the correct permission node). In general, permissions for vanilla Minecraft commands on a Sponge server are of the structure minecraft.command.<command>, as shown below.

Commando

Omschrijving

Permissie

/ban

Verban een speler.

minecraft.command.ban

/ban-ip

Verban een IP adres.

minecraft.command.ban-ip

/banlist

Bekijk alle verbande spelers.

minecraft.command.banlist

/clear

Maak een inventaris leeg.

minecraft.command.clear

/deop

Verwijder OP van een speler.

minecraft.command.deop

/difficulty

Stel de moeilijkheidsgraad in.

minecraft.command.difficulty

/gamemode

Stel de spelmodus van een speler in.

minecraft.command.gamemode

/gamerule

Zet een spelregel.

minecraft.command.gamerule

/give

Geef een voorwerp aan een speler.

minecraft.command.give

/kill

Vermoord een speler of entiteit.

minecraft.command.kill

/op

Geef operator status aan een speler.

minecraft.command.op

/pardon

Verwijder een speler van de verbanningslijst.

minecraft.command.pardon

/save-all

Sla de server op.

minecraft.command.save-all

/save-of

Schakel automatische server opslag uit.

minecraft.command.save-off

/save-on

Schakel automatische server opslag in.

minecraft.command.save-on

/setidletimeout

Definieer hoe lang spelers mogen niets doen voordat ze uit het spel worden gezet.

minecraft.command.setidletimeout

/setworldspawn

Zet het spawnpunt van de wereld.

minecraft.command.setworldspawn

/stop

Stop de server.

minecraft.command.stop

/toggledownfall

Wissel tussen zonnig en regenachtig weer.

minecraft.command.toggledownfall

/tp

Teleporteer spelers en entiteiten.

minecraft.command.tp

/weather

Zet het weer naar de gedefinieerde conditie.

minecraft.command.weather

/whitelist

Beheer de server whitelist.

minecraft.command.whitelist

/worldborder

Beheer de wereldgrens.

minecraft.command.worldborder


Sponge also creates permissions for these Minecraft features:

  • Allow player to use the entity-selector in commands: minecraft.selector

  • Allow player to bypass spawn-protection in all worlds: minecraft.spawn-protection.override

  • Allow player to bypass force-gamemode in all worlds: minecraft.force-gamemode.override

  • Allow editing an ordinary commandblock of the given name: minecraft.commandblock.edit.block.<name>

  • Allow editing a minecart commandblock of the given name: minecraft.commandblock.edit.minecart.<name>

Notitie

These permissions use the actual name of the commandblock, which is normally @ by default.

There are also extra permissions managing the access to the server:

  • Treat the user as whitelisted: minecraft.login.bypass-whitelist

  • Allow this user to bypass the server’s player limit: minecraft.login.bypass-player-limit

Notitie

Sponge offers improved multi-world support, such as per-world world borders. By default, Sponge only changes the world border (or other world options) of the world the player is currently in. The vanilla behavior of setting it for all worlds can be restored using the global configuration and setting sponge.commands.multi-world-patches.worldborder (or the corresponding entry) to false. See global.conf for details. Sponge assumes that multi-world plugins also provide optimized configuration commands for those options and thus does not provide its own variants.

Speler Commando’s

De volgende commando’s zijn beschikbaar als een deel van vanilla Minecraft voor spelers zonder operator status.

Commando

Omschrijving

Permissie

/help

View information on commands used on the server, by default the Sponge command will be used instead!

minecraft.command.help

/me

Vertel iedereen wat je aan het doen bent.

minecraft.command.me

/say

Geef een bericht weer aan iedereen (of met behulp van selecteerders aan specifieke spelers).

minecraft.command.say

/tell

Stuur een privé bericht naar een andere speler.

minecraft.command.tell


A full list of vanilla commands can be found at: https://minecraft.wiki/w/Commands#List_and_summary_of_commands. Permissions for vanilla Minecraft commands on a Sponge server are of the structure minecraft.command.<command>.

Command Features

Sponge and most Sponge plugins support additional command features such as auto completion and hoverable text. The image below shows the output using the /sponge plugins command (yellow box). The elements in that list can be hovered over to get addition information such as the current version number (red box). Some elements in the example below also have additional actions bound to them. For example, the plugin entries in that list can be clicked to show more detailed information (purple box) about that plugin. This is equivalent to sending the /sponge plugins <pluginId> command. The auto completion can be triggered by pressing tab. Entering /sponge plugins  (with a trailing space) and then pressing tab will show a list of possible values (turquoise box) that can be used in that context. Pressing tab again will iterate the possibilities, if any. Theoretically it is possible to write most commands by pressing only tab and space (and maybe the first letter of each segment).

command features

Tip

If you are a plugin author and you want to use hoverable text and text actions in your plugin, then head over to our Text documentation.