Commands Help for Server Admins

[smmmadden]

When a server owner has deployed/installed ALL the BentoBox plugins/addons, there are 15 worlds total that players can move around in. This means that it can get confusing where they are and with some commands. Many commands share the same descriptions which is fine for single worlds, but would be more user-friendly by being specific so no accidents happen.

These commands are being tested for the Wiki page to provide more help to users. It may look long, but most are simply description suggested changes. I've reviewed all of the commands and these are "suggested" edits, "questions" and "potential issues" based on the current versions on my test server shown below and testing them all today.

BENTOBOX /bentobox - displays all BentoBox Commands Suggestion: update copyright for AcidIsland to 2017 - 2019 tastybento /bentobox version - display info Suggestion: change display info to Display all installed plugins Inconsistency: name of Inv-Switcher listed as BentoBox-InvSwitcher Inconsistency: name of WelcomeWarpSigns listed as WelcomeWarps Suggestion: list of Game Worlds and Add-ons not in alphabetical order Inconsistency: "Loaded Add-Ons" is inconsistent with use of "Addon" everywhere else Inconsistency: naming conventions in Game worlds (dash versus underscore before world)

ACIDISLAND /acid version - display BentoBox and addons versions Suggestion: Provide same display with Loaded Game Worlds and Loaded Addons since it is in both /acid tpnether - teleport to a player's island Suggestion: Change to teleport to a player's nether island /acid tpend - teleport to a player's island Suggestion: Change to teleport to a player's the_end island /acid schem <load/copy/paste/pos1/pos2/save> - manipulate schems Suggestion: change to: Show all schem commands /acid reset - commands.admin.resets.reset.description Suggestion: Fix description /acid range - Admin island range command Suggestion: change to: AcidIsland range commands /acid why - toggle console protection debug reporting QUESTION: I don't the use of "why" when it could just be /acid debug /acid level - calculate the island level for player QUESTION: Island level is -25405 negative 25 thousand? Why not 0 when first starting out? /ai - The main island command Suggestion: change to AcidIsland Player Commands /ai - teleports you to your island Suggestion: This command does same /ai go when it should do same as /ai to show commands /ai about - About this addon Suggestion: Update copyright to 2017 - 2019 tastybento /ai settings - display island settings Suggestion: change to display AcidIsland Settings Menu Suggestion: change color of text and label to AcidIsland Settings /ai team - manage your team Suggestion: change to Displays Team Commands /ai level - calculate your island level or show the level of [player] Suggestion: change reference of [player] to /ai warps - open the warps panel Suggestion: There is no warps panel, it displays in-chat message to "Place a warp sign with [WELCOME] on the top" But if falls short of what to do next. Elaborate or provide GUI option for Warps.

BSKYBLOCK /island - The main island command Suggestion: change to BSkyBlock Island Commands Suggestion: does same as /island go when it should show all island commands /island about - About this addon Suggestion: update copyright for BSkyBlock to be 2017 - 2019 tastybento, Poslovitch /island settings - display island settings Suggestion: change to display BSkyBlock Island Settings Menu Suggestion: change color of text and label to BSkyBlock Island Settings /island team - manage your team Suggestion: change to Displays Team Commands /island challenges [Level] - Open the challenges menu Suggestion: change [Level] to ISSUE: GUI is empty (no options) Suggestion: GUI Title reads as "Challenges GUI" but should have Challenges Admin like bsb challenges ISSUE: No option to exit BSkyBlock and return to previous location /island warps - open the warps panel Suggestion: There is no warps panel, it displays in-chat message to "Place a warp sign with [WELCOME] on the top" But if falls short of what to do next. Elaborate or provide GUI option for Warps. /bsbadmin version - display BentoBox and addons versions Suggestion: Provide same display with Loaded Game Worlds and Loaded Addons since it is in both /bsbadmin reset - commands.admin.resets.reset.description Suggestion: description is incorrect /bsbadmin setspawn - commands.admin.setspawn.description Suggestion: description is incorrect /bsbadmin tpnether - teleport to a player's island Suggestion: change to teleport to a player's nether island /bsbadmin tpend - teleport to a player's island Suggestion: change to teleport to a player's the_end island /bsbadmin schem <load/copy/paste/pos1/pos2/save> - manipulate schems Suggestion: change to: Show all schem commands /bsbadmin why - toggle console protection debug reporting QUESTION: I don't the use of "why" when it could just be /bsbadmin debug /bsbadmin biomes - Main biome addon admin command. Opens Admin GUI for players Suggestion: GUI title shows Admin Menu - Change to BSkyBlock Biomes Menu /bsbadmin challenges - challenges admin Suggestion: change to: BSkyBlock Challenges Menu Suggestion: change color of text to match other GUI's (black) lime green hard to see on some monitors

CAVEBLOCK /cave - The main island command Suggestion: change to CaveBlock Player Main Commands Suggestion: does the same as /cave go when it should display all /cave commands /cave settings - display island settings Suggestion: change to Display CaveBlock Island Settings Menu Suggestion: change color of text and label to CaveBlock Island Settings /cave team - manage your team Suggestion: change to Displays CaveBlock Island Team Commands /cave team invite - invite a player to join your island Suggestion: change island to CaveBlock Island /cave team setowner - transfer your island ownership to a member Suggestion: change island to CaveBlock Island /cave challenges [Level] - Open the challenges menu Inconsistency: (change [Level] to ISSUE: GUI is empty (no options) Suggestion: GUI Title reads as "Challenges GUI" but should have Challenges Admin like bsb challenges ISSUE: No option to exit CaveBlock and return to previous location

SKYGRID /skygrid - Start a SkyGrid game or teleport to your SkyGrid home ISSUE: does same as /skygrid go when it should display all skygrid commands /skygrid biomes - Main biome addon command that opens biome change GUI Suggestion: change to Displays SkyGrid Island Biomes Menu Suggestion: change text to: SkyGrid Biomes Menu /skygrid challenges [Level] - Open the challenges menu Inconsistency: change [Level] to ISSUE: GUI is empty (no options) Suggestion: GUI Title reads as "Challenges GUI" but should have Challenges Admin like bsb challenges ISSUE: No option to exit SkyGrid and return to previous location QUESTION: I'm not sure I understand the significance of this addon. When I did the /skygrid I ended up on a block in the sky with columns of endless types of blocks everywhere. There isn't a wiki page for it yet, so I had no reference to look at.

Whew!! That's it. 👍 -Steve

[BONNe]

So,

• /{gamemode} challenges
• /{gamemode} biomes
• /{gamemode} level and so on is not managed by GameMode addons...

Yes, they are registered into GameMode, but these commands is provided by specific addon and is not a part of GameMode. Listing it here or in command list is not correct as it may confuse players a lot when they try to run only single gamemode.

Also permissions should not be listed as GameMode related for the same reason.

[Poslovitch]

I was going to read through all of this later - just give me some time to do so. There are definitely some interesting things to fix.

[smmmadden]

I'm not following what the reference is for /{gamemode} challenges, biomes & level is. I didn't see any reference to those commands other than what I found in-game going through all the command options for each resource.

Is the ask here not to list /bskyblock challenges, etc or its permissions? I may be confused (highly likely) by the use of the "gamemode" as the command. I equate that to switching between creative, survival, spectator, toggle and adventure modes. Is there a different reference here?

[Poslovitch]

What BONNe meant with /{gamemode} is that the parent command is different for each GameModeAddon: e.g. /island and /bsbadmin for BSB, /sg and /sgadmin for SkyGrid, etc.

[BONNe]

Btw, in latest versions, admins can change these commands ...

[smmmadden]

ah - that means that using the term of "GameMode" isn't recommended. What you're really saying is /{addon} challenges or /{addonalias} challenges. I wouldn't recommend using a term that has a different usage than what is being applied.

Someone will try /gamemode challenges or /gmc challenges or /creative challenges and find that will never work. Part of documenting features is making sure that terms have a singular meaning and cannot be confused with something quite opposite of it. :-)

[Poslovitch]

Yeah, definitely. Sadly, we cannot use another word than Gamemode to talk of an addon that adds a... gamemode, actually. Or maybe there is another word to say that in English? I'm not a native so I may have missed that - yet it wouldn't be that great to deprecate 50% of the API because of that.

I haven't read everything from your issue, but I've seen that some of the things are related to addons, not BentoBox.

[smmmadden]

okay, I wasn't suggesting any API changes, only the label of what users see. How we manage it internally doesn't need to be visible in "user" documentation. This is a common topic when semantics of how something works versus how something is used can cause confusion because we try to combine different audiences into one doc which is incorrect.

One audience documentation would be as a technical reference (for developers) and the other is User Guide (end users/server owners). The audience in this reference is the latter that we're trying to write up.

Yes, most of the commands are addon command descriptions or their results. BentoBox ones all look fine.

[tastybento]

The "official term" is GameModeAddon (or Game Mode Addon) to differentiate it from game modes like creative, survival, etc.

@smmmadden Thanks for the suggestions. Just so you know, BentoBox provides a number of off-the-shelf commands for these type of island games to use. It also has a generic set of locale text to go with them. Addons can override the text to customize it. Addons can also add commands to the base set, so things like biomes and challenges are "owned and operated" by those addons and kind of have to do their own thing when it comes to help text, etc.

You wrote:

This means that it can get confusing where they are and with some commands. Many commands share the same descriptions which is fine for single worlds, but would be more user-friendly by being specific so no accidents happen.

I know what you mean. A few times I've done /is level instead of /ai level and wondered where my levels went, but it could get really crazy to try and make all the commands different. Instead, players/admins must just make sure they get the right top-level command, e.g., /acid for AcidIsland's admin command, /skygrid for SkyGrid's user command etc.

Anyway, some comments on your recommendations:

BENTOBOX /bentobox - displays all BentoBox Commands Suggestion: update copyright for AcidIsland to 2017 - 2019 tastybento

Thanks - this is already done on the develop branch. I will release when 1.3.0 goes out

/bentobox version - display info Suggestion: change display info to Display all installed plugins

Good idea

Inconsistency: name of Inv-Switcher listed as BentoBox-InvSwitcher Inconsistency: name of WelcomeWarpSigns listed as WelcomeWarps

The names shown are the "official" names of the addons. I think I can get rid of BentoBox on InvSwitcher though.

Suggestion: list of Game Worlds and Add-ons not in alphabetical order

Good idea

Inconsistency: "Loaded Add-Ons" is inconsistent with use of "Addon" everywhere else

Agreed Inconsistency: naming conventions in Game worlds (dash versus underscore before world) Agreed. I think it was dash and became underscore, but yes.

ACIDISLAND /acid version - display BentoBox and addons versions Suggestion: Provide same display with Loaded Game Worlds and Loaded Addons since it is in both

/acid tpnether - teleport to a player's island Suggestion: Change to teleport to a player's nether island /acid tpend - teleport to a player's island Suggestion: Change to teleport to a player's the_end island

Good point. The code for all of these is the same, but a different text string should be possible

/acid schem <load/copy/paste/pos1/pos2/save> - manipulate schems Suggestion: change to: Show all schem commands

Not possible, sorry. If you do /acid schem help then you can see them all.

/acid reset - commands.admin.resets.reset.description Suggestion: Fix description

Huh. I'm not sure what that command does. @Poslovitch any idea?

/acid range - Admin island range command Suggestion: change to: AcidIsland range commands

Should be possible.

/acid why - toggle console protection debug reporting QUESTION: I don't the use of "why" when it could just be /acid debug

The command shows why something is happening, so that's why it was called "why". The description text could probably be better written to explain that.

/acid level - calculate the island level for player QUESTION: Island level is -25405 negative 25 thousand? Why not 0 when first starting out?

That would be due to a bug I just fixed on the Level addon where initial island levels were not being done correctly.

/ai - The main island command Suggestion: change to AcidIsland Player Commands

Yes.

/ai - teleports you to your island Suggestion: This command does same /ai go when it should do same as /ai to show commands

I have to disagree here. Having played millions of hours, I definitely just want /ai (or /is) to teleport me home and not show help.

/ai about - About this addon Suggestion: Update copyright to 2017 - 2019 tastybento

Fixed in develop branch

/ai settings - display island settings Suggestion: change to display AcidIsland Settings Menu Suggestion: change color of text and label to AcidIsland Settings

Good idea. We'll need to do some overriding. This is a new capability that wasn't there until recently.

/ai team - manage your team Suggestion: change to Displays Team Commands

OK

/ai level - calculate your island level or show the level of [player] Suggestion: change reference of [player] to

I think some text got cut, but yes, the square brackets should be removed from the description. By the way, the convention is that parameters in square brackets are optional and parameters in chevrons < or > are mandatory.

/ai warps - open the warps panel Suggestion: There is no warps panel, it displays in-chat message to "Place a warp sign with [WELCOME] on the top" But if falls short of what to do next. Elaborate or provide GUI option for Warps.

If there are no warps, then it won't show a warps panel, but as soon as there is one, it'll show up. The tip is shown to tell you what to do. i.e, place a sign with [welcome] on the first line.

-- snip, snip (I'll do more later) --

SKYGRID --snip-- ISSUE: No option to exit SkyGrid and return to previous location

Yes, that would be out of scope for this addon. Admins can use a variety of plugins or addons to enable players to teleport to other worlds, e.g. Essentials Spawn will provide a /spawn command.

QUESTION: I'm not sure I understand the significance of this addon. When I did the /skygrid I ended up on a block in the sky with columns of endless types of blocks everywhere. There isn't a wiki page for it yet, so I had no reference to look at.

I recommend you search for skygrid on YouTube. It's a Minecraft staple that's been around about 6 or more years. It's extremely hard and quite weird, but taming the grid is quite pleasing.

[Poslovitch]

My turn now! I'll only run through "BentoBox-based" suggestions.

/bentobox version - display info Suggestion: change display info to Display all installed plugins

I'll do.

Inconsistency: name of Inv-Switcher listed as BentoBox-InvSwitcher Inconsistency: name of WelcomeWarpSigns listed as WelcomeWarps

These addons were not "flattened" yet. That's a long-running thing I haven't had time yet to do.

Suggestion: list of Game Worlds and Add-ons not in alphabetical order

How should I change that? And are they really displayed in alphabetical order??

Inconsistency: "Loaded Add-Ons" is inconsistent with use of "Addon" everywhere else

Fixed in 1.2.1 (https://github.com/BentoBoxWorld/BentoBox/commit/ce025cc49f357ab6d772dd996c2bbb6b2ce09f9a).

Inconsistency: naming conventions in Game worlds (dash versus underscore before world)

That's part of the long list of conventions I should write down somewhere at some point...

[Poslovitch]

I'm just removing this from 1.3.0's milestone as this will likely be part of a longer process that cannot be linked to a specific incoming release.

[smmmadden]

Awesome! Thanks, I've updated the commands pages with those that were ok'd. SkyGrid - OMG, talk about hardcore parkour type rope walking. That's a heart attack waiting to happen. LOL Definitely a great addon! 👍

[tastybento]

Suggestion: list of Game Worlds and Add-ons not in alphabetical order

How should I change that? And are they really displayed in alphabetical order??

I just made them list in alphabetical order. The suggestion was a bit confusing because it stated that they are currently not in alphabetical order, but desired to be in order. :-)

[smmmadden]

yes, sorry about the wording. The suggestion was to return the list in alphabetical order. :-)

[tastybento]

See https://docs.bentobox.world.