.. role:: raw-html(raw)
    :format: html

Tutorial
=========

.. important::
    Make sure your .ini files meest the following requirements: :doc:`fileRequirements`

.. important::
    Remapping mods is overall a hacky process. Please see :doc:`remapGrading` for the current limitations of remapping your particular mod.

:raw-html:`<br />`

**Choose your pick of which way to run the script:**


  a. :ref:`Choice A: Quickstart! 🟢             (for beginners)<Choice A: Quickstart 🟢>`
  b. :ref:`Choice B: CMD WITHOUT a Script 🟡    (recommended if you run by CMD)<Choice B: Run on CMD Without a Script 🟡>`
  c. :ref:`Choice C: CMD with a Script 🟡       (the convention that other GIMI scripts follow)<Choice C: Run on CMD With a Script 🟡>`
  d. :doc:`Choice D: API 🟠                     (for expert coders)<apiSetup>`


:raw-html:`<br />`
:raw-html:`<br />`

Choice A: Quickstart 🟢
------------------------

STEP 1
~~~~~~

Go to the `Latest Release`_ and click on the ``AGRemap.py`` link to download the script into your Mod's folder or GIMI's `Mod` folder.

STEP 2
~~~~~~

Double click on the script


STEP 3
~~~~~~

Open the game and enjoy it!

:raw-html:`<br />`

----

:raw-html:`<br />`

Choice B: Run on CMD Without a Script 🟡
-----------------------------------------

STEP 1
~~~~~~

Install the module onto your computer by opening `CMD`_ and type:

.. code-block:: bash

    python -m pip install -U AnimeGameRemap


then enter

*( you can now run the program anywhere without copying a script! )*

STEP 2
~~~~~~

Open `CMD`_ in your Mod folder or GIMI's ``Mod`` folder and type:

.. code-block:: bash

    python -m AnimeGameRemap

then enter

STEP 3
~~~~~~
Open the game and enjoy it!

:raw-html:`<br />`

----

:raw-html:`<br />`


Choice C: Run on CMD With a Script 🟡
---------------------------------------

STEP 1
~~~~~~

Go to the `Latest Release`_ and click on the ``AGRemap.py`` link to download the script into your Mod's folder or GIMI's `Mod` folder.


STEP 2
~~~~~~

Open `CMD`_ and type

.. code-block:: bash

    python AGRemap.py

then enter

STEP 3
~~~~~~
Open the game and enjoy it!



.. _CMD: https://www.google.com/search?q=how+to+open+cmd+in+a+folder&oq=how+to+open+cmd
.. _Latest Release: https://github.com/nhok0169/Anime-Game-Remap/releases/latest