Updating SFA towards 1.0

videlais · Sep 21, 2024 · 81e8a59 · 81e8a59
1 parent d440766
commit 81e8a59
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,12 @@
 # Story Format Archive (SFA)
 
-This is a collection of JSON files storing the files of story formats for Twine beginning with 2015 (Twine 1.4.2).
+This is a flat-file database of JSON files describing story formats for Twine beginning with 2015 (Twine 1.4.2).
 
-Each story format in the collection contains all necessary files and individual software licenses.
+Each official story format in the collection contains all necessary files and individual software licenses. For unofficial story formats, a repository or website is listed.
+
+## SFA: Search
+
+[A simple search](https://videlais.github.io/story-formats-archive/) is provided to help verify entries and general data in the database.
 
 ## Database Base URLs
 
@@ -42,7 +46,9 @@ URL: `/official/twine2/chapbook/1.0.0/`
 
 ### Story Format Properties
 
-Each story format has the following properties:
+### Official
+
+Each official story format has the following properties:
 
 - `name`: (string) Name.
 - `author`: (string) Author(s) of the story format.
@@ -83,6 +89,36 @@ Each story format has the following properties:
 }
 ```
 
+#### Unofficial
+
+Each unofficial story format has the following properties:
+
+- `name`: (string) Name.
+- `author`: (string) Author(s) of the story format.
+- `repo`: (string) GitHub repository or website.
+- `proofing`: (boolean) `true` if story format is for proofing and `false` otherwise.
+- `description`: (string) Summary of story format.
+- `basedOn`: (string) Parent story format it is based on, if any.
+- `files`: Files of the story format.
+
+```json
+{
+    "twine1": [
+        {
+            "name": "DotGraph",
+            "author": "M. C. DeMarco",
+            "version": "2.2.0",
+            "repo": "https://github.com/mcdemarco/dotgraph",
+            "proofing": true,
+            "description": "Displays a graph of your story, with several options for color-coding, clustering, and labeling nodes; it also detects unreachable nodes and terminal leaves",
+            "basedOn": "",
+            "files": [
+            ]
+        }
+    ]
+}
+```
+
 ## Twine 2
 
 Each story format folder contains:

diff --git a/unofficial/index.json b/unofficial/index.json
@@ -3,7 +3,6 @@
         {
 			"name": "DotGraph",
 			"author": "M. C. DeMarco",
-			"version": "2.2.0",
 			"repo": "https://github.com/mcdemarco/dotgraph",
 			"proofing": true,
 			"description": "Displays a graph of your story, with several options for color-coding, clustering, and labeling nodes; it also detects unreachable nodes and terminal leaves",
@@ -24,7 +23,6 @@
         {
 			"name": "Journal",
 			"author": "Leon Arnott",
-			"version": "1.0.0",
 			"repo": "https://www.glorioustrainwrecks.com/node/4997",
 			"proofing": false,
 			"description": "A horizontal variant of the Twine 1 stretchtext story format Jonah",