diff --git a/IW4MAdmin.Master.pyproj b/IW4MAdmin.Master.pyproj index 61f2133..c8b3d26 100644 --- a/IW4MAdmin.Master.pyproj +++ b/IW4MAdmin.Master.pyproj @@ -42,12 +42,15 @@ IW4MADMIN_AUTH_KEY=devdevdev - + + + + diff --git a/README.md b/README.md new file mode 100644 index 0000000..e69de29 diff --git a/launch.sh b/launch.sh new file mode 100644 index 0000000..c0675f2 --- /dev/null +++ b/launch.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +pyver="$(python3 -V 2>&1 | grep -Po '(?<=Python )(.+)')" +requiredver="3.4" + +if [[ -z "$pyver" ]] +then + echo "Python 3 does not appear to be installed." +else + if [[ $pyver =~ $requiredver ]] + then + echo "Python Version is $pyver" + echo "Installing Requirements..." + pip install -r requirements.txt + python3 runserver.py + else + echo "Minimum Python version required is $requiredver" + fi +fi diff --git a/src/README.md b/src/README.md new file mode 100644 index 0000000..62108e1 --- /dev/null +++ b/src/README.md @@ -0,0 +1,33 @@ +# IW4MAdmin-Master +### Purpose +**IW4MAdmin-Master** is the master list for all running instance of [IW4MAdmin](https://github.com/RaidMax/IW4M-Admin/) +Each **IW4MAdmin** instance sends a heartbeat approximately every 30 seconds which is recieved by this service and stored. +**IW4MAdmin-Master** is also responsible for maintaining the version information and providing current translation strings. + +### Requirements +`Python 3.8.x` or newer + +### Start (local) +```bash +chmod +x launch.sh +./launch.sh +``` + +### Endpoints +Unless otherwise specified, all endpoints return JSON +#### /Health +Health status of the master +#### /Instance +All active instances +#### /Version +Current stable and pre-release version +#### /History +Client and server count history +#### /Localization +Latest translation strings + +### UI +#### Home +Zoomable plot of servers, client, and instance counts over an interval +#### /servers +Simple list of all server information grouped by game name diff --git a/requirements.txt b/src/requirements.txt similarity index 100% rename from requirements.txt rename to src/requirements.txt