v2.0.0b1

Yawning-Titan v2.0.0b1

Yawning-Titan v2.0.0b1 is the first public preview/beta release of the Yawning-Titan GUI! 🙌

🎉 What's New

Yawning-Titan GUI

The Yawning-Titan GUI enables full standard use of Yawning-Titan out-of-the-box. Currently, the the GUI capabilities are:

• Create, save, edit, and remove Game Modes in the GameModeDB.
• Create, save, edit, and remove Networks in the NetworkDB.
• Configure a Yawning-Titan run session.
• Run a Yawning-Titan run session and view all metrics and log outputs.
• Other miscellaneous things like:
  • View documentation.
  • Submit feature request.
  • Submit bug ticket.

⚠️ Known Issues

When choosing networks and game modes in ‘Run session’ page there is currently not a compatibility check between game modes and networks to ensure that only compatible pairs can be used together in a YawningTitanRun.

🛠 Engineering Notes

Beta Release

This is a beta release of the Yawning-Titan GUI. While efforts have been made to squash all bugs, we fully expect there to be one or two little critters still hiding in there!

✨ How to Install & Run

First time installing Yawning-Titan?

Windows

mkdir ~\yawning_titan
cd ~\yawning_titan
python3 -m venv .venv
attrib +h .venv /s /d # Hides the .venv directory
.\.venv\Scripts\activate
mkdir v2.0.0b1
cd v2.0.0b1
git clone https://github.com/dstl/YAWNING-TITAN.git
cd YAWNING-TITAN
git checkout release/2.0.0b1
pip install -e .[dev]

Unix

sudo apt-get install python3-venv
mkdir ~/yawning_titan
cd ~/yawning_titan
python3 -m venv .venv
source .venv/bin/activate
mkdir v2.0.0b1
cd v2.0.0b1
git clone https://github.com/dstl/YAWNING-TITAN.git
cd YAWNING-TITAN
git checkout release/2.0.0b1
pip install -e .[dev]

Updating an existing install?

Windows

cd ~\yawning_titan
.\.venv\Scripts\activate
mkdir v2.0.0b1
cd v2.0.0b1
git clone https://github.com/dstl/YAWNING-TITAN.git
cd YAWNING-TITAN
git checkout release/2.0.0b1
pip install -e .[dev]

Unix

cd ~/yawning_titan
source .venv/bin/activate
mkdir v2.0.0b1
cd v2.0.0b1
git clone https://github.com/dstl/YAWNING-TITAN.git
cd YAWNING-TITAN
git checkout release/2.0.0b1
pip install -e .[dev]

Run the Yawning-Titan GUI

First, we need to reset the default entries in the NetworkDB and GameModeDB:

Windows

cd ~\yawning_titan
.\.venv\Scripts\activate
py  ./v2.0.0b1/YAWNING-TITAN/scripts/reset_network_and_game_mode_db_defaults.py

Unix

cd ~/yawning_titan
source .venv/bin/activate
python ./v2.0.0b1/YAWNING-TITAN/scripts/reset_network_and_game_mode_db_defaults.py

Now with the DBs reset, we can start the Django server:

Windows

cd ~\yawning_titan
.\.venv\Scripts\activate
cd ./v2.0.0b1/YAWNING-TITAN/
py manage.py runserver

Unix

cd ~/yawning_titan
source .venv/bin/activate
cd ./v2.0.0b1/YAWNING-TITAN/
python manage.py runserver

Contributors

• @ChrisMcCarthyDev part of the Yawning-Titan dev team.
• @Rumbelows part of the Yawning-Titan dev team.
• @czar-ec-envitia part of the Yawning-Titan dev team.

Full Changelog: v1.1.1...v2.0.0b1