mirror of https://git.zavage.net/Zavage-Software/smileyface.git synced 2026-06-25 18:12:48 -06:00

Mathew Sir Guest the best bb7325008b 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>

2026-05-31 00:19:30 -06:00

2.4 KiB

Raw Blame History

SmileyFace UT Server Tool

See official website, https://zavage-software.com/portfolio/smileyface for instructions.

Dependencies

Installation

Activate your desired python environment, then:

poetry install

Supported Python Versions

SmileyFace is tested against CPython 3.8 – 3.13. The supported range is enforced by a smoke-test matrix.

To run the matrix locally (requires uv):

uv python install 3.8 3.9 3.10 3.11 3.12 3.13
uv run --with nox nox -s tests

Usage

SmileyFace exposes a Click CLI. List all commands and options with:

python smileyface.py --help

Show help for a specific command:

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

2.4 KiB Raw Blame History Unescape Escape