forked from ArchipelagoMW/Archipelago
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
AutoWorld: add preliminary .apworld specification (ArchipelagoMW#903)
* AutoWorld: add preliminary .apworld specification * Doc: apworld specification: fix typo
- Loading branch information
1 parent
81cf150
commit 086295a
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# apworld Specification | ||
|
||
Archipelago depends on worlds to provide game-specific details like items, locations and output generation. | ||
Those are located in the `worlds/` folder (source) or `<insall dir>/lib/worlds/` (when installed). | ||
See [world api.md](world api.md) for details. | ||
|
||
apworld provides a way to package and ship a world that is not part of the main distribution by placing a `*.apworld` | ||
file into the worlds folder. | ||
|
||
|
||
## File Format | ||
|
||
apworld files are zip archives with the case-sensitive file ending `.apworld`. | ||
The zip has to contain a folder with the same name as the zip, case-sensitive, that contains what would normally be in | ||
the world's folder in `worlds/`. I.e. `worlds/ror2.apworld` containing `ror2/__init__.py`. | ||
|
||
|
||
## Metadata | ||
|
||
No metadata is specified yet. | ||
|
||
|
||
## Extra Data | ||
|
||
The zip can contain arbitrary files in addition what was specified above. |