config docs

ss220club · Feb 2, 2025 · 958ac06 · 958ac06
1 parent 559556e
commit 958ac06
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/app/core/config.py b/app/core/config.py
@@ -23,9 +23,9 @@ def log_defaults(self) -> None:
                 current_value.log_defaults()
 
 class General(CustomBaseModel):
-    project_name: str = "FurFur Central"
-    project_desc: str = "API для объеденения множества серверов SS13 и SS14 в одну систему."
-    project_ver: str = "0.0.1"
+    project_name: str = "Space Station Central"
+    project_desc: str = "API для объеденения множества серверов SS13 и SS14 в одну систему. От него несет вульпой, но он работает."
+    project_ver: str = "0.1.0"
     endpoint_url: str = "http://127.0.0.1:8000"
     favicon_path: str = "app/assets/favicon.png"
 

diff --git a/config_example.toml b/config_example.toml
@@ -9,20 +9,23 @@ pool_size = 10
 overflow = 5
 pool_recycle = 3600
 pool_pre_ping = true
+# Creates tables if they don't exist
 needs_rebuild = true
 
 [oauth]
 client_secret = "12345678"
 client_id = 12345678
 
 [general]
-project_name = "FurFur Central"
-project_desc = "API для объеденения множества серверов SS13 и SS14 в одну систему."
-project_ver = "0.0.1"
+#project_name = "FurFur Central"
+#project_desc = "API для объеденения множества серверов SS13 и SS14 в одну систему."
+#project_ver = "0.1.0"
 endpoint_url = "http://127.0.0.1:8000"
 favicon_path = "app/assets/favicon.png"
 
 [game]
+# Gives these wls on donation of specific tier or above
 donation_wls = ["prime", "devtest"]
 paid_wl_min_tier = 2
+# This user will be the admin for donation wls. Uses internal user id
 bot_id = 1