Installation
============

LocationAPI has been included in the `PluginCatalogue <https://github.com/MCDReforged/PluginCatalogue>`__ as an MCDR plugin, so you can get it from there.

Install with MCDR command
-------------------------

Use the following command to install LocationAPI automatically in MCDR console:

.. code-block::

    !!MCDR plg install location_api --confirm

Install manually
----------------

You can get the ``*.mcdr`` plugin packages from:

- `GitHub Releases <https://github.com/Mooling0602/LocationAPI/releases>`__
- `PluginCatalogue Website <https://mcdreforged.com/plugin/location_api>`__

Then put the file example ``LocationAPI-v0.3.0.mcdr`` into the ``/path/to/mcdr_env/plugins`` folder.
Usually, you have to install dependencies this plugin needs.
For MCDR plugins, do the same option that just mentioned.
For Python(PyPI) packages, install them into your Python environment.

Here are dependencies of this plugin:

.. note::

    Assuming you have installed and configured MCDReforged. If not, please first visit the `Docs <https://mcdreforged.com>`__ to install and configure MCDR.

.. list-table::
   :header-rows: 1

   * - MCDR plugins
     - Python(PyPI) packages
   * - `MoolingsRconAPI <https://mcdreforged.com/plugin/moolings_rcon_api>`__
     - `beartype <https://pypi.org/project/beartype>`__
   * -
     - `returns <https://pypi.org/project/returns>`__