mirror of
https://git.zavage.net/Zavage-Software/smileyface.git
synced 2026-06-25 18:12:48 -06:00
docs: replace stale argparse usage dump with Click command reference
The Usage section showed the old argparse `./smileyface.py -h` output (underscored command names, 'optional arguments', a stray 'Invalid command' line) from before the Click rewrite. Replace it with the actual Click command list - server build/deploy commands and the scrape subgroup - plus a note on env/.env configuration. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
parent
a2d4b334d7
commit
bb7325008b
51
README.md
51
README.md
@ -27,30 +27,39 @@ To run the matrix locally (requires [uv](https://docs.astral.sh/uv/)):
|
|||||||
|
|
||||||
Usage
|
Usage
|
||||||
======
|
======
|
||||||
|
SmileyFace exposes a [Click](https://click.palletsprojects.com) CLI. List all
|
||||||
|
commands and options with:
|
||||||
|
|
||||||
$ ./smileyface.py -h
|
python smileyface.py --help
|
||||||
usage: smileyface.py [-h] command ...
|
|
||||||
|
|
||||||
positional arguments:
|
Show help for a specific command:
|
||||||
command
|
|
||||||
clean_instance Deletes the generated instance on the local machine.
|
|
||||||
create_directories Create required directories which the user installs maps, mutators, and config to.
|
|
||||||
download_linux_server
|
|
||||||
Download the latest Linux Unreal Tournament 4 Server from Epic
|
|
||||||
download_logs Download the logs from the target hub.
|
|
||||||
generate_instance Takes the current coniguration and outputs the application files which can be copied
|
|
||||||
to the server.
|
|
||||||
oneclickdeploy
|
|
||||||
restart_server
|
|
||||||
start_server Flip on the target hub on for Fragging.
|
|
||||||
stop_server Stop UT4 Hub processes on the server.
|
|
||||||
upload_redirects Upload paks to redirect server.
|
|
||||||
upload_server Upload all required game files to the hub server.
|
|
||||||
scrape sub-submenu help
|
|
||||||
|
|
||||||
optional arguments:
|
python smileyface.py generate-instance --help
|
||||||
-h, --help show this help message and exit
|
|
||||||
Invalid command. Try -h for usage
|
Server build & deploy commands:
|
||||||
|
|
||||||
|
oneclickdeploy Generate instance, upload redirects, and upload server.
|
||||||
|
generate-instance Build local server instance from current configuration.
|
||||||
|
upload-redirects Upload paks to the redirect server.
|
||||||
|
upload-server Upload game files to the hub server.
|
||||||
|
clean-instance Delete the generated instance on the local machine.
|
||||||
|
create-directories Create required directories for maps, mutators, and config.
|
||||||
|
download-linux-server Download the latest Linux UT4 Server from Epic.
|
||||||
|
download-logs Download the logs from the target hub.
|
||||||
|
start-server Start the UT4 server.
|
||||||
|
stop-server Stop the UT4 server.
|
||||||
|
restart-server Restart the UT4 server.
|
||||||
|
|
||||||
|
Content-scraping commands (under the `scrape` subgroup):
|
||||||
|
|
||||||
|
scrape ut4pugs Check ut4pugs.us for latest content.
|
||||||
|
scrape utcc Check utcc.unrealpugs.com for latest content.
|
||||||
|
scrape create-db-table Create database tables.
|
||||||
|
scrape load-md5s Load MD5 checksums from local pak files.
|
||||||
|
scrape print-invalid Print pak files that failed validation.
|
||||||
|
|
||||||
|
Configuration is read from `SMILEYFACE_`-prefixed environment variables or a
|
||||||
|
`.env` file; see `.env.example` for the full list.
|
||||||
|
|
||||||
# Contact
|
# Contact
|
||||||
* mat@zavage.net
|
* mat@zavage.net
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user