Geoffrey-Django/GeoffreyApp/docs/source/getting_started.rst

246 lines
6.5 KiB
ReStructuredText
Raw Normal View History

.. _getting_started:
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Getting Started
***************
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
What is a Geoffrey?
-------------------
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
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!
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Information in Geoffrey can be accessed in server ways:
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In-Game through the `Geoffrey Plugin <https://git.canopymc.net/Geoffrey/Geoffrey-MC-Plugin>`__
* Via Discord using the `Geoffrey Bot <https://git.canopymc.net/Geoffrey/Geoffrey-Bot>`__
* Online via the `Geoffrey Django App <https://git.canopymc.net/Geoffrey/Geoffrey-Django>`__
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
.. note::
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
To see all commands for Geoffrey use ``?help`` in Discord or ``/help geoffrey`` in game!
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Types of Locations
------------------
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Locations are places you can visit in-game. There are several kinds in Geoffrey:
2019-09-30 19:19:26 +00:00
2021-07-16 01:33:34 +00:00
* Bases: Basic location for marking where you live
2021-07-16 01:10:33 +00:00
* Shops: A location that can sell items
2021-07-16 01:33:34 +00:00
* Towns: For group builds where multiple people living at a single location
2021-07-16 01:10:33 +00:00
* Markets: A collection of shops
* Public Farms: Locations that produces a resource
* Attractions: Fun locations for minigames, parkour, gambling, etc
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Registering
-----------
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Before you can add things to Geoffrey, you must register.
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In Discord: ``?register``
* In Game: ``/register``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
This allows Geoffrey to link to your MC account.
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Searching in The Database
-------------------------
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Finding a Location Or Player
++++++++++++++++++++++++++++
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
The ``find`` command is used to find bases and shops in Geoffrey. ``find`` searches for both location names and owner names:
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In Discord: ``?find <Query>``
* In Game: ``/find <Query>``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Getting More Info on A Location
+++++++++++++++++++++++++++++++
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Then to find out more info about a location, use ``info``:
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In Discord: ``?info <Location Name>``
* In Game: ``/info <Location Name>``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Finding Items For Sale
++++++++++++++++++++++
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
``selling`` can be used to find items for sale.
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
.. note::
2019-09-30 19:19:26 +00:00
2021-07-16 01:33:34 +00:00
It is better to search for a sub-string of an item name. Example: for ``enderchests`` search ``ender``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In Discord: ``?selling <Item Name>``
* In Game: ``/selling <Item Name>``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Finding Locations Around A Point
++++++++++++++++++++++++++++++++
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
You can also search around a position for locations with ``find_around``:
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In Discord: ``?find_around <X> <Y>``
* In Game: ``/find_around <X> <Y>``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Creating Locations
------------------
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
To add a location, you need to use one of the ``add`` commands. Each location type has its own command. For example to,
2021-07-16 01:33:34 +00:00
add a base you use ``add_base``:
2021-07-16 01:10:33 +00:00
* In Discord: ``?add_base <X> <Y> <Optional Name>``
* In Game: ``/add_base <Optional Name>`` (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 <Tunnel Direction> <Tunnel Number> <Location Name>``
* In Game: ``/add_tunnel <Tunnel Direction> <Tunnel Number> <Location Name>``
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 <X> <Y> <Optional Name>``
* In Game: ``/add_shop <Optional Name>`` (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 <Item Name> <Quantity> <Diamond Price> <Shop Name>``
2021-09-12 20:43:41 +00:00
* In Game: ``/add_item <Item Name> <Quantity> <Diamond Price> <Shop Name>```
2021-07-16 01:10:33 +00:00
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
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Restocking Items
++++++++++++++++
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
The ``selling`` command places items that have been stocked more recently at the top of its results. To restock an item,
2021-07-16 01:33:34 +00:00
you can use the ``restock`` command. This will make sure your listing gets put at the top (for now...):
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In Discord: ``?restock <Item Name> <Shop Name>``
* In Game: ``/restock <Item Name> <Shop Name>``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Example::
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
?restock dirt Cool Shop 123
/restock dirt Cool Shop 123
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
.. 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``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Removing Item Listings
++++++++++++++++++++++
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
If you want to delete an item, you use the ``delete_item`` command:
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In Discord: ``?delete_item <Item Name> <Shop Name>``
* In Game: ``/delete_item <Item Name> <Shop Name>``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Example::
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
?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 <X> <Y> <Optional Name>``
* In Game: ``/add_town <Optional Name>`` (your current location is used)
Adding Residents
++++++++++++++++
Adding residents can be done with ``add_resident``:
* In Discord: ``?add_resident <Resident Username> <Town Name>``
* In Game: ``/add_resident <Resident Username> <Town Name>``
.. 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 <Resident Username> <Town Name>``
* In Game: ``/remove_resident <Resident Username> <Town Name>``
2019-09-30 19:19:26 +00:00
Editing Locations
-----------------
2021-07-16 01:10:33 +00:00
Renaming
++++++++
To rename a location, use ``edit_name``:
* In Discord: ``?edit_name "<New Name>" "<Old Name>"``
* In Game: ``/edit_name "<New Name>" "<Old Name>"``
.. warning::
You must put quotes (``" "``) around both the new name and the old name
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Moving A Location
+++++++++++++++++
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
You can move a location with ``edit_pos``:
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In Discord: ``?edit_pos <X> <Y> <Location Name>``
* In Game: ``/edit_pos <X> <Y> <Location Name>``
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
Editing a Tunnel
++++++++++++++++
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
To change the tunnel of a base, use ``?edit_tunnel``:
2019-09-30 19:19:26 +00:00
2021-07-16 01:10:33 +00:00
* In Discord: ``?edit_tunnel <Tunnel Direction> <Tunnel Number> <Location Name>``
* In Game: ``/edit_tunnel <Tunnel Direction> <Tunnel Number> <Location Name>``
Deleting a Location
+++++++++++++++++++
Things change, and sometimes locations need to be *removed*... you do this using ``delete``:
* In Discord: ``?delete <Location Name>``
* In Game: ``/delete <Location Name>``
2019-09-30 19:19:26 +00:00
2019-09-30 20:18:52 +00:00
Now What?
---------
2021-07-16 01:10:33 +00:00
Make sure to use ``?help`` in Discord or ``/help geoffrey`` in-game to see everything Geoffrey can do!