qud-mods/.readme_generator.py
Lilian Jónsdóttir f98fdc3914 add README
generated by a python script
because I'd rather write python than markdown
2023-12-21 09:58:42 -08:00

37 lines
1,012 B
Python

#!/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'<img src="{dir.name}{sep}{mod["ImagePath"]}" '
+ 'alt="mod preview"'
+ ' width="48" height="48" /><br/>\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()