From 18b3af3db23d116095c951b95661944c7a350e8b Mon Sep 17 00:00:00 2001
From: Styrr <st.d.koehler@gmail.com>
Date: Fri, 11 Mar 2022 17:15:51 +0100
Subject: [PATCH] remove config.yaml from tracking and add it as example to
 README.md

---
 .gitignore         |  1 +
 README.md          | 39 ++++++++++++++++++++++++++++++++++++++-
 config/config.yaml | 30 ------------------------------
 3 files changed, 39 insertions(+), 31 deletions(-)
 delete mode 100644 config/config.yaml

diff --git a/.gitignore b/.gitignore
index e69de29..948d1b3 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+config/config.yaml
\ No newline at end of file
diff --git a/README.md b/README.md
index 4c7a71c..1630dbc 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,40 @@
 # LootDistributionGenerator
 
-Generates Distribution .json files which are required by the SPT-AKI/Server to spawn loot.
\ No newline at end of file
+Generates Distribution .json files which are required by the SPT-AKI/Server to spawn loot.
+
+# Setup
+
+Requires a config.yaml in /config defining dump and target folders as well as a location  for 7z.exe
+
+````yaml
+---
+tools:
+  7z_exe: 'C:/Program Files/7-Zip/7z.exe'
+server:
+  # SPT-AKI Server location (to store the generated json)
+  location: 'C:/GAMES/SPT_AKI_Dev/Server/'
+  # The map names in the loot dump do not directly corresond to the server database structure, this is the mapping
+  map_directory_mapping_yaml:  map_directory_mapping.yaml
+
+archives:
+  # where we put our sequential dump jsons to be sorted archived, preprocessor will put them into archives
+  source_folder: 'D:/Games/SPT_Dev/map_dumps/12.12/'
+  # here we store the archives with used data
+  target_folder: 'D:/Games/SPT_Dev/map_dumps/12.12_used/'
+  # archive name for map loot dump data
+  loot_filename: loot_dumps.7z
+  # archive name for bot dump data
+  bot_filename: bot_dumps.7z
+  # all dump data is appended into an archive in this folder
+  backup_file: 'D:/Games/SPT_Dev/map_dumps/12.12_unused/complete.7z'
+config:
+  static:
+    # ids for static weapons
+    static_weapon_ids:
+      - 5d52cc5ba4b9367408500062
+      - 5cdeb229d7f00c000e7ce174
+    # we have a separate yaml that defined forced static loot per map
+    forced_static_yaml: forced_static.yaml
+    # known quest items per map for validation
+    forced_loose_yaml: forced_loose.yaml
+````
\ No newline at end of file
diff --git a/config/config.yaml b/config/config.yaml
deleted file mode 100644
index e124b1e..0000000
--- a/config/config.yaml
+++ /dev/null
@@ -1,30 +0,0 @@
----
-tools:
-  7z_exe: 'C:/Program Files/7-Zip/7z.exe'
-server:
-  # SPT-AKI Server location (to store the generated json)
-  location: 'C:/GAMES/SPT_AKI_Dev/Server/'
-  # The map names in the loot dump do not directly corresond to the server database structure, this is the mapping
-  map_directory_mapping_yaml:  map_directory_mapping.yaml
-
-archives:
-  # where we put our sequential dump jsons to be sorted archived, preprocessor will put them into archives
-  source_folder: 'D:/Games/SPT_Dev/map_dumps/12.12/'
-  # here we store the archives with used data
-  target_folder: 'D:/Games/SPT_Dev/map_dumps/12.12_used/'
-  # archive name for map loot dump data
-  loot_filename: loot_dumps.7z
-  # archive name for bot dump data
-  bot_filename: bot_dumps.7z
-  # all dump data is appended into an archive in this folder
-  backup_file: 'D:/Games/SPT_Dev/map_dumps/12.12_unused/complete.7z'
-config:
-  static:
-    # ids for static weapons
-    static_weapon_ids:
-      - 5d52cc5ba4b9367408500062
-      - 5cdeb229d7f00c000e7ce174
-    # we have a separate yaml that defined forced static loot per map
-    forced_static_yaml: forced_static.yaml
-    # known quest items per map for validation
-    forced_loose_yaml: forced_loose.yaml
\ No newline at end of file