smileyface/README.md
Mathew Sir Guest the best 4b3e4d1e52 docs: add CLAUDE.md guidance and refresh README
Document the project overview, commands, code style, and architecture
in CLAUDE.md, update the README for the Poetry/Click workflow, and add
local Claude Code permission settings.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-05-30 21:25:09 -06:00

48 lines
1.6 KiB
Markdown

# SmileyFace UT Server Tool
See official website, [https://zavage-software.com/portfolio/smileyface](https://zavage-software.com/portfolio/smileyface) for instructions.
# Dependencies
* [pydantic-settings](https://docs.pydantic.dev/latest/concepts/pydantic_settings/)
* [click](https://click.palletsprojects.com)
* [platformdirs](https://pypi.org/project/platformdirs)
* [selenium](https://selenium-python.readthedocs.io)
* [sqlparse](https://pypi.org/project/sqlparse)
Installation
============
Activate your desired python environment, then:
poetry install
Usage
======
$ ./smileyface.py -h
usage: smileyface.py [-h] command ...
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
optional arguments:
-h, --help show this help message and exit
Invalid command. Try -h for usage
# Contact
* mat@zavage.net