add README
generated by a python script because I'd rather write python than markdown
This commit is contained in:
parent
3c11046108
commit
f98fdc3914
36
.readme_generator.py
Normal file
36
.readme_generator.py
Normal file
|
@ -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'<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()
|
16
README.md
Normal file
16
README.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# Celediel's Cave's of Qud Mods
|
||||
|
||||
## Auto Drop Bedding
|
||||
<img src="AutoDropBedding/preview.png" alt="mod preview" width="48" height="48" /><br/>
|
||||
|
||||
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
|
||||
<img src="CyberneticHearingAid/preview.png" alt="mod preview" width="48" height="48" /><br/>
|
||||
|
||||
Like the Enhanced Hearing mutation, but a cybernetic.
|
||||
|
||||
[Link to the Steam Workshop page](https://steamcommunity.com/sharedfiles/filedetails/?id=2721172552)
|
||||
|
Loading…
Reference in a new issue