From f98fdc3914efa7642b67fddfc9586b328dd42384 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lilian=20J=C3=B3nsd=C3=B3ttir?= Date: Thu, 21 Dec 2023 09:58:42 -0800 Subject: [PATCH] add README generated by a python script because I'd rather write python than markdown --- .readme_generator.py | 36 ++++++++++++++++++++++++++++++++++++ README.md | 16 ++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 .readme_generator.py create mode 100644 README.md diff --git a/.readme_generator.py b/.readme_generator.py new file mode 100644 index 0000000..0f05341 --- /dev/null +++ b/.readme_generator.py @@ -0,0 +1,36 @@ +#!/usr/bin/env python +from json import loads +from os import path, sep, scandir + +OUT_FILE = "README.md" +TITLE = "Celediel's Cave's of Qud Mods" +STEAM_WORKSHOP = "https://steamcommunity.com/sharedfiles/filedetails/?id=" + + +def main(): + manifest = "workshop.json" + + doc = f"# {TITLE}\n\n" + + for dir in scandir(): + found_manifest = dir.path + sep + manifest + if path.exists(found_manifest): + with open(found_manifest) as file: + mod = loads(file.read()) + + doc += f"## {mod['Title']}\n" + doc += str( + f'
\n\n', + ) + doc += f"{mod['Description']}\n\n" + doc += "[Link to the Steam Workshop page]" + doc += f"({STEAM_WORKSHOP}{str(mod["WorkshopId"])})\n\n" + + with open(OUT_FILE, 'w') as file: + file.write(doc) + + +if __name__ == "__main__": + main() diff --git a/README.md b/README.md new file mode 100644 index 0000000..37c85ba --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Celediel's Cave's of Qud Mods + +## Auto Drop Bedding +mod preview
+ +Put out a bedroll when you make camp, if you have one. Also adds the option to lay out bedding to the campfire menu. + +[Link to the Steam Workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=2721168249) + +## Cybernetic Hearing Aid +mod preview
+ +Like the Enhanced Hearing mutation, but a cybernetic. + +[Link to the Steam Workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=2721172552) +