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

readme

Browse Source
This commit is contained in:
iou1name 2019-06-15 14:54:12 -04:00
parent 6ec11def3e
commit bc441ce6bd
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -21,6 +21,7 @@ __actions__
* `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. By default, the old version of the mod will be moved to another folder `old_mods`. If `--delete` is passed, it be deleted instead. * `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. By default, the old version of the mod will be moved to another folder `old_mods`. If `--delete` is passed, it be deleted instead.
* `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.
* `post` Upload the modpack so the remote server specified in `config_master.py`. Note that only mods not currently on the server, or which are of a different version, are sent. A copy of the current database and summary page is also sent. * `post` Upload the modpack so the remote server specified in `config_master.py`. Note that only mods not currently on the server, or which are of a different version, are sent. A copy of the current database and summary page is also sent.
* `remove` Removes a mod from the modpack. `target` must be the url associated with the mod. `--delete` has similar behavior here as noted under `update`.
### Server ### Server
`gunicorn -b localhost:5000 -e SCRIPT_NAME=/overwrought overwrought_server:app` `gunicorn -b localhost:5000 -e SCRIPT_NAME=/overwrought overwrought_server:app`
@ -29,4 +30,4 @@ Use `overwrought_server.py hash` to generate an Argon2 hash of your password. Up
### Slave ### Slave
Copy `overwrought_slave.py` and the matching config file to your `.minecraft/` folder. Edit the config file appropriately. Copy `overwrought_slave.py` and the matching config file to your `.minecraft/` folder. Edit the config file appropriately.
Use `overwrought_slave.py sync` to synchronize the `mods/` folder with the remote server. Use `overwrought_slave.py sync` to synchronize the `mods/` folder with the remote server.
By default, old versions of mods (and any other non-modpack related file found in the `mods/` folder) will be moved to `mods_old/`. `--delete` may be used to delete these files instead eg. `overwrought_slave.py sync --delete`. By default, old versions of mods will be moved to `mods_old/`. `--delete` may be used to delete these files instead eg. `overwrought_slave.py sync --delete`.