From 086295adbb67c2d229cbd8c18aeb767fe79a1164 Mon Sep 17 00:00:00 2001
From: black-sliver <59490463+black-sliver@users.noreply.github.com>
Date: Mon, 15 Aug 2022 23:47:32 +0200
Subject: [PATCH] AutoWorld: add preliminary .apworld specification (#903)

* AutoWorld: add preliminary .apworld specification

* Doc: apworld specification: fix typo
---
 docs/apworld specification.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
 create mode 100644 docs/apworld specification.md

diff --git a/docs/apworld specification.md b/docs/apworld specification.md
new file mode 100644
index 000000000000..2dcc3f0befc9
--- /dev/null
+++ b/docs/apworld specification.md	
@@ -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.