smileyface/README.md
Mathew Sir Guest the best 1cf9a5e6c4 docs: document supported Python versions and the test matrix
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-05-30 22:49:30 -06:00

58 lines
1.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 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
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](https://docs.astral.sh/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.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