gfargo / avorion.space Goto Github PK

A method for AvorionModManager class to store and read mods from the storage*[1].

The method should be able to access the storage by a standard database interface.
The method should be able to write a serialised abstraction of a mod object into the storage.
The method should be able to read a serialised abstraction of a mod object from the storage and return it as object*[2].

*[1] See: "Mod Storage" proposal. Currently a simple shelve is used for local storage.
*[2] See: "Mod Class" proposal.

This tool will run on a server. Exact location relative to repositories does not matter.

Goals

• poll the mod-repository origin for changes.
• pull the changes from origin.
• generate a JSON file based on the folder structure in the mod repository and the contained modfiles.

The resulting JSON should look like the example modlist.json located here.

Spike

It should be able to commit and push the generated file as part of the mod-repository back to origin.

Current implementation uses python.argparse module. It offers simple commands like "-v" for verbose output, standard "--help" page and can easily be expanded. It lives in "avorion_mm_cli.py" and calls appropriate methods of AvorionModManager instance from "avorion_mm.py".

This is a working solution in proposal state and open to discussion.
Also consider a interactive solution and review for cross platform compatibility when doing so.