Mamanyonyo/akashi-esquizolandia
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add syntax suggestion on invalid argument

Browse Source 
+ Fill in help file
This commit is contained in:
Salanto 2021-09-15 22:45:38 +02:00
parent 970b0975b4
commit 650a071006
2 changed files with 631 additions and 640 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

282
bin/config_sample/text/commandhelp.json
View File

@ -1,14 +1,4 @@
[ [
{
"name": "foo",
"usage": "/foo <bar> [baz|qux]",
"text": "A sample explanation."
},
{
"name": "foo",
"usage": "/foo <bar> [baz|qux]",
"text": "A sample explanation."
},
{ {
"name":"foo", "name":"foo",
"usage":"/foo <bar> [baz|qux]", "usage":"/foo <bar> [baz|qux]",
@ -31,343 +21,343 @@
}, },
{ {
"name":"ban", "name":"ban",
"usage": "/foo <bar> [baz|qux]", "usage":"/ban [IPID|Duration|Reason]",
"text": "A sample explanation." "text":"Bans a client from the server, orcibly disconnecting them and disallowing their return."
}, },
{ {
"name":"kick", "name":"kick",
"usage": "/foo <bar> [baz|qux]", "usage":"/kick [IPID|Reason]",
"text": "A sample explanation." "text":"Kicks a client from the server, forcibly disconnecting them."
}, },
{ {
"name":"changeauth", "name":"changeauth",
"usage": "/foo <bar> [baz|qux]", "usage":"/changeauth",
"text": "A sample explanation." "text":"A helper to change the authorisation for moderators from simple to advanced."
}, },
{ {
"name":"rootpass", "name":"rootpass",
"usage": "/foo <bar> [baz|qux]", "usage":"/rootpass [Password]",
"text": "A sample explanation." "text":"Sets the root user's password."
}, },
{ {
"name":"background", "name":"background",
"usage": "/foo <bar> [baz|qux]", "usage":"/background [Name]",
"text": "A sample explanation." "text":"Changes the background of the current area."
}, },
{ {
"name":"bg", "name":"bg",
"usage": "/foo <bar> [baz|qux]", "usage":"/bg [Name]",
"text": "A sample explanation." "text":"Changes the background of the current area."
}, },
{ {
"name":"bglock", "name":"bglock",
"usage": "/foo <bar> [baz|qux]", "usage":"/bglock",
"text": "A sample explanation." "text":"Locks the background, preventing it from being changed. This command takes no arguments."
}, },
{ {
"name":"bgunlock", "name":"bgunlock",
"usage": "/foo <bar> [baz|qux]", "usage":"/bgunlock",
"text": "A sample explanation." "text":"Unlocks the background, allowing it to be changed again."
}, },
{ {
"name":"adduser", "name":"adduser",
"usage": "/foo <bar> [baz|qux]", "usage":"/adduser [Username|Password]",
"text": "A sample explanation." "text":"Adds a user to the moderators in advanced authorisation type."
}, },
{ {
"name":"listperms", "name":"listperms",
"usage": "/foo <bar> [baz|qux]", "usage":"/listperms *[Username]",
"text": "A sample explanation." "text":"Lists the permission of a given user. When called with an argument it shows the user's permission."
}, },
{ {
"name":"addperm", "name":"addperm",
"usage": "/foo <bar> [baz|qux]", "usage":"/addperm[Username|Permission]",
"text": "A sample explanation." "text":"Adds permissions to a given user."
}, },
{ {
"name":"removeperm", "name":"removeperm",
"usage": "/foo <bar> [baz|qux]", "usage":"/removeperm {Username|Permission]",
"text": "A sample explanation." "text":"Removes permissions from a given user."
}, },
{ {
"name":"listusers", "name":"listusers",
"usage": "/foo <bar> [baz|qux]", "usage":"/listusers",
"text": "A sample explanation." "text":" Lists all users in the server's database. This command takes no arguments."
}, },
{ {
"name":"logout", "name":"logout",
"usage": "/foo <bar> [baz|qux]", "usage":"/logout",
"text": "A sample explanation." "text":"Logs the caller out from their moderator user. This command takes no arguments."
}, },
{ {
"name":"pos", "name":"pos",
"usage": "/foo <bar> [baz|qux]", "usage":"/pos [Position]",
"text": "A sample explanation." "text":"Changes the client's position."
}, },
{ {
"name":"g", "name":"g",
"usage": "/foo <bar> [baz|qux]", "usage":"/g [Message]",
"text": "A sample explanation." "text":"Sends a global message (i.e., all clients in the server will be able to see it)."
}, },
{ {
"name":"need", "name":"need",
"usage": "/foo <bar> [baz|qux]", "usage":"/need [Message]",
"text": "A sample explanation." "text":"A global message expressing that the client needs something (generally: players for something)."
}, },
{ {
"name":"coinflip", "name":"coinflip",
"usage": "/foo <bar> [baz|qux]", "usage":"/coinflip",
"text": "A sample explanation." "text":"Flips a coin, returning heads or tails. This command takes no arguments."
}, },
{ {
"name":"roll", "name":"roll",
"usage": "/foo <bar> [baz|qux]", "usage":"/roll [Faces|Dice]",
"text": "A sample explanation." "text":"Rools dice and sends the results to the area. The first argument is the amount of faces each die should have. The second argument is the amount of dice that should be rolled. Both arguments are optional."
}, },
{ {
"name":"rollp", "name":"rollp",
"usage":"/foo <bar> [baz|qux]", "usage":"/foo <bar> [baz|qux]",
"text": "A sample explanation." "text":"Rolls dice, but sends the results in private to the roller. The first argument is the amount of faces each die should have. The second argument is the amount of dice that should be rolled. Both arguments are optional."
}, },
{ {
"name":"doc", "name":"doc",
"usage": "/foo <bar> [baz|qux]", "usage":"/doc [Link/Text]",
"text": "A sample explanation." "text":"Sets the `/doc` to a custom text."
}, },
{ {
"name":"cleardoc", "name":"cleardoc",
"usage": "/foo <bar> [baz|qux]", "usage":"/cleardoc",
"text": "A sample explanation." "text":"Sets the `/doc` to `No document.`. This command takes no arguments."
}, },
{ {
"name":"cm", "name":"cm",
"usage": "/foo <bar> [baz|qux]", "usage":"/cm *[ID]",
"text": "A sample explanation." "text":"Promotes a client to CM status. If called with a user ID as an argument, and the caller is a CM, promotes the target client to CM status."
}, },
{ {
"name":"uncm", "name":"uncm",
"usage": "/foo <bar> [baz|qux]", "usage":"/uncm",
"text": "A sample explanation." "text":"Removes the CM status from the caller. This command takes no arguments."
}, },
{ {
"name":"invite", "name":"invite",
"usage": "/foo <bar> [baz|qux]", "usage":"/invite [ID]",
"text": "A sample explanation." "text":"Invites a client to the area."
}, },
{ {
"name":"uninvite", "name":"uninvite",
"usage": "/foo <bar> [baz|qux]", "usage":"/uninvite [ID]",
"text": "A sample explanation." "text":"Uninvites a client to the area."
}, },
{ {
"name":"lock", "name":"lock",
"usage": "/foo <bar> [baz|qux]", "usage":"/lock",
"text": "A sample explanation." "text":"Locks the area. This command takes no arguments."
}, },
{ {
"name":"area_lock", "name":"area_lock",
"usage": "/foo <bar> [baz|qux]", "usage":"/area_lock",
"text": "A sample explanation." "text":"Locks the area. This command takes no arguments."
}, },
{ {
"name":"spectatable", "name":"spectatable",
"usage": "/foo <bar> [baz|qux]", "usage":"/spectatable",
"text": "A sample explanation." "text":"Sets the area to spectatable. This command takes no arguments."
}, },
{ {
"name":"area_spectate", "name":"area_spectate",
"usage": "/foo <bar> [baz|qux]", "usage":"/area_spectate",
"text": "A sample explanation." "text":"Sets the area to spectatable. This command takes no arguments."
}, },
{ {
"name":"unlock", "name":"unlock",
"usage": "/foo <bar> [baz|qux]", "usage":"/unlock",
"text": "A sample explanation." "text":"Unlocks the area. This command takes no arguments."
}, },
{ {
"name":"area_unlock", "name":"area_unlock",
"usage": "/foo <bar> [baz|qux]", "usage":"/area_unlock",
"text": "A sample explanation." "text":"Unlocks the area. This command takes no arguments."
}, },
{ {
"name":"timer", "name":"timer",
"usage": "/foo <bar> [baz|qux]", "usage":"/timer *[TimerID|Duration]",
"text": "A sample explanation." "text":"Gets or sets the global or one of the area-specific timers. If called without arguments, sends an out-of-character message listing the statuses of both the global timer and the area-specific timers. If called with one argument, and that argument is between `0` and `4` (inclusive on both ends), sends an out-of-character message about the status of the given timer, where `0` is the global timer, and the remaining numbers are the first, second, third and fourth timers in the current area."
}, },
{ {
"name":"play", "name":"play",
"usage": "/foo <bar> [baz|qux]", "usage":"/play [Song]",
"text": "A sample explanation." "text":"Plays music in the area. Can play either a local file or a URL."
}, },
{ {
"name":"areakick", "name":"areakick",
"usage": "/foo <bar> [baz|qux]", "usage":"/areakick [ID]",
"text": "A sample explanation." "text":"Kicks a client from the area, moving them back to the default area."
}, },
{ {
"name":"area_kick", "name":"area_kick",
"usage": "/foo <bar> [baz|qux]", "usage":"/area_kick [ID]",
"text": "A sample explanation." "text":"Kicks a client from the area, moving them back to the default area."
}, },
{ {
"name":"randomchar", "name":"randomchar",
"usage": "/foo <bar> [baz|qux]", "usage":"/randomchar",
"text": "A sample explanation." "text":"Picks a new random character for the client. This command takes no arguments."
}, },
{ {
"name":"switch", "name":"switch",
"usage": "/foo <bar> [baz|qux]", "usage":"/switch [CharacterID]",
"text": "A sample explanation." "text":"Switches to a different character based on character ID."
}, },
{ {
"name":"toggleglobal", "name":"toggleglobal",
"usage": "/foo <bar> [baz|qux]", "usage":"/toggleglobal",
"text": "A sample explanation." "text":"Toggles whether the client will ignore global messages or not."
}, },
{ {
"name":"mods", "name":"mods",
"usage": "/foo <bar> [baz|qux]", "usage":"/mods",
"text": "A sample explanation." "text":"Lists the currently logged-in moderators on the server."
}, },
{ {
"name":"commands", "name":"commands",
"usage": "/foo <bar> [baz|qux]", "usage":"/commands",
"text": "A sample explanation." "text":"Lists all the commands that the caller client has the permissions to use. This command takes no arguments."
}, },
{ {
"name":"status", "name":"status",
"usage": "/foo <bar> [baz|qux]", "usage":"/status [Status]",
"text": "A sample explanation." "text":"Changes the status of the current area."
}, },
{ {
"name":"forcepos", "name":"forcepos",
"usage": "/foo <bar> [baz|qux]", "usage":"/forcepos [ID|Position]",
"text": "A sample explanation." "text":"Forces a client, or all clients in the area, to a specific position. The first argument is the client's ID or * for all client. The second argument is the position to force the clients to."
}, },
{ {
"name":"currentmusic", "name":"currentmusic",
"usage": "/foo <bar> [baz|qux]", "usage":"/currentmusic",
"text": "A sample explanation." "text":"Returns the currently playing music in the area, and who played it. This command takes no arguments."
}, },
{ {
"name":"pm", "name":"pm",
"usage": "/foo <bar> [baz|qux]", "usage":"/pm [ID|Message]",
"text": "A sample explanation." "text":"Sends a direct message to another client on the server based on ID."
}, },
{ {
"name":"evidence_mod", "name":"evidence_mod",
"usage": "/foo <bar> [baz|qux]", "usage":"/evidence_mod [EvidenceMod]",
"text": "A sample explanation." "text":"Changes the evidence mod in the area."
}, },
{ {
"name":"motd", "name":"motd",
"usage": "/foo <bar> [baz|qux]", "usage":"/motd *[Message]",
"text": "A sample explanation." "text":"Gets or sets the server's Message Of The Day. If called without argument, gets the MOTD. If it has a message, sets the message as the MOTD."
}, },
{ {
"name":"announce", "name":"announce",
"usage": "/foo <bar> [baz|qux]", "usage":"/announce [Message]",
"text": "A sample explanation." "text":"Sends out a decorated global message, for announcements."
}, },
{ {
"name":"m", "name":"m",
"usage": "/foo <bar> [baz|qux]", "usage":"/m [Message]",
"text": "A sample explanation." "text":"Sends a message in the server-wide, moderator only chat."
}, },
{ {
"name":"gm", "name":"gm",
"usage": "/foo <bar> [baz|qux]", "usage":"/gm [Message]",
"text": "A sample explanation." "text":"Sends out a global message that is marked with an `[M]` to mean it is coming from a moderator."
}, },
{ {
"name":"mute", "name":"mute",
"usage": "/foo <bar> [baz|qux]", "usage":"/mute [ClientID]",
"text": "A sample explanation." "text":"Mutes a client."
}, },
{ {
"name":"unmute", "name":"unmute",
"usage": "/foo <bar> [baz|qux]", "usage":"/unmute [ClientID]",
"text": "A sample explanation." "text":"Removes the muted status from a client."
}, },
{ {
"name":"bans", "name":"bans",
"usage": "/foo <bar> [baz|qux]", "usage":"/bans",
"text": "A sample explanation." "text":"Lists the last five bans made on the server. This command takes no arguments."
}, },
{ {
"name":"unban", "name":"unban",
"usage": "/foo <bar> [baz|qux]", "usage":"/unban [BanID]",
"text": "A sample explanation." "text":"Removes a ban from the database."
}, },
{ {
"name":"removeuser", "name":"removeuser",
"usage": "/foo <bar> [baz|qux]", "usage":"/removeuser [Username]",
"text": "A sample explanation." "text":"Removes a user from the moderators in `advanced` authorisation type."
}, },
{ {
"name":"subtheme", "name":"subtheme",
"usage": "/foo <bar> [baz|qux]", "usage":"/subtheme [Theme]",
"text": "A sample explanation." "text":"Changes the subtheme of the clients in the current area."
}, },
{ {
"name":"about", "name":"about",
"usage": "/foo <bar> [baz|qux]", "usage":"/about",
"text": "A sample explanation." "text":"Gives a very brief description of Akashi. This command takes no arguments."
}, },
{ {
"name":"evidence_swap", "name":"evidence_swap",
"usage": "/foo <bar> [baz|qux]", "usage":"/foo [EvidenceID|EvidenceID]",
"text": "A sample explanation." "text":"Changes position of two pieces of evidence in the area."
}, },
{ {
"name":"notecard", "name":"notecard",
"usage": "/foo <bar> [baz|qux]", "usage":"/notecard [Message]",
"text": "A sample explanation." "text":"Writes a note card in the current area. he note card is not readable until all note cards in the area are revealed by a CM. A message will appear to all clients in the area indicating that a note card has been written."
}, },
{ {
"name":"notecardreveal", "name":"notecardreveal",
"usage": "/foo <bar> [baz|qux]", "usage":"/notecardreveal",
"text": "A sample explanation." "text":"Reveals all note cards in the current area. This command takes no arguments."
}, },
{ {
"name":"notecard_reveal", "name":"notecard_reveal",
"usage": "/foo <bar> [baz|qux]", "usage":"/notecard_reveal",
"text": "A sample explanation." "text":"Reveals all note cards in the current area. This command takes no arguments."
}, },
{ {
"name":"notecardclear", "name":"notecardclear",
"usage": "/foo <bar> [baz|qux]", "usage":"/notecardclear",
"text": "A sample explanation." "text":"Erases the client's note card from the area's list of cards. A message will appear to all clients in the area indicating that a note card has been erased. This command takes no arguments."
}, },
{ {
"name":"notecard_clear", "name":"notecard_clear",
"usage": "/foo <bar> [baz|qux]", "usage":"/notecard_clear",
"text": "A sample explanation." "text":"Erases the client's note card from the area's list of cards. A message will appear to all clients in the area indicating that a note card has been erased. This command takes no arguments."
}, },
{ {
"name":"8ball", "name":"8ball",
"usage": "/foo <bar> [baz|qux]", "usage":"/8ball [Question]",
"text": "A sample explanation." "text":"Randomly selects an answer from 8ball.txt to a question."
}, },
{ {
"name":"lm", "name":"lm",
"usage": "/foo <bar> [baz|qux]", "usage":"/lm [Message]",
"text": "A sample explanation." "text":"Sends out a local message that is marked with an `[M]` to mean it is coming from a moderator."
}, },
{ {
"name":"judgelog", "name":"judgelog",
"usage": "/foo <bar> [baz|qux]", "usage":"/judgelog",
"text": "A sample explanation." "text":"ends an out-of-character message with the judgelog of an area. This command takes no arguments."
}, },
{ {
"name":"allowblankposting", "name":"allowblankposting",
"usage": "/foo <bar> [baz|qux]", "usage":"allowblankposting",
"text": "A sample explanation." "text":"Toggle whether or not in-character messages purely consisting of spaces are allowed. Takes no arguments. Against all common sense this also allows you to disable blankposting."
}, },
{ {
"name":"allow_blankposting", "name":"allow_blankposting",
"usage": "/foo <bar> [baz|qux]", "usage":"/allow_blankposting",
"text": "A sample explanation." "text":"Toggle whether or not in-character messages purely consisting of spaces are allowed. Takes no arguments. Against all common sense this also allows you to disable blankposting."
}, },
{ {
"name":"gimp", "name":"gimp",
@ -638,5 +628,5 @@
"name":"help", "name":"help",
"usage":"/foo <bar> [baz|qux]", "usage":"/foo <bar> [baz|qux]",
"text":"A sample explanation." "text":"A sample explanation."
}, }
] ]

1
core/src/aoclient.cpp
View File

@ -200,6 +200,7 @@ void AOClient::handleCommand(QString command, int argc, QStringList argv)
if (argc < l_info.minArgs) { if (argc < l_info.minArgs) {
sendServerMessage("Invalid command syntax."); sendServerMessage("Invalid command syntax.");
sendServerMessage("The expected syntax for this command is: \n" + ConfigManager::commandHelp(command).usage);
return; return;
} }