From 3d0f92f26bbfe3eb5f928d471baf884ce9c85891 Mon Sep 17 00:00:00 2001
From: Michael Green <84688932+michael-j-green@users.noreply.github.com>
Date: Sun, 30 Jun 2024 07:43:51 +1000
Subject: [PATCH] Created Save States (v1.7.4 and later) (markdown)

---
 Save-States-(v1.7.4-and-later).md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 Save-States-(v1.7.4-and-later).md

diff --git a/Save-States-(v1.7.4-and-later).md b/Save-States-(v1.7.4-and-later).md
new file mode 100644
index 0000000..426293f
--- /dev/null
+++ b/Save-States-(v1.7.4-and-later).md
@@ -0,0 +1,28 @@
+When a state is downloaded from the server, the state (savestate.state), screenshot (screenshot.jpg), and a json file (rominfo.json) describing the save state are zipped and downloaded.
+
+The json file description is defined as follows:
+```json
+{
+  "Name": "Super Mario Bros. (1985-09-13)(Nintendo)(JP-US).zip",
+  "StateDateTime": "2024-06-24T05:34:38",
+  "StateName": "",
+  "MD5": "7d158dcd242e77ba249ac8342474aa77",
+  "SHA1": "3d4b04dc78f9d998f17d9fe9ad982a83b5ed72df",
+  "Type": "ROM"
+}
+```
+
+| Attribute | Value |
+| -------- | ------|
+| Name | The name of the ROM that the state belongs to. This is merely a convenience attribute. |
+| StateDateTime | The date and time (in UTC) when the state was initially saved. |
+| StateName | The name of the state |
+| MD5 | The MD5 hash of the ROM that the state belongs to. |
+| SHA1 | The SHA1 hash of the ROM that the state belongs to. |
+| Type | Whether the state belongs to a ROM or ROM Group |
+
+If the zip is re-uploaded, the above json file will be used to automatically match the saved state to the ROM that created it.
+
+If a zip is uploaded without the above three files, the upload will fail.
+
+If a file is uploaded that is not a zip, it will be stored against the currently running ROM and a warning will be displayed that Gaseous was unable to verify that the state belongs to the ROM, and may not function as expected.
\ No newline at end of file