updated readme

doc_update
Joey Hines 2018-09-12 17:21:35 -05:00
parent 4911358dc3
commit 6e03ce3fdf
2 changed files with 51 additions and 3 deletions

View File

@ -1,4 +1,46 @@
Geoffrey (pronounced JOFF-ree) started his life as an inside joke none of you will understand. #Geoffrey: A Discord Bot for Minecraft Servers
At some point, she was to become an airhorn bot. Now, they know where your stuff is. Geoffrey was created to be an information source for base and shop locations on Minecraft severs. The bot mainly tracks
base, shop, and tunnel locations. This allows for users to quickly find each other's builds and find shops selling
goods.
Geoffrey can be used on a Discord server or in a private message with the bot.
##Information
Geoffrey was written in python and uses the [Discord.py rewrite](https://discordpy.readthedocs.io/en/rewrite/)
to interface with Discord and [SQLAlchemy](https://docs.sqlalchemy.org/en/latest/) for database
access.
##Use Case
Say I am a new user and I want to add my base to the database. I would first register with Geoffrey:
```
?register
```
This allows Geoffrey to link your MC name with your Discord account.
I would then be able to add my base to Geoffrey by using the following command:
```
?add_base 500 550
```
Your first base does not need a name, it defaults to "[Username]'s Base"
If I wanted to specify a name, I could do the following:
```
?add_base 500 550 My New Base
```
If you want to rename a base you can do the following (the quotations around the base names are important!):
```
?edit_name "Cool New Name" "Current Name"
```
If you are so done with that base, you could delete it by doing the following:
```
?delete "My Base"
```
Geoffrey can do many more things. Make sure to checkout ?help for all the commands he can do! You can also do
?help [Command] to get more info about a particular command.
Please respect Geoffrey, the bot is very sensitive.

View File

@ -26,6 +26,12 @@ Please respect Geoffrey, the bot is very sensitive.
If have a suggestion or if something is borked, you can PM my ding dong of a creator ZeroHD. If have a suggestion or if something is borked, you can PM my ding dong of a creator ZeroHD.
*You must use ?register before adding things to Geoffrey* *You must use ?register before adding things to Geoffrey*
Basic Use Case:
Adding your first first base:
?add_base 500 300
Adding your second base:
?add_base 500 900 Cool Base Name
''' '''
bad_error_message = 'OOPSIE WOOPSIE!! Uwu We made a fucky wucky!! A wittle fucko boingo! The admins at our ' \ bad_error_message = 'OOPSIE WOOPSIE!! Uwu We made a fucky wucky!! A wittle fucko boingo! The admins at our ' \