From 10649a043cd3f3eb8a8fb07349859333765ffa7f Mon Sep 17 00:00:00 2001 From: Mathew Guest Date: Fri, 15 Nov 2024 05:23:59 -0700 Subject: [PATCH] doc: formatting for gitea md and improvements on usage section --- README.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 51c2aab..28ce41d 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ -SmileyFace UT Server Tool -========================= +# SmileyFace UT Server Tool + See official website, [https://zavage-software.com/portfolio/smileyface](https://zavage-software.com/portfolio/smileyface) for instructions. -Dependencies -============ +# Dependencies * [app_skellington](https;//zavage-software.com/projects/app_skellington) * [appdirs](https://pypi.org/project/appdirs) * [colorlog](https://pypi.org/project/colorlog) @@ -14,8 +13,36 @@ Dependencies Installation ============ Activate your desired python environment or install system-wide with admin privileges. + python setup.py install Usage ====== -(more to come, see the website for some instruction) + +$ ./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 +