From 9af76de3d2337f0e628ece2dd96cd477531ba464 Mon Sep 17 00:00:00 2001
From: acidicoala <67734819+acidicoala@users.noreply.github.com>
Date: Tue, 14 Mar 2023 00:35:49 +0400
Subject: [PATCH] Updated Readme [skip ci]

---
 README.adoc              | 57 ++++++++++++++++++++++++++++++++++++----
 res/SmokeAPI.config.json | 24 +++--------------
 2 files changed, 55 insertions(+), 26 deletions(-)

diff --git a/README.adoc b/README.adoc
index f3f6b73..509851d 100644
--- a/README.adoc
+++ b/README.adoc
@@ -60,11 +60,11 @@ Usage of this unlocker entails breaking one or more terms of service, which migh
 
 SmokeAPI supports 2 main modes of installation: *Store* mode and *Game* mode, which are described in the next section.
 
+=== 🛍️ Store mode
+
 NOTE: It is worth noting that the following instructions describe a _manual_ installation method.
 You can benefit from _automatic_ installation and GUI configuration by using https://github.com/acidicoala/Koalageddon2#readme[Koalageddon v2].
 
-=== 🛍️ Store mode
-
 In this installation mode, SmokeAPI is loaded into the Steam process, which makes it able to affect all Steam games.
 
 :steam-dir: the Steam directoryfootnote:fn-steam-dir[The root directory where Steam is installed]
@@ -172,7 +172,7 @@ Default::: `{}`
 Possible values::: An object with key-value pairs, where the key corresponds to the app ID, and value to the app status.
 Possible app status values are defined in the `default_app_status` option.
 Furthermore, it is possible to lock even the legitimately locked DLCs by setting the corresponding app status value to `locked`.
-Type::: Object (Map of String to String)
+Type::: Object
 Default::: `{}`
 
 `auto_inject_inventory`:: Toggles whether SmokeAPI should automatically inject a list of all registered inventory items, when a game queries user inventory
@@ -201,7 +201,7 @@ Default::: `2`
 [horizontal]
 Possible values::: An object with key-value pairs, where the key corresponds to the app ID, and value to the object that contains DLC IDs.
 The format is the same as in the aforementioned GitHub config.
-Type::: Object (Map of String to Object)
+Type::: Object
 Default::: `{}`
 
 `store_config`:: *_Store mode only_*.
@@ -210,9 +210,56 @@ It will override the config fetched from {steam_config}[remote source] or local
 Do not modify this value unless you know what you are doing.
 +
 [horizontal]
-Type::: Object (Map of String to Integer)
+Type::: Object
 Default::: See {steam_config}[online config]
 
+.Complete example
+
+[%collapsible]
+====
+[source,json]
+----
+{
+  "$version": 2,
+  "logging": true,
+  "unlock_family_sharing": true,
+  "default_app_status": "unlocked",
+  "override_app_status": {
+    "1234": "original",
+    "4321": "unlocked"
+  },
+  "override_dlc_status": {
+    "1234": "original",
+    "4321": "unlocked",
+    "5678": "locked"
+  },
+  "auto_inject_inventory": true,
+  "extra_inventory_items": [],
+  "extra_dlcs": {
+    "1234": {
+      "dlcs": {
+        "56789": "Example DLC 1"
+      }
+    },
+    "4321": {
+      "dlcs": {
+        "98765": "Example DLC 2",
+        "98766": "Example DLC 3"
+      }
+    }
+  },
+  "store_config": {
+      "client_engine_steam_client_internal_ordinal": 12,
+      "steam_client_internal_interface_selector_ordinal": 18,
+      "vstdlib_callback_address_offset": 20,
+      "vstdlib_callback_data_offset": 0,
+      "vstdlib_callback_interceptor_address_offset": 1,
+      "vstdlib_callback_name_offset": 4
+  }
+}
+----
+====
+
 == Extra info
 
 === How SmokeAPI works in games with large number of DLCs
diff --git a/res/SmokeAPI.config.json b/res/SmokeAPI.config.json
index ce29d6c..f6c4406 100644
--- a/res/SmokeAPI.config.json
+++ b/res/SmokeAPI.config.json
@@ -3,28 +3,10 @@
   "logging": true,
   "unlock_family_sharing": true,
   "default_app_status": "unlocked",
-  "override_app_status": {
-    "1234": "original",
-    "4321": "unlocked"
-  },
-  "override_dlc_status": {
-    "1234": "original",
-    "4321": "unlocked",
-    "5678": "locked"
-  },
+  "override_app_status": {},
+  "override_dlc_status": {},
   "auto_inject_inventory": true,
   "extra_inventory_items": [],
-  "extra_dlcs": {
-    "1234": {
-      "dlcs": {
-        "56789": "Example DLC 1"
-      }
-    },
-    "4321": {
-      "dlcs": {
-        "98765": "Example DLC 2"
-      }
-    }
-  },
+  "extra_dlcs": {},
   "store_config": null
 }