From 25fb1d91fa5bf8e5cf539525fd73257f6754a6cf Mon Sep 17 00:00:00 2001 From: Joey Hines Date: Thu, 15 Jul 2021 19:10:33 -0600 Subject: [PATCH] Updated Getting Started Section --- GeoffreyApp/docs/source/bot_setup.rst | 6 +- GeoffreyApp/docs/source/getting_started.rst | 266 +++++++++++++++----- 2 files changed, 206 insertions(+), 66 deletions(-) diff --git a/GeoffreyApp/docs/source/bot_setup.rst b/GeoffreyApp/docs/source/bot_setup.rst index 5c9d6f5..4bf173d 100644 --- a/GeoffreyApp/docs/source/bot_setup.rst +++ b/GeoffreyApp/docs/source/bot_setup.rst @@ -12,7 +12,7 @@ Installing GeoffreyBot From Source 1. Download GeoffreyBot by cloning it :: - git clone https://git.etztech.xyz/ZeroHD/Geoffrey-DiscordBot.git GeoffreyBot + git clone https://git.canopymc.net/ZeroHD/Geoffrey-DiscordBot.git GeoffreyBot 2. Change directories into `GeoffreyBot` :: @@ -28,10 +28,10 @@ Create A Startup File ********************* Since GeoffreyBot is installed as a module, a small bootstrap program must be used to launch it. The bootstrap program must pass the discord token, the Geoffrey API token and the base url that the GeoffreyApp is running at. An example -can be found `here `__ +can be found `here `__ Create A Service File ********************* In order to start and restart Geoffrey Bot automatically, a Systemd service can be created. An example service file can -be found `here `__ +be found `here `__ diff --git a/GeoffreyApp/docs/source/getting_started.rst b/GeoffreyApp/docs/source/getting_started.rst index 254954e..6cf9ab5 100644 --- a/GeoffreyApp/docs/source/getting_started.rst +++ b/GeoffreyApp/docs/source/getting_started.rst @@ -1,105 +1,245 @@ .. _getting_started: -Geoffrey Bot Quickstart -*********************** +Getting Started +*************** +What is a Geoffrey? +------------------- +Geoffrey is a database for storing information on locations, shops, item listings, farms, etc for Minecraft servers. +It can help you find someone's base, a shop selling an item you need, and much more! -Adding a Location ------------------ -First you must register with the bot if you are a new user:: +Information in Geoffrey can be accessed in server ways: - ?register +* In-Game through the `Geoffrey Plugin `__ +* Via Discord using the `Geoffrey Bot `__ +* Online via the `Geoffrey Django App `__ -This allows Geoffrey to link your MC name with your Discord account. +.. note:: -Then you can add your first base:: + To see all commands for Geoffrey use ``?help`` in Discord or ``/help geoffrey`` in game! -?add_base 500 550 +Types of Locations +------------------ +Locations are places you can visit in-game. There are several kinds in Geoffrey: -Your first base does not need a name, it defaults to "[Username]'s Base" +* Bases: Basic location for marking where you live in Geoffrey +* Shops: A location that can sell items +* Towns: For group builds where multiple people living at a signle location +* Markets: A collection of shops +* Public Farms: Locations that produces a resource +* Attractions: Fun locations for minigames, parkour, gambling, etc -If you want to specify a name:: +Registering +----------- - ?add_base 500 550 My New Base +Before you can add things to Geoffrey, you must register. +* In Discord: ``?register`` +* In Game: ``/register`` -To delete a base:: +This allows Geoffrey to link to your MC account. - ?delete "My Base" - -Adding a shop -------------- -A shop can be added like a base:: - - ?add_shop 500 550 - -or:: - - ?add_shop 500 550 Cool Shop - - -The following command then adds dirt to the shop with the price of 5 dirt for 1 diamond:: - - ?add_item Dirt 5 1 - -The `selling` command sorts by when an object was stocked. To restock an item you can use the following. This will make sure item -returns back to the top of `selling`. Do not abuse this or your shop may be removed. - - ?restock Dirt - -If you want to delete an item you can doby:: - - ?delete_item dirt - -To delete a shop:: - - ?delete "My shop" - - -If you have more than one shop, you need to specify the shop name. - -Searching in the database +Searching in The Database ------------------------- -The ``?find`` command is used to find bases and shops in Geoffrey. ``?find`` searches for both location names and owner names:: - ?find ZeroHD +Finding a Location Or Player +++++++++++++++++++++++++++++ +The ``find`` command is used to find bases and shops in Geoffrey. ``find`` searches for both location names and owner names: -Then to find out more info about a location, use ``?info``:: +* In Discord: ``?find `` +* In Game: ``/find `` - ?info ZeroHD's Base +Getting More Info on A Location ++++++++++++++++++++++++++++++++ +Then to find out more info about a location, use ``info``: +* In Discord: ``?info `` +* In Game: ``/info `` -``?selling`` can be used to find items for sale. Tip is better search for a subset of the item name -ig for `enderchests` search `ender`:: +Finding Items For Sale +++++++++++++++++++++++ - ?selling ender +``selling`` can be used to find items for sale. +.. note:: -You can also search around a position for locations with ``?find_around``:: + It is better search for a sub-string of an item name. Example: for ``enderchests`` search ``ender`` - ?find_around 0 0 +* In Discord: ``?selling `` +* In Game: ``/selling `` + +Finding Locations Around A Point +++++++++++++++++++++++++++++++++ + +You can also search around a position for locations with ``find_around``: + +* In Discord: ``?find_around `` +* In Game: ``/find_around `` + +Creating Locations +------------------ + +To add a location, you need to use one of the ``add`` commands. Each location type has its own command. For example to, +to add a base you use ``add_base``: + +* In Discord: ``?add_base `` +* In Game: ``/add_base `` (your current location is used) + +Example:: + + ?add_base 500 -500 Cool Base 123 + /add_base Cool Base 123 + +.. note:: + + If a name is not provided, the name defaults to ``[Username]'s [Location Type]`` + +Adding A Nether Tunnel +++++++++++++++++++++++ + +Locations can also have a nether tunnel associated with them: + +* In Discord: ``?add_tunnel `` +* In Game: ``/add_tunnel `` + +Example:: + + ?add_tunnel North 155 Cool Base 123 + /add_tunnel North 155 Cool Base 123 + +Shops +----- + +Creating +++++++++ + +A shop can be added like a base: + +* In Discord: ``?add_shop `` +* In Game: ``/add_shop `` (your current location is used) + +Listing An Item For Sale +++++++++++++++++++++++++ + +With the shop created, you can then add then items for sale: + +* In Discord: ``?add_item `` +* In Game: ``/add_shop ``` + +Example of adding a listing for one stack of dirt costing 1 Diamond:: + + ?add_item dirt 64 1 Cool Shop 123 + /add_item dirt 64 1 Cool Shop 123 + +Restocking Items +++++++++++++++++ + +The ``selling`` command places items that have been stocked more recently at the top of its results. To restock an item, +you can use the ``restock`` command. This will make sure you listing gets put at the top (for now...): + +* In Discord: ``?restock `` +* In Game: ``/restock `` + +Example:: + + ?restock dirt Cool Shop 123 + /restock dirt Cool Shop 123 + +.. note:: + You can use Regex to match multiple names and restock many items at once. Example: ``?restock diamond.*`` restocks + all items that begin with ``diamond`` + +Removing Item Listings +++++++++++++++++++++++ + +If you want to delete an item, you use the ``delete_item`` command: + +* In Discord: ``?delete_item `` +* In Game: ``/delete_item `` + +Example:: + + ?delete_item dirt Cool Shop 123 + /delete_item dirt Cool Shop 123 + +Towns +----- + +Towns are essentially bases that can have multiple residents. + +Creating +++++++++ + +A town can be added like any other location: + +* In Discord: ``?add_town `` +* In Game: ``/add_town `` (your current location is used) + +Adding Residents +++++++++++++++++ + +Adding residents can be done with ``add_resident``: + +* In Discord: ``?add_resident `` +* In Game: ``/add_resident `` + +.. note:: + + The resident being added must be registered with Geoffrey! + +Removing Residents +++++++++++++++++++ + +Someone has left your town? You can remove them using ``remove_resident``: + +* In Discord: ``?remove_resident `` +* In Game: ``/remove_resident `` Editing Locations ----------------- -To rename a base/shop you can do the following (the quotations around the location names are important!):: - ?edit_name "Cool New Name" "Current Name" +Renaming +++++++++ +To rename a location, use ``edit_name``: -To move a location's position, use ``?edit_pos``:: +* In Discord: ``?edit_name "" ""`` +* In Game: ``/edit_name "" ""`` - ?edit_pos 420 69 Cool Base +.. warning:: + You must put quotes (``" "``) around both the new name and the old name +Moving A Location ++++++++++++++++++ -To change the tunnel of a base, use ``?edit_tunnel``:: +You can move a location with ``edit_pos``: - ?edit_tunnel North 545 +* In Discord: ``?edit_pos `` +* In Game: ``/edit_pos `` + +Editing a Tunnel +++++++++++++++++ + +To change the tunnel of a base, use ``?edit_tunnel``: + +* In Discord: ``?edit_tunnel `` +* In Game: ``/edit_tunnel `` + +Deleting a Location ++++++++++++++++++++ + +Things change, and sometimes locations need to be *removed*... you do this using ``delete``: + +* In Discord: ``?delete `` +* In Game: ``/delete `` Now What? --------- -Geoffrey has many more commands and uses, do ``?help`` to find out more! + +Make sure to use ``?help`` in Discord or ``/help geoffrey`` in-game to see everything Geoffrey can do! +