morgan/Grinch-AP
1
0
Fork 0
mirror of https://github.com/MarioSpore/Grinch-AP.git synced 2025-10-21 20:21:32 -06:00
Code Issues Packages Projects Releases Wiki Activity

api.md: change 'Your World' based on suggestions

Browse Source
This commit is contained in:
black-sliver
2021-10-09 11:28:15 +02:00
parent f1fddac655
commit 0376705e47
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/api.md
View File

@@ -151,9 +151,14 @@ on a single item. It can be used to reject placement of an item there.
### Your World
Your world lives in `world/[world_name]/__init__.py` and is a class that
inherits from `..AutoWorld.World`. The generation progress will automatically
pick it up.
All code for your world implementation should be placed in a python package in
the `/worlds` directory. The starting point for the package is `__init.py__`.
Conventionally, your world class is placed in that file.
World classes must inherit from the `World` class in `/worlds/AutoWorld.py`,
which can be imported as `..AutoWorld.World` from your package.
AP will pick up your world automatically due to the `AutoWorld` implementation.
### Requirements