From b8541593dc9de49a335e60a5ebcf64ae9359479b Mon Sep 17 00:00:00 2001 From: Tanner Collin Date: Wed, 21 Apr 2021 21:47:25 +0000 Subject: [PATCH] Improve README --- README.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5db7dc6..10cbaa7 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,10 @@ -# Minecraft Bot +# Mosfet Minecraft Bot + +A general-purpose Minecraft 1.16 bot written in Python. + +Mosfet is able to farm wood by cutting trees, gather sand, gather netherwart, +and trade with villagers to get emeralds. He can eat, sleep, and flee from +threats. ## Setup @@ -24,15 +30,17 @@ Always make sure the virtual environment is running `(env)`. (env) $ USERNAME=you@domain.com PASSWORD=supersecret SERVER=example.com python main.py ``` - - - ## Commands -Talking to bot (All commands can be found in "game.py" under "public commands", starting around line 494) +The command prefix character is the last character of the bot's name. For +example, if the bot's name is `mosfet1`, then you would issue commands like +`1farm wood` or `1pos`. This lets you run multiple bots on the same server. -Use prefix (in this case, "1") to call to attention before giving command. (EX. 1ping, 1here, etc.) +The exception are the below public commands, they optionally be prefixed with `!` +and all bots will run the command. +Commands can be issued in public chat or private message like `/msg mosfet1 +1farm wood`. The bot will reply the same way the command was issued. ### Public Commands @@ -142,3 +150,17 @@ These dangerous commands can only be ran by the bot owner. `1exit` - exits the program + +## License + +This program is free and open-source software licensed under the MIT License. +Please see the `LICENSE` file for details. + +That means you have the right to study, change, and distribute the software and +source code to anyone and for any purpose. You deserve these rights. Please take +advantage of them because I like pull requests and would love to see this code +put to use. + +## Acknowledgements + +Thanks to Isaia and the devs behind pyCraft.