Skip to content

Commit

Permalink
Docs: add note for stage_assert_generate to settings api (Archipelago…
Browse files Browse the repository at this point in the history
  • Loading branch information
black-sliver authored Mar 3, 2024
1 parent ef37ee8 commit 57d1fe6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/settings api.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,10 @@ Path to a single file. Automatically resolves as user_path:
Source folder or AP install path on Windows. ~/Archipelago for the AppImage.
Will open a file browser if the file is missing when in GUI mode.

If the file is used in the world's `generate_output`, make sure to add a `stage_assert_generate` that checks if the
file is available, otherwise generation may fail at the very end.
See also [world api.md](https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/world%20api.md#generation).

#### class method validate(cls, path: str)

Override this and raise ValueError if validation fails.
Expand Down

0 comments on commit 57d1fe6

Please sign in to comment.