diff --git a/docs/BentoBox/Commands.md b/docs/BentoBox/Commands.md index f3498373..51b3fb87 100644 --- a/docs/BentoBox/Commands.md +++ b/docs/BentoBox/Commands.md @@ -1,20 +1,153 @@ -BentoBox implements a few commands to help you manage your whole BentoBox installation. - -**Available commands (as of 2.2.0)** - -| Command | Permission | Description | -|-----------------------------------------|------------------------------|-------------------------------------------------------------| -| /bentobox [help/h] | bentobox.admin | Displays all available BentoBox commands | -| /bentobox about | bentobox.about | Displays copyright and license information | -| /bentobox catalog | bentobox.admin.catalog | Displays the Catalog | -| /bentobox locale | bentobox.admin.locale | Performs localization files analysis | -| /bentobox manage/overview | bentobox.admin.manage | Displays the Management Panel | -| /bentobox migrate | bentobox.admin.migrate | Migrates data from one database to another | -| /bentobox perms | bentobox.admin.perms | Displays the effective perms for BentoBox and Addons in a YAML format | -| /bentobox rank [list \| add \| remove] [rank reference] [rank value] | bentobox.admin.rank | list, add, or remove ranks | -| /bentobox reload/rl | bentobox.admin.reload | Reloads BentoBox and all addons, settings and locales | -| /bentobox version/v/versions/addons | bentobox.version | Displays BentoBox and addons versions | - -An alias for `/bentobox` is `/bbox`. - -When filing bug reports or asking for support, you **must** provide the output of the `/bentobox version` command so that we know what version of the software, database and addons you are using. \ No newline at end of file +# Commands + +Every command in BentoBox and its game modes, generated from the BentoBox source. For how to use them, see the [Admin Guides](About/Teams.md) and the [Player Guide](Player-Guide.md). + +## How game mode commands are named + +Each game mode has its own player and admin command. The tables below write them as `/[player_command]` and `/[admin_command]`. Permissions start with the game mode's prefix, written `[gamemode].`: + +| Game mode | `[player_command]` | `[admin_command]` | `[gamemode]` | +|---|---|---|---| +| BSkyBlock | `/island`, `/is` | `/bsbadmin`, `/bsb` | `bskyblock` | +| AOneBlock | `/ob`, `/oneblock` | `/oba`, `/obadmin` | `aoneblock` | +| AcidIsland | `/ai` | `/acid` | `acidisland` | +| CaveBlock | `/cave`, `/cb` | `/cbadmin`, `/cba` | `caveblock` | + +Other game modes list theirs on their own page. All labels can be changed in the game mode's `config.yml`. + +Typing a command with no subcommand runs a default: for players, `/[player_command]` creates an island or teleports home (see [Islands](About/IslandManagement.md#creating-islands)); `/[admin_command]` and `help` list the commands the player can use. + +Addons add their own subcommands to these, for example `/island level` or `/island challenges`. See each [addon's page](../addons/Bank/index.md). + +## BentoBox commands + +The `/bentobox` command (alias `/bbox`) manages BentoBox itself. + +| Command | Description | Permission | +|---|---|---| +| `/bentobox about` | Copyright and license information | `bentobox.about` | +| `/bentobox version` | BentoBox, addon and server versions. Include this when you ask for help | `bentobox.version` | +| `/bentobox reload` | Reload BentoBox and all addons, settings, locales and menu templates | `bentobox.admin.reload` | +| `/bentobox reload locales` | Reload only the locale files | `bentobox.admin.reload` | +| `/bentobox manage` | Open the Management Panel | `bentobox.admin.manage` | +| `/bentobox catalog` | Open the catalog of game modes and addons | `bentobox.admin.catalog` | +| `/bentobox locale` | Check the locale files for missing translations | `bentobox.admin.locale` | +| `/bentobox migrate` | Move data from one database type to another. See [Changing Database](Database-transition.md) | `bentobox.admin.migrate` | +| `/bentobox perms` | Print every command permission and its default (console only) | `bentobox.admin.perms` | +| `/bentobox rank [list \| add \| remove] [rank reference] [rank value]` | List, add or remove island ranks. See [Teams & Ranks](About/Teams.md#custom-ranks) | `bentobox.admin.rank` | +| `/bentobox placeholders` | Open the placeholder browser | `bentobox.admin.placeholders` | +| `/bentobox dump-placeholders` | Write every registered placeholder to a markdown file | `bentobox.admin.dump-placeholders` | + +## Player commands + +| Command | Description | Permission | +|---|---|---| +| `/[player_command] ban ` | Ban a player from your island | `[gamemode].island.ban` | +| `/[player_command] banlist` | List banned players | `[gamemode].island.ban` | +| `/[player_command] create ` | Create an island, using optional blueprint (requires permission) | `[gamemode].island.create` | +| `/[player_command] deletehome [home name]` | Delete a home location | `[gamemode].island.deletehome` | +| `/[player_command] expel ` | Expel a player from your island | `[gamemode].island.expel` | +| `/[player_command] go [home name]` | Teleport you to your island | `[gamemode].island.home` | +| `/[player_command] homes` | List your homes | `[gamemode].island.homes` | +| `/[player_command] info ` | Display info about your island or the player's island | `[gamemode].island.info` | +| `/[player_command] language [language]` | Select language | `[gamemode].island.language` | +| `/[player_command] lock` | Lock or unlock your island | `[gamemode].island.lock` | +| `/[player_command] near` | Show the name of neighboring islands around you | `[gamemode].island.near` | +| `/[player_command] renamehome [home name]` | Rename a home location | `[gamemode].island.renamehome` | +| `/[player_command] reset ` | Restart your island and remove the old one | `[gamemode].island.reset` | +| `/[player_command] resetname` | Reset your island name | `[gamemode].island.name` | +| `/[player_command] sethome` | Set your home teleport point | `[gamemode].island.sethome` | +| `/[player_command] setname ` | Set a name for your island | `[gamemode].island.name` | +| `/[player_command] settings` | Display island settings | `[gamemode].island.settings` | +| `/[player_command] spawn` | Teleport you to the spawn | `[gamemode].island.spawn` | +| `/[player_command] team` | Manage your team | `[gamemode].island.team` | +| `/[player_command] team accept` | Accept an invitation | `[gamemode].island.team.accept` | +| `/[player_command] team coop ` | Make a player coop rank on your island | `[gamemode].island.team.coop` | +| `/[player_command] team demote ` | Move a player down one rank (never below Member) | `[gamemode].island.team.promote` | +| `/[player_command] team invite ` | Invite a player to join your island | `[gamemode].island.team.invite` | +| `/[player_command] team kick ` | Remove a member from your island | `[gamemode].island.team.kick` | +| `/[player_command] team leave` | Leave your island | `[gamemode].island.team.leave` | +| `/[player_command] team promote ` | Promote a player on your island up a rank | `[gamemode].island.team.promote` | +| `/[player_command] team reject` | Reject an invitation | `[gamemode].island.team.reject` | +| `/[player_command] team setowner ` | Transfer your island ownership to a member | `[gamemode].island.team.setowner` | +| `/[player_command] team trust ` | Give a player trusted rank on your island | `[gamemode].island.team.trust` | +| `/[player_command] team uncoop ` | Remove a coop rank from player | `[gamemode].island.team.coop` | +| `/[player_command] team untrust ` | Remove trusted player rank from player | `[gamemode].island.team.trust` | +| `/[player_command] unban ` | Unban a player from your island | `[gamemode].island.ban` | + +## Admin commands + +Admin commands are for operators by default. Commands with a `mod.` permission are meant for moderators who aren't full admins; see [Permissions & VIP Perks](Permissions-Guide.md#staff-permissions). + +| Command | Description | Permission | +|---|---|---| +| `/[admin_command] blueprint ` | Manipulate blueprints | `[gamemode].admin.blueprint` | +| `/[admin_command] blueprint copy [air] [biome] [nowater]` | Copy the clipboard set by pos1 and pos2 and optionally the air, biome, and water blocks | `[gamemode].admin.blueprint.copy` | +| `/[admin_command] blueprint delete ` | Delete the blueprint | `[gamemode].admin.blueprint.delete` | +| `/[admin_command] blueprint list` | List available blueprints | `[gamemode].admin.blueprint.list` | +| `/[admin_command] blueprint load ` | Load blueprint into the clipboard | `[gamemode].admin.blueprint.load` | +| `/[admin_command] blueprint origin` | Set the blueprint's origin to your position | `[gamemode].admin.blueprint.origin` | +| `/[admin_command] blueprint paste` | Paste the clipboard to your location | `[gamemode].admin.blueprint.paste` | +| `/[admin_command] blueprint pos1` | Set 1st corner of cuboid clipboard | `[gamemode].admin.blueprint.pos1` | +| `/[admin_command] blueprint pos2` | Set 2nd corner of cuboid clipboard | `[gamemode].admin.blueprint.pos2` | +| `/[admin_command] blueprint rename ` | Rename a blueprint | `[gamemode].admin.blueprint.rename` | +| `/[admin_command] blueprint save ` | Save the copied clipboard | `[gamemode].admin.blueprint.save` | +| `/[admin_command] blueprint sink` | Set this blueprint to sink to the ocean floor when pasted | `[gamemode].admin.blueprint.sink` | +| `/[admin_command] deaths` | Edit deaths of players | `[gamemode].admin.deaths` | +| `/[admin_command] deaths add ` | Adds deaths to the player | `[gamemode].admin.deaths.add` | +| `/[admin_command] deaths remove ` | Removes deaths to the player | `[gamemode].admin.deaths.remove` | +| `/[admin_command] deaths reset ` | Resets deaths of the player | `[gamemode].admin.deaths.reset` | +| `/[admin_command] deaths set ` | Sets deaths of the player | `[gamemode].admin.deaths.set` | +| `/[admin_command] delete [player]` | Deletes a player's island, or the island you are standing on if no player is given | `[gamemode].admin.delete` | +| `/[admin_command] deletehomes ` | Deletes all named homes from an island | `[gamemode].mod.deletehomes` | +| `/[admin_command] getrank [island owner]` | Get a player's rank on their island or the island of the owner | `[gamemode].admin.getrank` | +| `/[admin_command] info [island name]` | Get info on where you are or player's island | `[gamemode].mod.info` | +| `/[admin_command] maxhomes [island name]` | Change the number of homes allowed on this island or player's island | `[gamemode].mod.maxhomes` | +| `/[admin_command] purge [days]` | Delete region files for islands untouched for more than [days] days (frees disk) | `[gamemode].admin.purge` | +| `/[admin_command] purge age-regions [days]` | Debug/test: rewrite region file timestamps so they become purgable | `[gamemode].admin.purge.age-regions` | +| `/[admin_command] purge deleted` | Purge region files for any island already flagged as deleted | `[gamemode].admin.purge.deleted` | +| `/[admin_command] purge protect` | Toggle island purge protection | `[gamemode].admin.purge.protect` | +| `/[admin_command] purge unowned` | Flag unowned islands as deletable so they can be reaped | `[gamemode].admin.purge.unowned` | +| `/[admin_command] range` | Admin island range command | `[gamemode].admin.range` | +| `/[admin_command] range add [island location]` | Increases the island protected range | `[gamemode].admin.range.add` | +| `/[admin_command] range display` | Show/hide island range indicators | `[gamemode].admin.range.display` | +| `/[admin_command] range purgebonus ` | Removes a bonus range id from every island (e.g. after removing the addon that added it) | `[gamemode].admin.range.purgebonus` | +| `/[admin_command] range remove [island location]` | Decreases the island protected range | `[gamemode].admin.range.remove` | +| `/[admin_command] range removebonus [id]` | Removes bonus ranges from the island (all, or one by id) | `[gamemode].admin.range.removebonus` | +| `/[admin_command] range reset ` | Resets the island protected range to the world default | `[gamemode].admin.range.reset` | +| `/[admin_command] range set [island location]` | Sets the island protected range | `[gamemode].admin.range.set` | +| `/[admin_command] register ` | Register player to unowned island you are on | `[gamemode].admin.register` | +| `/[admin_command] reload` | Reload | `[gamemode].admin.reload` | +| `/[admin_command] resetflags [flag]` | Reset all islands to default flag settings in config.yml | `[gamemode].admin.resetflags` | +| `/[admin_command] resethome [island name]` | Reset the player's home to default | `[gamemode].mod.resethome` | +| `/[admin_command] resetname` | Reset player island name | `[gamemode].mod.resetname` | +| `/[admin_command] resets` | Edit player reset values | `[gamemode].admin.resets` | +| `/[admin_command] resets add ` | Adds this player's island reset count | `[gamemode].admin.resets.add` | +| `/[admin_command] resets remove ` | Reduces the player's island reset count | `[gamemode].admin.resets.remove` | +| `/[admin_command] resets reset ` | Sets the player's island reset count to 0 | `[gamemode].admin.resets.remove` | +| `/[admin_command] resets set ` | Sets how many times this player has reset his island | `[gamemode].admin.resets.set` | +| `/[admin_command] setprotectionlocation [x y z coords]` | Set current location or [x y z] as center of island's protection area | `[gamemode].admin.setprotectionlocation` | +| `/[admin_command] setrank [island owner \| x,y,z]` | Promote or demote a player to a rank on their team island, or on the island named by its owner or x,y,z centre | `[gamemode].admin.setrank` | +| `/[admin_command] setspawn` | Set an island as spawn for this gamemode | `[gamemode].admin.setspawn` | +| `/[admin_command] setspawnpoint` | Set current location as spawn point for this island | `[gamemode].admin.setspawnpoint` | +| `/[admin_command] settings [player]/[world flag]/spawn-island [flag/active/disable] [rank/active/disable]` | Open settings GUI or set settings | `[gamemode].admin.settings` | +| `/[admin_command] switch` | Switch on/off protection bypass | `[gamemode].mod.switch` | +| `/[admin_command] team` | Manage teams | `[gamemode].mod.team` | +| `/[admin_command] team add ` | Add player to owner's team | `[gamemode].mod.team.add` | +| `/[admin_command] team disband ` | Disband owner's team | `[gamemode].mod.team.disband` | +| `/[admin_command] team disbandall` | Strip every member and sub-owner from every island in this world | `[gamemode].mod.team.disbandall` | +| `/[admin_command] team kick [x,y,z]` | Kick a player from a team | `[gamemode].mod.team.kick` | +| `/[admin_command] team maxsize ` | Set the max team size for a player's island (use 0 to reset to world default) | `[gamemode].mod.team.maxsize` | +| `/[admin_command] team setowner [island owner]` | Transfers island ownership to the player. Name the current island owner to run it from the console | `[gamemode].mod.team.setowner` | +| `/[admin_command] tp [player's island]` | Teleport to a player's island | `[gamemode].admin.tp` | +| `/[admin_command] tpend [player's island]` | Teleport to a player's island in the End | `[gamemode].admin.tp` | +| `/[admin_command] tpnether [player's island]` | Teleport to a player's island in the Nether | `[gamemode].admin.tp` | +| `/[admin_command] tpuser [player's island]` | Teleport a player to another player's island | `[gamemode].admin.tpuser` | +| `/[admin_command] tpuserend [player's island]` | Teleport a player to another player's island in the End | `[gamemode].admin.tpuser` | +| `/[admin_command] tpusernether [player's island]` | Teleport a player to another player's island in the Nether | `[gamemode].admin.tpuser` | +| `/[admin_command] undelete` | Remove the pending deletion status from the unowned island you are on | `[gamemode].admin.undelete` | +| `/[admin_command] unregister [x,y,z]` | Unregister owner from island, but keep island blocks | `[gamemode].admin.unregister` | +| `/[admin_command] version` | Display BentoBox and addons versions | `[gamemode].admin.version` | +| `/[admin_command] why ` | Toggle console protection debug reporting | `[gamemode].admin.why` | + +`/[admin_command] add`, `disband`, `kick` and `setowner` also work without `team` (for example `/bsbadmin kick `), for compatibility with older versions. diff --git a/docs/BentoBox/Permissions-Guide.md b/docs/BentoBox/Permissions-Guide.md new file mode 100644 index 00000000..45224929 --- /dev/null +++ b/docs/BentoBox/Permissions-Guide.md @@ -0,0 +1,118 @@ +# Permissions & VIP Perks + +BentoBox works with any permissions plugin (LuckPerms is the most common). This page explains how BentoBox's permissions are named, which ones players already have, and how to give ranks or VIPs bigger teams, bigger islands, more homes and other perks. + +!!! info "Examples on this page" + Examples use BSkyBlock, whose permissions start with `bskyblock.`, and LuckPerms commands. Each game mode has its own prefix, for example `aoneblock.`, `acidisland.` or `caveblock.`, so a perk must be given once for each game mode. + +## How the permissions are named + +| Permission starts with | Used for | Who has it by default | +|---|---|---| +| `bentobox.` | The `/bentobox` command | Operators (`bentobox.about` is for everyone) | +| `.island.` | Player commands, such as `bskyblock.island.team.invite` | Players, mostly. See [below](#check-what-players-have-by-default) | +| `.admin.` | Admin commands, such as `bskyblock.admin.delete` | Operators | +| `.mod.` | Moderator commands and protection bypasses, such as `bskyblock.mod.info` | Operators | +| `.settings.` | Changing island settings in `/island settings` | Players | +| `..` | Limits, such as `bskyblock.team.maxsize.8` | Nobody: the config value is used | + +Addons add their own permissions. They're listed on each [addon's page](../addons/Bank/index.md). + +### Check what players have by default + +Run **`/bentobox perms`** in the console. It prints every BentoBox and game mode command permission with its default (`TRUE` for everyone, `OP` for operators, `FALSE` for nobody), in a format you can paste into a permissions plugin. + +!!! warning "Some player commands are operator-only by default" + In BSkyBlock, AOneBlock and AcidIsland, `island.deletehome` and `island.renamehome` default to operators only. In AOneBlock and AcidIsland, so does `island.homes`. If you give players more than one home, give these to them as well: + + ``` + /lp group default permission set bskyblock.island.homes true + /lp group default permission set bskyblock.island.deletehome true + /lp group default permission set bskyblock.island.renamehome true + ``` + +## Perks with a number + +These permissions end with a number. The number replaces the value in the game mode's `config.yml` for that player. + +| Perk | Permission | Config default | Checked for | +|---|---|---|---| +| Team size (including the owner) | `bskyblock.team.maxsize.` | `island.max-team-size` | Island owner | +| Coop players | `bskyblock.coop.maxsize.` | `island.max-coop-size` | Island owner | +| Trusted players | `bskyblock.trust.maxsize.` | `island.max-trusted-size` | Island owner | +| Island size (protection range) | `bskyblock.island.range.` | `world.protection-range` | Island owner | +| Number of homes | `bskyblock.island.maxhomes.` | `island.max-homes` | Island owner | +| Number of islands | `bskyblock.island.number.` | `world.concurrent-islands` | The player | +| Players they can ban | `bskyblock.ban.maxlimit.` | `world.ban-limit` (`-1` = no limit) | The player | + +How the number is worked out: + +- **The highest number wins.** A player with both `team.maxsize.6` and `team.maxsize.10` gets 10. Ranks can stack without conflicting. +- **The number replaces the config value, even if it's lower.** `team.maxsize.2` gives a team of 2 even if the config says 4. Only give these permissions to raise limits. +- **`.*` is ignored.** A player with `bskyblock.team.maxsize.*` (for example through a wildcard or operator plugin) gets the config value, not unlimited. Use a large number instead. +- **Island perks follow the owner.** Team size, range and homes come from the island **owner's** permissions, not each member's. They're updated when the owner logs in, and range is also set when the island is created. +- **Island size is capped** at `distance-between-islands`; asking for more has no effect. See [Islands](About/IslandManagement.md#island-size-protection-range). + +## Other perks + +| Perk | Permission | +|---|---| +| A VIP starter island in the Create Island menu | `bskyblock.island.create.`, after setting that bundle to require a permission in `/bsbadmin blueprint`. See [Islands](About/IslandManagement.md#creating-islands) | +| Colour codes in island names | `bskyblock.island.name.format` | +| Skip command cooldowns (resets, invites) | `bskyblock.mod.bypasscooldowns` | +| Skip the teleport delay | `bskyblock.mod.bypassdelays` | +| Can't be banned or expelled from islands | `bskyblock.admin.noban`, `bskyblock.admin.noexpel` | +| Can't change a particular island setting | Remove `bskyblock.settings.`. See [Protection, Flags & Ranks](Island-Protection,-Flags-&-Ranks.md#settings-tab) | + +Things that are **not** permissions: extra island resets (use `/bsbadmin resets`, see [Islands](About/IslandManagement.md#resetting-islands)), and the right to invite, kick or ban on someone else's island (island owners control that with ranks, see [Teams & Ranks](About/Teams.md#letting-members-manage-the-team)). + +## Example: a VIP rank + +A VIP group in BSkyBlock with a team of 8, a bigger island, three homes and a VIP starter island: + +``` +/lp creategroup vip +/lp group vip permission set bskyblock.team.maxsize.8 true +/lp group vip permission set bskyblock.island.range.100 true +/lp group vip permission set bskyblock.island.maxhomes.3 true +/lp group vip permission set bskyblock.island.homes true +/lp group vip permission set bskyblock.island.deletehome true +/lp group vip permission set bskyblock.island.renamehome true +/lp group vip permission set bskyblock.island.create.vip true +/lp user parent add vip +``` + +The player must **log out and back in** for the team size, range and homes to apply to an island they already own. + +To sell upgrades step by step (bigger islands, more team slots, more homes) with in-game money, see the [Upgrades](../addons/Upgrades/index.md) addon. + +## Staff permissions + +| Role | Give | +|---|---| +| Full admin for one game mode | `bskyblock.admin.*` and `bskyblock.mod.*` | +| Moderator who can look but not change islands | `bskyblock.mod.info`, `bskyblock.admin.tp`, `bskyblock.mod.bypasslock`, `bskyblock.mod.bypassban` | +| Moderator who can build anywhere | add `bskyblock.mod.bypassprotect` and `bskyblock.mod.switch` (lets them turn the bypass off with `/bsbadmin switch`) | +| BentoBox admin (reload, manage, migrate) | `bentobox.admin` and its sub-permissions | + +All the protection bypass permissions are explained in [Protection, Flags & Ranks](Island-Protection,-Flags-&-Ranks.md#bypass-the-protection). + +## Troubleshooting + +**A perk doesn't apply.** +Island perks come from the island owner and are updated when they log in. Have the owner log out and in. For range, check `distance-between-islands` isn't lower than the number. + +**A VIP got a smaller team than normal players.** +A lower number in another group replaced the config value. Remove it; the highest number a player has is used. + +**Players can't use a command.** +Run `/bentobox perms` and check the default for that command. Give the permission to your default group if it's `OP` or `FALSE`. + +**The perk works in one game mode but not another.** +Each game mode has its own prefix. Give the permission again for `aoneblock.`, `acidisland.` and so on. + +## See also + +- [Permissions reference](Permissions.md): every BentoBox and game mode permission +- [Commands reference](Commands.md) +- [Teams & Ranks](About/Teams.md), [Islands](About/IslandManagement.md), [Protection, Flags & Ranks](Island-Protection,-Flags-&-Ranks.md) diff --git a/docs/BentoBox/Permissions.md b/docs/BentoBox/Permissions.md index 679be6b6..98ebcced 100644 --- a/docs/BentoBox/Permissions.md +++ b/docs/BentoBox/Permissions.md @@ -1,16 +1,178 @@ -# BentoBox Permissions - -Permissions listed here are for BentoBox. Addons register their own permissions. - -**BentoBox permissions (as of 1.6.0)** - -| Permission | Parent permission | Default value | Description | -|------------------------|-------------------|---------------|----------------------------------------| -| bentobox.admin | | op | Allows most of BentoBox commands usage | -| bentobox.admin.catalog | bentobox.admin | op | Allows to use /bentobox catalog | -| bentobox.admin.locale | bentobox.admin | op | Allows to use /bentobox locale | -| bentobox.admin.manage | bentobox.admin | op | Allows to use /bentobox manage | -| bentobox.admin.migrate | bentobox.admin | op | Allows to use /bentobox migrate | -| bentobox.admin.reload | bentobox.admin | op | Allows to use /bentobox reload | -| bentobox.about | | true | Allows to use /bentobox about | -| bentobox.version | | true | Allows to use /bentobox version | \ No newline at end of file +# Permissions + +Every BentoBox permission, generated from the BentoBox source. For how to use them (VIP ranks, staff roles, common mistakes), see [Permissions & VIP Perks](Permissions-Guide.md). + +Game mode permissions start with the game mode's prefix, written `[gamemode].` here: `bskyblock.`, `aoneblock.`, `acidisland.`, `caveblock.` and so on. Addon permissions are listed on each [addon's page](../addons/Bank/index.md). + +!!! tip "See the defaults on your server" + Defaults (everyone, operators only, or nobody) are set by each game mode and differ between them. Run `/bentobox perms` in the console to print every command permission with its default on your server. + +## BentoBox + +| Permission | Default | Allows | +|---|---|---| +| `bentobox.about` | Everyone | `/bentobox about` | +| `bentobox.version` | Operators | `/bentobox version` | +| `bentobox.admin` | Operators | `/bentobox` and its admin subcommands | +| `bentobox.admin.reload` | Operators | `/bentobox reload` and `reload locales` | +| `bentobox.admin.manage` | Operators | `/bentobox manage` | +| `bentobox.admin.catalog` | Operators | `/bentobox catalog` | +| `bentobox.admin.locale` | Operators | `/bentobox locale` | +| `bentobox.admin.migrate` | Operators | `/bentobox migrate` | +| `bentobox.admin.perms` | Operators | `/bentobox perms` | +| `bentobox.admin.rank` | Operators | `/bentobox rank` | +| `bentobox.admin.placeholders` | Operators | `/bentobox placeholders` | +| `bentobox.admin.dump-placeholders` | Operators | `/bentobox dump-placeholders` | + +## Game mode: player commands + +Most of these are given to everyone by the game mode. Check with `/bentobox perms`; in some game modes `island.homes`, `island.deletehome` and `island.renamehome` are operator-only by default. + +| Permission | Allows | +|---|---| +| `[gamemode].island` | The player command itself and `help` | +| `[gamemode].island.ban` | `ban`, `banlist`, `unban` | +| `[gamemode].island.create` | `create` | +| `[gamemode].island.deletehome` | `deletehome` | +| `[gamemode].island.expel` | `expel` | +| `[gamemode].island.home` | `go` | +| `[gamemode].island.homes` | `homes` | +| `[gamemode].island.info` | `info` | +| `[gamemode].island.language` | `language` | +| `[gamemode].island.lock` | `lock` | +| `[gamemode].island.name` | `resetname`, `setname` | +| `[gamemode].island.near` | `near` | +| `[gamemode].island.renamehome` | `renamehome` | +| `[gamemode].island.reset` | `reset` | +| `[gamemode].island.sethome` | `sethome` | +| `[gamemode].island.settings` | `settings` | +| `[gamemode].island.spawn` | `spawn` | +| `[gamemode].island.team` | `team` | +| `[gamemode].island.team.accept` | `team accept` | +| `[gamemode].island.team.coop` | `team coop`, `team uncoop` | +| `[gamemode].island.team.invite` | `team invite` | +| `[gamemode].island.team.kick` | `team kick` | +| `[gamemode].island.team.leave` | `team leave` | +| `[gamemode].island.team.promote` | `team demote`, `team promote` | +| `[gamemode].island.team.reject` | `team reject` | +| `[gamemode].island.team.setowner` | `team setowner` | +| `[gamemode].island.team.trust` | `team trust`, `team untrust` | + +## Game mode: admin and moderator commands + +Operators only by default. + +| Permission | Allows `/[admin_command]` | +|---|---| +| `[gamemode].admin` | The admin command itself and `help` | +| `[gamemode].admin.blueprint` | `blueprint` | +| `[gamemode].admin.blueprint.copy` | `blueprint copy` | +| `[gamemode].admin.blueprint.delete` | `blueprint delete` | +| `[gamemode].admin.blueprint.list` | `blueprint list` | +| `[gamemode].admin.blueprint.load` | `blueprint load` | +| `[gamemode].admin.blueprint.origin` | `blueprint origin` | +| `[gamemode].admin.blueprint.paste` | `blueprint paste` | +| `[gamemode].admin.blueprint.pos1` | `blueprint pos1` | +| `[gamemode].admin.blueprint.pos2` | `blueprint pos2` | +| `[gamemode].admin.blueprint.rename` | `blueprint rename` | +| `[gamemode].admin.blueprint.save` | `blueprint save` | +| `[gamemode].admin.blueprint.sink` | `blueprint sink` | +| `[gamemode].admin.deaths` | `deaths` | +| `[gamemode].admin.deaths.add` | `deaths add` | +| `[gamemode].admin.deaths.remove` | `deaths remove` | +| `[gamemode].admin.deaths.reset` | `deaths reset` | +| `[gamemode].admin.deaths.set` | `deaths set` | +| `[gamemode].admin.delete` | `delete` | +| `[gamemode].admin.getrank` | `getrank` | +| `[gamemode].admin.purge` | `purge` | +| `[gamemode].admin.purge.age-regions` | `purge age-regions` | +| `[gamemode].admin.purge.deleted` | `purge deleted` | +| `[gamemode].admin.purge.protect` | `purge protect` | +| `[gamemode].admin.purge.unowned` | `purge unowned` | +| `[gamemode].admin.range` | `range` | +| `[gamemode].admin.range.add` | `range add` | +| `[gamemode].admin.range.display` | `range display` | +| `[gamemode].admin.range.purgebonus` | `range purgebonus` | +| `[gamemode].admin.range.remove` | `range remove` | +| `[gamemode].admin.range.removebonus` | `range removebonus` | +| `[gamemode].admin.range.reset` | `range reset` | +| `[gamemode].admin.range.set` | `range set` | +| `[gamemode].admin.register` | `register` | +| `[gamemode].admin.reload` | `reload` | +| `[gamemode].admin.resetflags` | `resetflags` | +| `[gamemode].admin.resets` | `resets` | +| `[gamemode].admin.resets.add` | `resets add` | +| `[gamemode].admin.resets.remove` | `resets remove`, `resets reset` | +| `[gamemode].admin.resets.set` | `resets set` | +| `[gamemode].admin.setprotectionlocation` | `setprotectionlocation` | +| `[gamemode].admin.setrank` | `setrank` | +| `[gamemode].admin.setspawn` | `setspawn` | +| `[gamemode].admin.setspawnpoint` | `setspawnpoint` | +| `[gamemode].admin.settings` | `settings` | +| `[gamemode].admin.tp` | `tp`, `tpend`, `tpnether` | +| `[gamemode].admin.tpuser` | `tpuser`, `tpuserend`, `tpusernether` | +| `[gamemode].admin.undelete` | `undelete` | +| `[gamemode].admin.unregister` | `unregister` | +| `[gamemode].admin.version` | `version` | +| `[gamemode].admin.why` | `why` | +| `[gamemode].mod.deletehomes` | `deletehomes` | +| `[gamemode].mod.info` | `info` | +| `[gamemode].mod.maxhomes` | `maxhomes` | +| `[gamemode].mod.resethome` | `resethome` | +| `[gamemode].mod.resetname` | `resetname` | +| `[gamemode].mod.switch` | `switch` | +| `[gamemode].mod.team` | `team` | +| `[gamemode].mod.team.add` | `team add` | +| `[gamemode].mod.team.disband` | `team disband` | +| `[gamemode].mod.team.disbandall` | `team disbandall` | +| `[gamemode].mod.team.kick` | `team kick` | +| `[gamemode].mod.team.maxsize` | `team maxsize` | +| `[gamemode].mod.team.setowner` | `team setowner` | + +## Game mode: limits and perks + +These end in a number, which replaces the config value for that player. The highest number a player has wins. See [Permissions & VIP Perks](Permissions-Guide.md#perks-with-a-number) for the rules. + +| Permission | Sets | Config value it replaces | +|---|---|---| +| `[gamemode].team.maxsize.` | Team size, including the owner (island owner's permission) | `island.max-team-size` | +| `[gamemode].coop.maxsize.` | Coop players (island owner's permission) | `island.max-coop-size` | +| `[gamemode].trust.maxsize.` | Trusted players (island owner's permission) | `island.max-trusted-size` | +| `[gamemode].island.range.` | Island protection range (island owner's permission) | `world.protection-range` | +| `[gamemode].island.maxhomes.` | Number of homes (island owner's permission) | `island.max-homes` | +| `[gamemode].island.number.` | Number of islands a player can own | `world.concurrent-islands` | +| `[gamemode].ban.maxlimit.` | Players they can ban at once | `world.ban-limit` | + +| Permission | Allows | +|---|---| +| `[gamemode].island.create.` | Choosing a starter island (blueprint bundle) that requires a permission | +| `[gamemode].island.name.format` | Colour codes in island names | + +## Game mode: island settings + +| Permission | Allows | +|---|---| +| `[gamemode].settings.` | Changing that setting in `/[player_command] settings` | +| `[gamemode].settings.*` | Changing every setting | +| `[gamemode].admin.settings.` | Changing that flag in `/[admin_command] settings` | +| `[gamemode].admin.world.settings.` | Changing that world setting or world protection | +| `[gamemode].admin.set-world-defaults` | The World Protections tab of the admin settings | + +See [Protection, Flags & Ranks](Island-Protection,-Flags-&-Ranks.md) for the flag IDs. + +## Game mode: moderator bypasses + +| Permission | Effect | +|---|---| +| `[gamemode].mod.bypassprotect` | Ignore all protection flags everywhere | +| `[gamemode].mod.bypass..everywhere` | Ignore one protection flag everywhere | +| `[gamemode].mod.bypass..island` | Ignore one protection flag on islands | +| `[gamemode].mod.bypasslock` | Enter locked islands | +| `[gamemode].mod.bypassban` | Enter islands they are banned from | +| `[gamemode].mod.bypassexpel` | Can't be expelled | +| `[gamemode].mod.bypasscooldowns` | Skip command cooldowns | +| `[gamemode].mod.bypassdelays` | Skip teleport delays | +| `[gamemode].admin.noban` | Can't be banned from islands | +| `[gamemode].admin.noexpel` | Can't be expelled from islands | + +`/[admin_command] switch` turns a moderator's bypass permissions off and on. See [Bypass the protection](Island-Protection,-Flags-&-Ranks.md#bypass-the-protection). diff --git a/mkdocs.yml b/mkdocs.yml index f9cc6095..41ae8801 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -20,6 +20,7 @@ nav: - "Teams & Ranks": BentoBox/About/Teams.md - Islands: BentoBox/About/IslandManagement.md - "Multiple Islands": BentoBox/ConcurrentIslands.md + - "Permissions & VIP Perks": BentoBox/Permissions-Guide.md - "Starter Islands (Blueprints)": BentoBox/About/BlueprintsSummary.md - "Making Blueprints": BentoBox/Blueprints.md - "Customizing Menus": Tutorials/generic/Customizable-GUI.md