zavage-software/smileyface
1
0
Fork 0
mirror of https://git.zavage.net/Zavage-Software/smileyface.git synced 2026-06-25 18:12:48 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: replace stale argparse usage dump with Click command reference

Browse Source 
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:
Mathew Sir Guest the best 2026-05-31 00:19:30 -06:00
parent a2d4b334d7
commit bb7325008b
1 changed files with 30 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
README.md
View File

@ -27,30 +27,39 @@ To run the matrix locally (requires [uv](https://docs.astral.sh/uv/)):
Usage
======
SmileyFace exposes a [Click](https://click.palletsprojects.com) CLI. List all
commands and options with:
$ ./smileyface.py -h
usage: smileyface.py [-h] command ...
python smileyface.py --help
positional arguments:
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
Show help for a specific command:
optional arguments:
-h, --help show this help message and exit
Invalid command. Try -h for usage
python smileyface.py generate-instance --help
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
* mat@zavage.net