Ah I'll just draw up some mock-ups anyway. Here's an in-progress audit and revamp of the /help suite. I'll add more as / if I feel like it.
Thanks to Mathy for his continual help.
Commands Repos:
One
Two
Code:
COMMANDS: /report, /msg, /reply, /logout, /challenge, /search, /rating, /whois, /user, /join, /leave, /userauth, /roomauth
BATTLE ROOM COMMANDS: /savereplay, /hideroom, /inviteonly, /invite, /timer, /forfeit
OPTION COMMANDS: /nick, /avatar, /ignore, /status, /away, /busy, /back, /timestamps, /highlight, /showjoins, /hidejoins, /blockchallenges, /blockpms
INFORMATIONAL/RESOURCE COMMANDS: /groups, /faq, /rules, /intro, /formatshelp, /othermetas, /analysis, /punishments, /calc, /git, /cap, /roomhelp, /roomfaq (replace / with ! to broadcast. Broadcasting requires: + % @ # ~)
DATA COMMANDS: /data, /dexsearch, /movesearch, /itemsearch, /learn, /statcalc, /effectiveness, /weakness, /coverage, /randommove, /randompokemon (replace / with ! to broadcast. Broadcasting requires: + % @ # ~)
DRIVER COMMANDS: /warn, /mute, /hourmute, /unmute, /alts, /forcerename, /modlog, /modnote, /modchat, /lock, /weeklock, /unlock, /announce
MODERATOR COMMANDS: /globalban, /unglobalban, /ip, /markshared, /unlockip
ADMIN COMMANDS: /declare, /forcetie, /forcewin, /promote, /demote, /banip, /host, /ipsearch
-
For details of a specific command, use something like: /help data
My goals:
General:
A) Document how you are or are not able to access help for a command.
/help commandname works for almost anything, I'll just note rare exceptions where a help syntax doesn't work as expected
B) Log all public-facing commands in an accessible way. (stretch goal)
Within Command Help Messages: (My changes are
underlined. I use extra line breaks here for readability.)
C) Improve the existing goals of specifying alternative entry means and (briefly) other commands with related functions.
D) Specify unclear parameter mechanics.
E) Add whatever other miscellaneous information would be useful.
COMMANDS:
1) /report:
Does /help commandname function?
No.
Does /commandname with no parameters function?
Mostly - it enacts the HT Report interface.
Suggestion: /help report becomes
Code:
Takes you to the PS Help system for a reporting a player. The Help system explains how to use it.
If you want to contact PS Staff for another reason besides reporting a player, use /helpticket (/ht) instead.
2) /msg
Does /help commandname function?
Yes.
Does /commandname with no parameters function?
Yes.
(I'll stop reporting the results of these questions unless they are unusual.)
Suggestion: Make the help message clearer on aliases and note offline PMs.
Current:
Code:
/msg OR /whisper OR /w [username], [message] - Send a private message.
New:
Code:
/msg [username], [message] - Send a private message.
You can also use /whisper, /w, /dm, or /pm. You can also click a username and press "Chat."
If the other user is offline, use /offlinemsg.
3) /reply
Suggestion: Consider moving this to a more obscure location. I don't see people talk about it
ever, and it seems like bait for accidents. Happy to be proven wrong though.
Suggestion 2: Make the help message show alternate means and note the general use /msg.
Rich (BB code):
/reply OR /r [message] - Send a private message to the last user you got a private message from, or sent a message to.
You can also just chat within the private message window.
To send a private message to any user, use /msg.
4) /logout
Suggestion: Make the help message show an alternate means and softly discourage using the command when unnecessary.
Rich (BB code):
/logout - Logs you out and ends your session.
You can also click the Log out button in Options.
To leave PS without having to log in again, just close the tab or browsing window.
If you wanted to change your name while staying connected, use the '/nick' command.
The last line is mostly stolen from the existing PS! message when you log out.
5) /challenge
Suggestion: /challenge is oddly inconsistent with automatically enabling the Bo3 tab for some formats (like Random Battles) and not others (like OU). Further, clicking the username and "Challenge" will
not enable the Bo3 tab for formats like Random Battles, though it does for VGC.
If this is unintentional, it can be wrangled. If it is intentional, it can be explained in the help message.
Suggestion 2: Make the help message show an alternate means and explain how to challenge yourself.
/help challenge (particularly through the challenge rules page) has tremendous functionality. My text suggestions are minor and partially stolen from a pre-existing PS message. I might dig into the separate Challenge Rules page another time.
Rich (BB code):
/challenge - Asks you to name a user to challenge to a battle. If done in a user's private messages, it prompts you to challenge that user.
You can also click on a user's name and press "Challenge."
/challenge [user] - Challenge the user [user] to a battle.
You can't battle yourself. The best you can do is open PS in Private Browsing and log into a different username, and battle that username.
/challenge [user], [format] - Challenge the user [user] to a battle in the specified [format].
...
6. /search
Does /commandname with no parameters function?
It returns nothing and briefly freezes PS.
Suggestion: Mathy
says /search is not intended for direct use on the official client (at least currently). It should probably be slotted to a more obscure place than /help (if it is unchanged).
Suggestion 2: Make /search with no parameters either default to the help text, or pull up a small prompt interface like /challenge without parameters does.
Suggestion 3: Make the help clarify the rarer use case, show an alternate means, note the restriction to ladder battles, and note /challenge for non-ladder formats. (If someone more knowledgable wants to add more about the official client part, go right ahead - I'm largely just stealing Mathy's note.)
Rich (BB code):
/search [format] - Searches for a ladder battle in the specified format.
You can also use the Battle window in the left.
This command is not intended for direct use on the official client. If you are searching for a teambuilding format, use the Battle window instead.
You can only search for formats you can play on the ladder.
For other formats, try /challenge.
7. /rating
Suggestion: Make the help message slightly clearer on the command's function, note the specific format parameter, and note the PS ratings FAQ.
Rich (BB code):
/rating - Get your own rating on all ladder formats.
/rating [username], [format] - Get user [username]'s ratings on [format] format.
If you do not specify a format, you will see all formats.
For more information on what the ratings mean, see the PS ratings guide here.
8. /whois
As I understand it, /alts covers all the functionality of /whois and more.
Notably, the help message says it provides information like IP and alts, but it does not. /alts does that. (At least for me checking myself as a non-global staff.)
Suggestion: Turn /whois into an alias for /alts.
9. /user
While testing, I had a weird bug where /user with no parameter returned my profile as intended the first time, but future uses made /user into /nick. Even going to a private tab did not revert /user into its proper form.
Suggestion: Stop /user from becoming /nick.
Suggestion 2: Make the help message show an alternate means and note statuses.
Rich (BB code):
/user [user] - Open a popup containing the user [user]'s avatar, name, rank, status, and chatroom list.
You can also click on their username.
10-11. /join and /leave
Suggestion: Slightly clarify the abilities of the commands, and show alternatives.
Rich (BB code):
/join [roomname] - Attempt to join the room [roomname].
Some rooms are private, so you cannot join unless you are invited to with /invite.
Rooms often have abbreviated names you can use to join. Use /roomalias to see them.
You can also join public rooms by clicking the + chat tab, scrolling through the list, and clicking one. You can search for specific types of rooms, like battling or entertainment rooms, with the dropdown at the top.
"Attempt to" was a bit unclear.
Rich (BB code):
/leave - Leave the current room, or a specified room.
You can also click the x in the top right of the chat tab.
"Given" was a bit unclear.
12. /roomauth
Suggestion: Make the help message's use of "authority" more clear, note again that bolded users are currently online, and reference the groups faq to explain what room ranks are.
Rich (BB code):
/roomauth [room] - Shows a list of the staff and other rank users in the given [room].
If no room is given, it defaults to the current room.
Names in bold are currently online.
To learn what room staff and other ranks mean, use /groups.
13. /userauth
Suggestion: Like /roomauth, clarifying what "authority" means and referencing the groups faq.
Rich (BB code):
/userauth [username] - Shows all staff positions and other ranks visible to the user for the given [username].
If no username is given, it defaults to the current user.
To learn what room staff and other ranks mean, use /groups.
BATTLE ROOM COMMANDS:
1. /savereplay
Suggestion: Clarify how to get replays, and how the command interacts with /hideroom. This tripped me up personally quite a bit.
Rich (BB code):
Saves the replay for the current battle.
When you save a replay, PS will give you a link to the replay in the replay database.
You can access the entire database here. You can search for any replays in any format from any user, including yourself, or see featured replays.
If either player makes a battle private with /hideroom or hides the replay with /hidereplay, you can still save it with /savereplay and share it with the link. However, a saved replay of a private battle will not appear in the public replay database. You can only search for your own private replays in the database.
2-4. /hideroom, /secretroom, /publicroom
Does /help commandname function?
Yes, but it technically doesn't include the pure command.
Suggestion: /hiddenroom off is specified by the help message but did not work for me, returning this error.
Please specify what privacy setting you want for this room: /hiddenroom, /secretroom, or /publicroom
Therefore, I suggest removing this functionality. /publicroom seems to have its functionality anyway.
Suggestion 2: Merge /hidereplay's help message into this command. It has very similar functionality. Split /secretroom and /publicroom off due to overcrowding. (They are still referenced in the /hideroom help message, so user's won't be left in the dark.)
Suggestion 3: Make the battle functionality more clear and more separate from the chatroom functionality. Note /hidereplay as a battle alternative. Make the chatroom functionalities more clear too.
Old:
Code:
/secretroom - Makes a room secret. Secret rooms are visible to ~ and up. Requires: ~
/hiddenroom [on/off] - Makes a room hidden. Hidden rooms are visible to % and up, and inherit global ranks. Requires: ☆ ~
/publicroom - Makes a room public. Requires: ☆ ~
(Separately:)
/hidereplay - Hides the replay of the current battle. Requires: ☆ ~
New:
Rich (BB code):
/hideroom OR /hiddenroom (Battle) - Makes a battle or chat room hidden. Requires: ☆ ~
Hidden rooms are only visible to global staff and inherit global ranks. To learn more about ranks, use /groups.
Users can join hidden rooms if another user invites them with /invite. Unlike secret rooms with /secretroom, users can also join if they know the hidden room's name and use /join. /publicroom removes a room's hidden status.
Hidden battle rooms have special functionality. If the replay is saved with /savereplay, it will be hidden from the public replay database. Players can only search up their own hidden replays. Also, if any player hides a battle room, all players must unhide the room for it to be public.
/hidereplay - Hides the replay of the current battle. Also hides the room, like /hideroom, but the replay remains hidden even if all players make the battle public again. Requires: ☆ ~
(Separately:)
/secretroom - Makes a room secret. Secret rooms are visible to ~ and up. Requires: ~
To join a secret room, a user in the room must invite you with /invite. Unlike a room hidden with /hideroom, knowing the room's name and using /join will not work. /publicroom removes a room's secret status.
(Separately:)
/publicroom - Makes a battle or chat room public. This undoes /hideroom and /secretroom. Requires: ☆ ~
For a hidden battle room, all players must use /publicroom to make the room public. For a chat room, the room becomes accessible through the list of chat rooms.
5. /inviteonly
Does /help commandname function?
Yes but it probably shouldn't.
Does /commandname with no parameters function?
Yes but it probably shouldn't.
Here is the current help message.
Code:
/inviteonly [on|off] - Sets modjoin %. Users can't join unless invited with /invite. Requires: # ~
/ioo - Shortcut for /inviteonly on
/inviteonlynext OR /ionext - Sets your next battle to be invite-only.
/ionext off - Sets your next battle to be publicly visible.
/inviteonly on is an alias for /modjoin %. Everything else here is deprecated and throws an error to the effect of.
"foo" is an outdated feature. Hidden battles now have password-protected URLs, making them fully secure against eavesdroppers.
You probably want to switch from /ionext to /hidenext, and from /ioo to /hideroom
Suggestion: Remove this help message and make /inviteonly throw the same error as its shortened form. I can't imagine people are getting ue out of a more restrictive /modjoin alias whose original purpose is deprecated. If people really like /inviteonly for whatever reason, it can be filed under the help message for /modjoin.
6. /invite
Suggestion: Clarify interaction with hidden and secret rooms.
Rich (BB code):
/invite [username] - Invites the player [username] to join the room you sent the command to.
/invite [comma-separated usernames] - Invites multiple users to join the room you sent the command to. Requires trusted
/invite [username], [roomname] - Invites the player [username] to join the room [roomname].
(in a PM) /invite [roomname] - Invites the player you're PMing to join the room [roomname].
An invite is necessary to join a room made secret with /secretroom. An invite or room name is necessary to join a room hidden with /hideroom.
7. /timer
Suggestion: Make the Help room FAQ on the timer into a system wide FAQ, /faq timer, and expand it to include VGC/BSS timer (even if briefly).
Suggestion 2: Clarify alternatives and timer mechanics in the /timer help message. Make the more popular option (tmk) forefront.
Rich (BB code):
/timer [on|off] - Starts or stops the game timer. Requires: ☆ % @ ~
You can also use /timer or /timer start to start it, and /timer stop to stop it.
Use /faq timer to learn about the timer's mechanics.
8. /forfeit
Suggestion: Clarify an alternative. Remove the vaguely menacing "if it supports that" qualifier, unless there is some use case I'm unaware of where players are not allowed to forfeit. (I'm not sure how that would function anyways, as they could just freeze progress by not inputting anything, and the timer would not be useful because it'd create analogous function to /forfeit.)
Rich (BB code):
/forfeit - Forfeits your currently active game.
You can also click the x at the top right of the battle tab.
OPTION COMMANDS:
1. /nick
Suggestion: Clarify how username changes work and what you can do with usernames.
Rich (BB code):
/nick [new username] - Change your username.
If your chosen username is registered or disabled, somebody else already chose it.
You can't change a username's color without being global staff or winning a special event. Experiment with different names to see different colors. Also, ladder ratings are tied to usernames.
If you are autoconfirmed, switching to a new name without logging out will keep your autoconfirmed status, so you can still chat in rooms. See /faq ac for more information.
Usernames must follow the username rules.
2. /avatar
Does /help commandname function?
Yes, but it technically doesn't include the pure command.
Does /commandname with no parameters function?
Mostly. It returns a slightly different interface.
Suggestion: Make /help avatar an alias for the superior /avatar interface. To preserve information, briefly note the !avatar function in the /avatar help interface.
Here is the current description for !avatar. It could be worded more organically in its new home.
Code:
!avatar [avatar name or number] - Show the specified trainer sprite and credits. Requires: + % @ # ~
3. /ignore
Suggestion: Clarify what ignore specifically does.
Rich (BB code):
/ignore [user] - Hide all messages and challenges from the user [user].
...
4. /status
No suggestion.
5-7. /away, /busy, and /back
Suggestion 1: Merge the help messages together for these similar commands.
Suggestion 2: Clarify what exactly they do.
Rich (BB code):
/away - Marks you as away. Your username will appear gray in the user list, and at the bottom of any rank you have. Being idle for thirty minutes will do the same.
/busy - Marks you as busy. Similar to /away, but only using /back will revert it.
/donotdisturb - Marks you as busy. Also, it blocks private messages and challenges.
Other users will see your away, idle, or busy status when they click on your name.
/back - Returns you to normal from /away, /busy, or /donotdisturb. If you used /away, sending a message, or otherwise interacting with PS, will also return you to normal.
8. /timestamps
Does /commandname with no parameters function?
It gets you there but throws an error.
Suggestion 1: Just make /timestamps an alias for /help timestamps, instead of throwing an error, since it does that anyway.
Suggestion 2: Use a syntax for chatroom pms that is consistent with elsewhere (options gear) and less ambiguous than lobby (I legitimately thought it meant the specific Lobby room for a second). Reorder the bottom parameter set for slight tidyness. Note an alternative means.
Rich (BB code):
/timestamps [all|chatroom|pms], [minutes|seconds|off]
all - Change all timestamps preferences, chatroom - Change only chatroom preferences, pms - Change only PM preferences.
minutes - Show timestamps of the form [hh:mm], seconds - Show timestamps of the form [hh:mm:ss], off - Set timestamps off.
You can also use the Timestamps dropdowns in Options.
9. /highlight
Does /commandname with no parameters function?
It gets you there but throws an error.
Suggestion 1: Just make /highlight an alias for /help highlight, instead of throwing an error, since it does that anyway.
Suggestion 2: Make a new command, /hl name, to add your name to your highlight list, for full symmetry between the Options gear settings and commands.
Suggestion 3: Make it more clear what highlight actually does. Note regex compatibility the shortened hl form.
Rich (BB code):
Set up highlights:
/highlight add [word 1], [word 2], [...] - Add the provided list of words to your highlight list. Regex is also accepted.
If another user's message contains a word on your list, and you are in that room, the message will glow if you are actively watching that room, and the room tab will glow if you are not.
/highlight name - Adds your username to your highlight list. You can also check this setting in Options.
...
For any highlight command, you can write hl instead of highlight.
11-12. /showjoins and /hidejoins
Suggestion 1: Make the feedback messages more clear. (If the feedback messages are odd because there is some third state I don't know of, /help showjoins does not explain this setting, so that should be added.)
Suggestion 2: Clarify what exactly the command does.
Old Feedback Messages:
Code:
/showjoins: Join/leave messages: ALWAYS ON
/hidejoins: Join/leave messages: AUTOMATIC
New Feedback Messages:
Code:
/showjoins: Join/leave messages: ON
/hidejoins: Join/leave messages: OFF
/help showjoins:
Rich (BB code):
/showjoins [room] - Receive a chat message whenever a user joins or leaves a room. Optionally for only specified room.
/hidejoins [room] - Hide users' join/leave messages. Optionally for only specified room.
13-14: /blockchallenges and /blockpms
Suggestion 1: Group these similar commands' help messages together.
Suggestion 2: Clarify the interactions that follow from these commands. Note alternate forms.
Rich (BB code):
/blockchallenges OR /bch - Blocks challenges so no one can challenge you. Unblock them with /unblockchallenges OR /unbch.
/blockpms - Blocks private messages except from staff. Unblock them with /unblockpms.
/blockpms [unlocked/ac/trusted/+/friends] - Blocks private messages except from staff and the specified group.
If you block challenges / pms, and a user tries to challenge / pm you, they are told you block the action. If it was a challenge, you receive a message that [user] tried to challenge you, unless you used /ignore. If it was a pm, you receive no message.
"unless you used /ignore: pending a recently reported bug.