Document bot commands

README.md

@@ -33,78 +33,108 @@ Talking to bot (All commands can be found in "game.py" under "public commands",
 
 Use prefix (in this case, "1") to call to attention before giving command.  (EX. 1ping, 1here, etc.)
 
-# ping
-Will respond "pong" if active and listening
 
-# pos
-Will respond with current position
+### Public Commands
 
-# afk
-Will afk (if not already)
+These can be ran by anyone, all bots will reply
 
-# unafk
-Will unafk (if afk)
+!ping - replies with "pong"
 
-# error
----
+!echo [data] - replies with "data"
 
-# inv
-Will list inventory (in terminal)
+!pos - replies with position and dimension
 
+!afk - goes AFK with /afk
 
-# time
----
+!unafk - goes not AFK with /afk
 
-# count
----
+!error - raises an error
 
-# loaded
----
+!inv - prints current inventory
 
-# players
----
+!time - replies with Minecraft world time
 
-# objects
----
+!count [id] - counts the number of items with that id
 
-# mobs
----
+!loaded - replies with the current loaded area
 
-# monsters
----
+!players - prints the current players
 
-# villagers
----
+!players clear - clears the current player list
 
-# threats
----
+!objects - prints the current items on ground
 
-# spiral
----
+!objects clear - clears the current object list
 
-# sand slice
----
+!mobs - prints the current mobs
 
-# zzz
-Will afk if in overworld, and if not already afk
+!mobs clear - clears the current mob list
 
-# tree
----
+!monsters - prints the current monsters
 
-# block
----
+!villagers - prints the current villagers
 
-#
+!threats - prints the dangerous monsters within 20 blocks
 
+!threats [num] - prints the dangerous monsters within num blocks
 
+"zzz" or !zzz - bot does /afk to let others sleep
 
+!tree - replies with the closest tree
 
+!block x y z - replies what block is at (x, y, z)
 
+### Bot-specific Commands
 
-## temporary workarounds
+These will only run for the bot they are addressed to
 
-# Add "?" to line 457, which is "match1 = re.match(r'<(\w+)> (.*)', text)"
-It should now look like this "match1 = re.match(r'<?(\w+)> (.*)', text)"
-This allows the bot to react to commands made by someone else than the creator of code (Tanner6)
+1respawn - respawns the bot if it's dead
 
+1gather wood - gathers wood from the world
+
+1gather sand - gathers sand from the world
+
+1farm wood - farms wood from a certain area
+
+1farm sand - farms sand from a certain area
+
+1farm wart - farms netherwart from a certain area
+
+1farm crop - farms mature crops from a certain area
+
+1loiter - stands still but eats, sleeps, and flees
+
+1trade - sells items to villagers to get emeralds
+
+1stop - stops the current job and resets bot
+
+1drop - drops the current stack its holding
+
+1select [id] - moves item with id into main hand
+
+1dump [id] - drops all items matching id
+
+1drain - drops all items in inventory
+
+1fill [x] [y] [z] [x] [y] [z] - fills the cuboid with the block at the first coordinate
+
+1here - bot comes to your location
+
+1goto [x] [y] [z] - sends the bot to coordinate (x, y, z)
+
+1close - closes the current Minecraft window
+
+1click [slot] [button] [mode] - clicks the current window
+
+1use - use the item it's currently holding
+
+1interact [entity id] - interacts with that entity
+
+### Authorized Commands
+
+These dangerous commands can only be ran by the bot owner
+
+1print [expression] - replies with Python eval(expression)
+
+1exit - exits the program