These are the libraries used
Flask Flask-WTF (easy html form library) PyQt5 (used for chromium web page) Jinja2 (HTML Markup language)
I suggest PyCharm, although any text editor works.
Download python 3
Clone the repo
ensure python is installed (run
python --version, you may need to run
cd TGDKiosk python -m venv venv
On windows run
venv\Scripts\activate.bat in Command Prompt / Powershell
on Mac / Linux run
whenever you want to run the app you must use the virtualenv with the above commands.
pip install -r requirements.txt
now to run the app just type
python app.py which should open the app window.
Creating Game Configs
games are in
/TGDKiosk/static/game_configs/author_title/data.yaml replacing author & title with the author and title of the game.
Format like this
!Game title: title author: author summary: summary group: !Group TGD banner: games/mygame/banner.png path: games/mygame/gameexe.exe disableReview: False
Game files (banner, exe) should go in
/TGDKiosk/static/games/author_title/ replacing author and title with the games author and title.
Create a new venv for this project, install from requirements.txt (it should detect it automatically)
Build / run config you'll want just a regular python script targeting
If you want to modify LESS (Colors and stuff)
Download and install node.js.
go to nodejs and download / install the exe.
for mac use homebrew
open a terminal and run
brew install node
it depends on what distro you're running and if you're using linux I'm sure you can already figure it out. Some are here
npm install -g gulp
open cmd / powershell / terminal and navigate to the TGDKiosk folder
All editing should be done in
semantic/src/site See Semantic-UI Theming