monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Doc: apworlds have to be all lower case 

https://discord.com/channels/731205301247803413/731214280439103580/1094655639600508999
This commit is contained in:
black-sliver 2023-04-09 18:43:39 +02:00
parent bbef7a4cbc
commit 11fdb29357
1 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/apworld specification.md
View File

@ -7,10 +7,12 @@ See [world api.md](world%20api.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` 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 into the worlds folder.
**Warning:** apworlds have to be all lower case, otherwise they raise a bogus Exception when trying to import in frozen python 3.10+!
## File Format ## File Format
apworld files are zip archives with the case-sensitive file ending `.apworld`. apworld files are zip archives, all lower case, with the 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 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`. the world's folder in `worlds/`. I.e. `worlds/ror2.apworld` containing `ror2/__init__.py`.