Tricky Towers Utils

Tricky Towers Utils is a project that provides some useful utilities related to the Tricky Towers.

Currently, this project provides the following features:

Overlay for live streaming

1. Installation

You can download and unzip the latest version by "TrickyTowersUtils-{version}.zip" on the release page.

2. Configuration

Copy config(example).ini to config.ini on same directory and edit it.
We recommend changing value of the secret_key to random string(like password) on Server section.

3. Usage

3.1. Overlay

Run server.exe and observer.exe.
Open http://127.0.0.1:8082/overlay on your browser to check it works properly. If you changed host and port on configuration file, Use that values.
Use http://127.0.0.1:8082/overlay page appropriately to your broadcasting software(maybe OBS or Xsplit).

You may want to add custom CSS below on broadcasting software to hide background image:

body { background-color: rgba(0, 0, 0, 0); margin: 0px auto; overflow: hidden; }
#overlayContainer .bg { display: none; }

4. General issues

4.1. `server.exe` shuts down as soon as it runs.

You may need to change your hostname to ASCII charactors.

You can check your hostname by following command on console.

hostname

If your hostname contains non-ASCII charactors, you should change your hostname. You can change it by following command on console and REBOOT YOUR MACHINE. (Replace NEW-NAME to what you want)

wmic computersystem where name="%COMPUTERNAME%" rename name="NEW-NAME"

Detail

5. Development

This section is for developers, not end users.

5.1. Requirements

Git, Python 3.7, Pipenv, Node v10.15.1 and yarn

5.2. Installation

git clone https://github.com/rishubil/TrickyTowersUtils.git
cd TrickyTowersUtils
pipenv install
yarn install --dev

5.3. Build

build.bat

5.4. Run for testing

Overlay(Front-end):

pipenv run web

Server:

pipenv run server

Observer:

pipenv run observer

6. License

MIT

rishubil/TrickyTowersUtils