Skip to content

Latest commit

 

History

History
95 lines (72 loc) · 4.09 KB

commands-and-permissions.md

File metadata and controls

95 lines (72 loc) · 4.09 KB

This pages contains all the commands inside SWM, alongside their respective permissions and usages. Arguments within angle brackets are required, and the ones within square brackets are optional.

The swm.* permission will grant access to all commands.

General commands

/swm help

Permission required: none.
Usage: /swm help
Description: shows the plugin's help page, containing only the commands you have access to.

/swm version

Permission required: none.
Usage: /swm version
Description: shows the plugin version.

/swm reload

Permission required: swm.reload Usage: /swm reload
Since version: 1.1.0.
Description: reloads the config files.

/swm goto

Permission required: swm.goto
Usage: /swm goto <world> [player]
Description: teleports yourself to a world. If you want to teleport someone else, you can specify it by using the player argument.

This command also works for traditional worlds, not just SRF worlds.

World Listing commands

/swm list

Permission required: swm.worldlist
Usage: /swm list [slime] [page]
Description: lists all worlds, including loaded non-SRF worlds. If you use the slime argument, only SRF worlds will be shown.

/swm dslist

Permission required: swm.dslist
Usage: /swm list <data-source> [page]
Since version: 2.0.0.
Description: lists all worlds contained inside a specified data source. Note that this command doesn't just list the worlds that are inside the config file, but every world inside the data source.

World Creation and Loading commands

/swm import

Permission required: swm.importworld
Usage: /swm import <path-to-world> <data-source> [new-world-name]
Since version: 1.1.0.
Description: converts a world into the SRF and stores it inside the provided data source. You can check out this page for more information on how to use this command.

/swm load

Permission required: swm.loadworld
Usage: /swm load <world>
Description: Loads a world from the config file. Remember to configure the world after converting it to the SRF. More on that here.

/swm load-template

Permission required: swm.loadworld.template
Usage: /swm load-template <template-world> <world>
Since version: 2.0.0.
Description: Creates a clone of the provided template world. This can be used to create many copies of the same world.

/swm clone

Permission required: swm.cloneworld
Usage: /swm clone <template-world> <world> [new-data-source]
Since version: 2.2.0.
Description: Creates a clone of the provided template world. If not provided, SWM will use the data source of the template world to save the clone.

Cloned worlds are temporary, and they will never be actually stored anywhere, so any changes to them will be lost once the server is shut down.

/swm create

Permission required: swm.createworld
Usage: /swm create <world> <data-source>
Since version: 1.1.0.
Description: Creates an empty world and stores it in the provided data source. This command will also automatically save the world in the config file.

/swm unload

Permission required: swm.unloadworld
Usage: /swm unload <world>
Description: Unloads a world from the server.

This command also works for traditional worlds, not just SRF worlds.

World Management commands

/swm migrate

Permission required: swm.migrate
Usage: /swm migrate <world> <new-data-source>
Description: Transfers a world from the current data source it's stored in to the specified.

/swm delete

Permission required: swm.deleteworld
Usage: /swm delete <world> [data-source]
Description: Completely deletes a world. If a data source is not provided, the one specified in the config file will be used.

This action is permanent, and there's no way to go back once the world is deleted. To make sure you are not doing this by mistake, you'll have to type the command twice.