iou1name/Overwrought
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

read me

Browse Source
This commit is contained in:
iou1name 2019-06-02 19:04:12 -04:00
parent 7ac8c364d1
commit 7286d2d460
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -6,11 +6,12 @@ Python 3.6+
#### Master #### Master
Python packages: `requests bs4` Python packages: `requests bs4`
#### Server #### Server
Python packages: `flask passlib argon2_cffi` Python packages: `flask gunicorn passlib argon2_cffi`
#### Slave #### Slave
Python packages: ` ` Python packages: ` `
## Usage ## Usage
### Master
`$ python3 overwrought_master.py action [options] [target]` `$ python3 overwrought_master.py action [options] [target]`
__actions__ __actions__
* `add` Add a new mod to the modpack. `target` must be a url to a curseforge mod project page. By default, it will prioritize release phases as Release, Beta and then Alpha. `--phase` can alter this. Will always grab the latest version of whichever phase it targets. * `add` Add a new mod to the modpack. `target` must be a url to a curseforge mod project page. By default, it will prioritize release phases as Release, Beta and then Alpha. `--phase` can alter this. Will always grab the latest version of whichever phase it targets.
@ -18,3 +19,5 @@ __actions__
* `update` Update a specific mod in the modpack. `target` must be the url associated with the mod. By default, it will prioritize the release phase previously added. `--phase` can alter this. Will only update if the targeted mod is more recent than the one previously downloaded. * `update` Update a specific mod in the modpack. `target` must be the url associated with the mod. By default, it will prioritize the release phase previously added. `--phase` can alter this. Will only update if the targeted mod is more recent than the one previously downloaded.
* `update_all` Update every mod in the modpack. No `target` needed. Will prioritize release phases similar to `update`, however `--phase` will will not affect it. * `update_all` Update every mod in the modpack. No `target` needed. Will prioritize release phases similar to `update`, however `--phase` will will not affect it.
* `summary` Generate a summary page as html. Summary page displays a list of all mods in the modpack and a change log that is updated as changes are made to the modpack. * `summary` Generate a summary page as html. Summary page displays a list of all mods in the modpack and a change log that is updated as changes are made to the modpack.
### Server
`gunicorn -b localhost:5000 -e SCRIPT_NAME=/overwrought overwrought_server:app`