TourneyViewer (WIP)

English

TourneyViewer is a project for tournament organizers on the startgg platform that allows you to run a widget to display the actual tournament grid live (for example, using OBS).

Using the open API startgg, the program receives data about the tournament grid of the group stage, processes the data and displays it on the page located on the local host of the program.

If you want to help the project, suggest ideas and developments in your pull requests.

To be realized in the future

the normal view of the page;

Features

Single and double elimination tournament formats are supported;
Update widget every 1 minute;

Getting Started

Installing

You need to get:

developer token for startgg; How get?
id the phaseGroup(bracket) of your tournament;

For example:
https://www.start.gg/tournament/wild-hunters-1/event/main-online-crossplatform-event/brackets/1724283/2562131

id the phaseGroup(bracket) -> 2562131

Download the finished build and create a config folder in the directory.
- Create file config.toml
- Copy the template and fill the previously created file with it:
```
phaseGroupId = "your id"
token = "your token"
```

Usage

Change file config/viewer.css to custumization bracket;
Start the project;
Go to the website to check localhost:7777
Use the widget anywhere. Enjoy the process!

Русский

TourneyViewer - это проект для организаторов турниров на платформе startgg, который позволяет запустить виджет для отображения актуальной турнирной сетки в прямом эфире (например, с помощью OBS).

Используя открытый API startgg, программа получает данные о турнирной сетке группового этапа, обрабатывает их и отображает на странице, расположенной на локальном хосте программы.

Если вы хотите помочь проекту, предлагайте идеи и разработки в pull requests.

Будет реализовано в будущем

нормальный вид страницы;

Особенности

Поддержка форматов Single и double elimination;
Обновление виджета раз в 1 минуту;

Начало работы

Установка

Вам необходимо получить:
- токен разработчика для startgg; Как получить?
- идентификатор(id) на турнирную сетку вашего турнира;
```
К примеру:
https://www.start.gg/tournament/wild-hunters-1/event/main-online-crossplatform-event/brackets/1724283/2562131

идентификатор(id) турнирной сетки -> 2562131
```
Скачайте готовую сборку и создайте папку ``config'' в директории.
- Создайте файл ``config.toml''
- Скопируйте шаблон и заполните им ранее созданный файл:
```
phaseGroupId = "ваш id"
token = "ваш токен"
```

Использование

Измените файл config/viewer.css для кастомизации ветки;
Запустите проект;
Перейдите на сайт, чтобы проверить localhost:7777.
Используйте виджет в любом месте. Наслаждайтесь процессом!

# README