Updated the gm commands configuration file according to Freeyorp's modifications on wiki.

1 files changed, 141 insertions, 120 deletions

diff --git a/world/map/conf/atcommand_local.conf.example b/world/map/conf/atcommand_local.conf.example
index 0e87addc..0998aad3 100644
--- a/world/map/conf/atcommand_local.conf.example
+++ b/world/map/conf/atcommand_local.conf.example
@@ -39,28 +39,29 @@ gm: 100
 //-------------------------
 // 40: "Dev"
 
-// Broadcast to the whole server
+// Broadcast to all map-servers.
 broadcast: 40
 
-// Broadcast to the map you are on
+// Broadcast to the current map-server.
+// (Note: TMW currently only uses one map server)
 local_broadcast: 40
 
-// Suicide your character.
+// Instantly kills the invoker, regardless of current health.
 die: 40
 
 // Locate someone on a map, returns your coordinates if the person isn't on.
 where: 40
 
-// Spawns you to set points in major cities.
+// Warp the invoker to set points in major cities.
 go: 40
 
 // Warp yourself to a person.
 goto: 40
 
-// follow a player (including warping to them)
+// Cause the invoker to follow a specified character, including warps. (Disabled)
 follow: 40
 
-// Disconnects a user from the server (1 command + right click menu for GM "(name) force to quit").
+// Disconnects a user from the server.
 kick: 40
 
 // Returns list of logged in characters with their position.
@@ -69,156 +70,166 @@ who: 40
 // Returns list of logged in characters with their party/guild.
 whogroup: 40
 
-// Returns list of logged in characters with their position in a specifical map.
+// Returns list of logged in characters with their position in a specified map.
 whomap: 40
 
-// Returns list of logged in characters with their party/guild in a specifical map.
+// Returns list of logged in characters with their party/guild in a specified map.
 whomapgroup: 40
 
-// Like @who+@who2+who3, but only for GM.
+// Like @who, but only lists GM characters.
 whogm: 40
 
-// Enables you to view other characters stats.
+// Send information to the invoker about the specified character's stats.
 charstats: 40
 
-// Heals a person to full HP/SP.
+// Heals the invoker to full HP/SP, regardless of previous health.
 heal: 40
 
-// GM Hide (hides you from monsters and most reporting functions).  
-// To hide from other players use @invisible
+// Hides the invoker from monsters and most reporting functions.
+// Will not cause the invoker to be hidden from other clients in visual range.
 hide: 40
 
-// Enables you to to jump randomly on a map (that you are already on).
+// Enables you to to jump randomly on a map (where you already are).
 jump: 40
 
-// Warps you to your last save point.
+// Warp the invoker to his last save point.
 return: 40
 
-// Warp yourself to a certain map, at (x,y) coordinates.
+// Warp the invoker to a certain map, at (x,y) coordinates.
 warp: 40
 
-// Changes GM clothes color (2 same commands)
+// Change the GM clothes color, 2 same commands. (Disabled)
 dye: 40
 ccolor: 40
 
-// Changes own hair style.
+// Alters the invokers hair style to the specified ID.
 hairstyle: 40
 
-// Changes own hair color.
+// Alters the invokers hair color to the specified ID.
 haircolor: 40
 
 // Deletes all your items.
 itemreset: 40
 
-// Sets your spawn point (aka save point).
+// Sets the invokers soawn/save/home point. Defaults to the current location if no coordinates are specified.
 save: 40
 
-// Send text to the GM log
+// No effect. The sole purpose of this command is for it, and all arguments, to be implicity logged along with all arguments.
+// This and/or @t should be used to log rationale for any uncommon use of the commands.
 log: 40
 l: 40
 
-// Send text to the GM log and local chat
+// Sends a message normally, as if it had not been preceded with @t. This serves when issuing official warnings.
+// This and/or @l should be used to log rationale for any uncommon use of the commands.
 tee: 40
 t: 40
 
 //--------------------
 // 50: Event coordinators
 
-// make yourself invisible to everyone
+// Causes the invoker to become invisible to other clients.
+// No other effect is taken, for instance aggressive mobs may still attack the invoker.
 invisible: 50
 
-// make yourself visible to everyone
+// Removes any invisible status set by the above command and immediately announces the invokers presence to all clients in range.
 visible: 50
 
-// Spawns a monster, and a certain amount
+// Spawns the specified monster in the specified amount, or one monster if no amount specified.
+// These monsters act as if spawned normally but without any attached scripts on their death, such as monster points.
 spawn: 50
 
-//Summons a monster, and a certain amount
+// Summons a specified monster in the specified amount, or one monster if no amount is specified.
+// These monsters act as if spawned normally but without any attached scripts on their death, such as monster points.
 summon: 50
 
 //--------------------
 // 60: "GM"
 
-// Enable all wispers for a player
+// Enable all whispers for a player.
+// Not used by TMW, which has client-side ignore lists
 inall: 60
 
-// Disable all wispers for a player
+// Disable all whispers for a player.
+// Not used by TMW, which has client-side ignore lists
 exall: 60
 
-// Shows Stats Of All Characters Online
+// Returns stats of all characters connected to the map server.
 charstatsall: 60
 
-// Turns PVP (Person v. Person) off on a map.
+// Turns PvP off on a map.
 pvpoff: 60
 
-// Enables PVP on a map.
+// Enables PvP on a map.
 pvpon: 60
 
 // Sets the speed you can walk/attack at. Default is 150.
 speed: 60
 
-// Kill all monsters in map (with drops)
+// Kill all monsters in map (with drops).
 killmonster: 60
 
-// Kill all monsters in map (without drops)
+// Kill all monsters in map (without drops).
 killmonster2: 60
 
-// Check which characters are online from a characters IP address
+// Check which characters are online from a characters IP address.
 ipcheck: 60
 
-// store all your items
+// Store all the invokers items.
 storeall: 60
 
-// allow other players to hit you out of pvp
+// Allow other players to hit the invoker out of PvP.
 killable: 60
 
-// look up a skill by name
+// Look up a skill by name.
 skillid: 60
 
-// use a skill by id
+// Use a skill by ID.
 useskill: 60
 
-// make another player killable
+// Make another player killable.
 charkillable: 60
 
-// Resurects yourself.
+// Resurrects yourself.
 alive: 60
 
-// Levels your character to specified level (adds to your level).
+// Alters the invokers base level by the specified delta.
 blvl: 60
 
-// Raises your job level (3 same commands).
+// Alters the invokers job level by the specified delta.
 jlvl: 60
 
-// Unmute a player
+// A command that removes the NOCHAT status effect from a specified character if active.
+// As there is currently no way for this status effect to be set, this has no use.
 unmute: 60
 
-// Sets another persons base level.
+// Alters the specified characters base level by the specified delta.
 charblvl: 60
 
-// Changes the sex of an online player (all characters on the account)
+// Change the sex of an online player, including all characters on the account.
 charchangesex: 60
 
-// Remove items from a character
+// Remove items from a character.
 chardelitem: 60
 
-// Sets another persons job level.
+// Alters the specified characters job level by the specified delta.
 charjlvl: 60
 
-// Gives another character status points
+// Give to another character status points.
 charstpoint: 60
 
-// Gives another character skill points
+// Give to another character skill points.
 charskpoint: 60
 
-// Resets another character's stats
+// Resets another character's stats.
 charreset: 60
 
-// Resets another character's status, skills
+// Resets another character's status.
 charstreset: 60
+
+// Resets another character's skills.
 charskreset: 60
 
-// resets a char back to when it was first created
+// Resets a character back to when it was first created.
 charwipe: 60
 
 // Saves the respawn point of another character.
@@ -227,19 +238,19 @@ charsave: 60
 // Kill another character without hitting them.
 kill: 60
 
-// Enable hitting a player even when not in pvp
+// Enable hitting a player even when not in PvP.
 killer: 60
 
-// Warps a character to you
+// Warp a character to the invoker.
 recall: 60
 
-// Revives a character, and heals them.
+// Revives a character and heals them.
 revive: 60
 
-// Warp another person to a certain map, at (x,y) coordinates
+// Warp another person to a certain map, at (x,y) coordinates.
 charwarp: 60
 
-// Change Status of your character
+// Change the stats of the invoker's character.
 str: 60
 agi: 60
 vit: 60
@@ -247,73 +258,77 @@ int: 60
 dex: 60
 luk: 60
 
-// Gets all skills
+// Get all skills.
 allskills: 60
 
-// sets GM stats to maximum
+// Set GM stats to maximum.
 allstats: 60
 
-// Gives you job points.
+// Give to the invoker job points of the desired amount.
 stpoint: 60
 
-// Gives you skill points of desired amount.
+// Give to the invoker skill points of the desired amount.
 skpoint: 60
 
-// To block definitively a player
+// Blocks ab account with no expiry date.
 block: 60
 
-// To unblock a player
+// Removes any block on an account.
 unblock: 60
 
-// To ban a player for a limited time
+// Bans an account for the specified time, or adjusts an existing ban by the specified delta.
 ban: 60
 
-// To unban a player
+// Removes any ban on an account.
 unban: 60
 
-// To send specified character in jails
+// Send a specified character in jail.
+// The map is hardboded in and irrelevant for TMW content.
 jail: 60
 
-// To discharge a prisoner
+// To discharge a prisoner.
+// The map is hardboded in and irrelevant for TMW content.
 unjail: 60
 
-// drop a players possessions on the ground
+// Drop a players possessions on the ground.
 chardropall: 60
 
-// put a players possessions in storage
+// Put a players possessions in storage.
 charstoreall: 60
 
-// iterate over players
-// forward
+// Iterate over all characters connected to the map server forward.
 hugo: 60
-// backward
+
+// Iterate over all characters connected to the map server backwards.
 linus: 60
 
 //----------------------
 // 80: "eA Dev"
 
-// set magic properties on a char
+// Sets magic properties on a character.
 setmagic: 80
 
-// list magic properties on a char
+// Lists magic properties on a character.
 magicinfo: 80
 
-// Set your character display options. (Visual effects of your character)
+// Sets the option bits of the invoker, specifically the opt1, opt2, and option variables. opt3 may not be set using this command.
+// Do not use this command unless you are familiar enough with the code base to know exactly what it does.
 option: 80
 
-// Gives you money (zeny) of desired amount.
+// Gives you money of the desired amount.
 zeny: 80
 
-// Changes another character's zenny
+// Changes another character's amount of money.
 charzeny: 80
 
-// Set options on another character.
+// As with @option, but on a specified character.
 charoption: 80
 
-// Create a static warp portal that lasts until the next reboot
+// Create a static warp portal that lasts until the next reboot.
 addwarp: 80
 
 // Set the map you are on to day.
+// Irrelevant to TMW
 day: 80
 
 // Kills everyone on the server.
@@ -323,9 +338,10 @@ doom: 80
 doommap: 80
 
 // Set the map you are currently on to night.
+// Irrelevant to TMW
 night: 80
 
-// Recalls Everyone To Your Coordinates
+// Recalls everyone to your coordinates.
 recallall: 80
 
 // Revives all players on the map.
@@ -340,86 +356,90 @@ enablenpc: 80
 // Disables a NPC.
 disablenpc: 80
 
-// Move a NPC
+// Moves a NPC.
 npcmove: 80
 
-// turn skills on for a map
+// Turn skills on for a map.
 skillon: 80
 
-// turn skills off for a map
+// Turn skills off for a map.
 skilloff: 80
 
-// Enables lost skills.
+// Lose a "quest skill"
 lostskill: 80
 
-// find id of item by name
+// Find ID of an item by name.
 idsearch: 80
 
-// Creates an item of your choosing, either Item ID or Name (1 command + /item).
+// Creates an item of your choosing, either Item ID or Name.
 item: 80
 
 // Creates weapon of desired element.
 produce: 80
 
-// ??
+// Check if all your items are in the item_db
 itemcheck: 80
 
 
 //---------------------------
 // 99: "Admin"
 
-// drop all your items
+// Drop all of the invokers items on the ground.
 dropall: 99
 
-// Enables GVG on a map (2 same commands).
+// Enables GvG on a map (2 same commands).
 gvgon: 99
 gpvpon: 99
 
-// Turns GVG (Guild v. Guild) off on a map (2 same commands).
+// Turns GvG off on a map (2 same commands).
 gvgoff: 99
 gpvpoff: 99
 
-// Enables platinum skills.
+// Enables skills.
 questskill: 99
 
-// Display your ignore list (people from which you ignore wisps)
+// Display your ignore list, people from which you ignore whispers.
+// Not used by TMW, which has client-side ignore lists
 ignorelist: 99
 
-// Display ignore list of a player (people from which the player ignore wisps)
+// Display ignore list of a player, people from which you ignore whispers.
+// Not used by TMW, which has client-side ignore lists
 charignorelist: 99
 
 // Brings up your guild storage wherever you are.
 gstorage: 99
 
-// Do some visual effect on your character
+// Do some visual effect on your character.
 effect: 99
 
-// Changes character's model
+// Changes character's model.
 charmodel: 99
 
-// Starts Guild Wars
+// Starts Guild Wars.
 agitstart: 99
 
-// Ends Guild Wars
+// Ends Guild Wars.
 agitend: 99
 
-// Levels your guild to specified level
+// Levels your guild to specified level.
 guildlvl: 99
 
-// craete a party/guild
+// Create a guild.
 guild: 99
+
+// Create a party.
 party: 99
 
-// Warps all online character of a guild to you. (at least one member of that guild must be on.)
+// Warps all online character of a guild to you, at least one member of that guild must be on.
 guildrecall: 99
 
-// Warps all online character of a party to you. (at least one party member must be online.)
+// Warps all online character of a party to you, at least one party member must be online.
 partyrecall: 99
 
-// Allows you to spy on any Guilds Guild chat. (at least one member of that guild must be on.)
+// Allows you to spy on any Guilds Guild chat, at least one member of that guild must be on.
 guildspy: 99
 
-//Allows you to spy on any party's party chat. (at least one party member must be online.)
+//Allows you to spy on any party's party chat, at least one party member must be online.
 partyspy: 99
 
 // Saves a warp point.
@@ -431,20 +451,20 @@ charmountpeco: 99
 // Change your appearence to other players to a mob.
 disguise: 99
 
-//Restore your normal appearance.
+// Restore your normal appearence.
 undisguise: 99
 
-// To change disguise of another player/GM
+// To change disguise of another player/GM.
 chardisguise: 99
 charundisguise: 99
 
-// Display all items of a player (disabled due to reformed GM guidelines)
+// Display all items of a player. (Disabled)
 charitemlist: 99
 
-// Display all items of a player's storage (disabled due to reformed GM guidelines)
+// Display all items of a player's storage. (Disabled)
 charstoragelist: 99
 
-// Display all items of a player's cart (disabled due to reformed GM guidelines)
+// Display all items of a player's cart. (Disabled)
 charcartlist: 99
 
 // Enables platinum skills of another player.
@@ -456,41 +476,42 @@ charlostskill: 99
 // Changes your apperance.
 model: 99
 
-// To get a peco to (un)ride
+// Ride or unride a peco
+// Irrelevant to TMW
 mountpeco: 99
 
-// Broadcast (with or without name).
+// Broadcast, with or without name.
 kami: 99
 kamib: 99
 
-// Disconnect all users from the server
+// Disconnect all users from the server.
 kickall: 99
 
-// Closes Map-Server
+// Closes map-server.
 mapexit: 99
 
-// Give information about terrain/area (debug function)
+// Give information about the area.
 gat: 99
 
-// Enables debugging
+// Enables debugging. Broken and may crash the server.
 packet: 99
 
-// Shows information about the map
+// Shows information about the map.
 mapinfo: 99
 
-// Re-load item database (admin command)
+// Re-load item database.
 reloaditemdb: 99
 
-// Re-load monsters database (admin command)
+// Re-load monsters database.
 reloadmobdb: 99
 
-// Re-load skills database (admin command)
+// Re-load skills database.
 reloadskilldb: 99
 
-// Re-load scripts (admin command)
+// Re-load scripts.
 reloadscript: 99
 
-// Re-load GM level (admin command)
+// Re-load GM level.
 reloadgmdb: 99
 
 // Brings up your personal storage wherever you are.