From 0376705e4733b7bb3f7848f4671978ee007a1ca2 Mon Sep 17 00:00:00 2001 From: black-sliver <59490463+black-sliver@users.noreply.github.com> Date: Sat, 9 Oct 2021 11:28:15 +0200 Subject: [PATCH] api.md: change 'Your World' based on suggestions --- docs/api.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/api.md b/docs/api.md index 95ff32b3..9dfdb37c 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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