Skip to content

Commit

Permalink
Adds examples of custom integration directory names to Docs (#223)
Browse files Browse the repository at this point in the history
* Adds directory names for custom integrations

* Removes quote
  • Loading branch information
prabhatnagarajan authored Dec 15, 2020
1 parent bcc76f2 commit 6886936
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion docs/integration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,20 @@ Common Errors
Using a Custom Integration from Python
--------------------------------------

Once you have created an integration, you can put it in a folder called ``custom_integrations`` and tell ``retro`` about your custom integration using the ``add_custom_path`` function:
Once you have created an integration, you can put it in a folder called ``custom_integrations``. In particular, your integration directory name should follow the following structure (depending on the rom type):

- ``.md``: ``*-Genesis`` (e.g. ``AddamsFamily-Genesis``)
- ``.sfc``: ``*-Snes`` (e.g. ``AddamsFamily-Snes``)
- ``.nes``: ``*-Nes`` (e.g. ``AddamsFamily-Nes``)
- ``.a26``: ``*-Atari2600`` (e.g. ``Adventure-Atari2600``)
- ``.gb``: ``*-GameBoy`` (e.g. ``AeroStar-GameBoy``)
- ``.gba``: ``*-GbAdvance`` (e.g. ``MarioKart-GbAdvance``)
- ``.gbc``: ``*-GbColor`` (e.g. ``PokemonPinball-GbColor``)
- ``.gg``: ``*-GameGear`` (e.g. ``MortalKombat-GameGear``)
- ``.pce``: ``*-PCEngine`` (e.g. ``SoldierBlade-PCEngine``)
- ``.sms``: ``*-Sms`` (e.g. ``AddamsFamily-Sms``)

Then you can tell ``retro`` about your custom integration using the ``add_custom_path`` function:

.. code-block:: python
Expand Down

0 comments on commit 6886936

Please sign in to comment.