Skip to content

Commit 2823659

Browse files
committed
rename app, compress img, upd import, fix grammar
1 parent 87e734b commit 2823659

File tree

15 files changed

+30
-62
lines changed

15 files changed

+30
-62
lines changed

README.MD

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# Руководство пользователя приложения Twitch-events
1+
# Руководство пользователя приложения Twitch Widgets
22
# Описание
3-
Twitch-events — это консольное приложение предоставляющее дополнительные чат команды и виджеты для стримеров платформы Twitch.
4-
![](https://github.com/raziEiL/twitch-events/blob/master/git-img/0.png "Voting widget demonstarion")
3+
Twitch Widgets — это консольное приложение предоставляющее дополнительные чат команды и виджеты для стримеров платформы Twitch.
4+
![](https://github.com/raziEiL/twitch-widgets/blob/master/git-img/0.png "Voting widget demonstarion")
55
# Особенности
66
* Создание событий: голосование и розыгрыш с помощью чат команд
77
* Виджеты для просмотра прогресса событий и интеграции с OBS
@@ -10,9 +10,9 @@ Twitch-events — это консольное приложение предос
1010
# Установка и запуск
1111
1. Добавьте бота на ваш Twitch канал с помощью [ссылки подключения](https://twitchapps.com/tmi/)
1212
2. Скопируйте сгенерированный пароль авторизации (Twitch Chat OAuth Password)
13-
3. Скачайте [последнюю версию приложения](https://github.com/raziEiL/twitch-events/releases), и откройте любым текстовым редактором файл конфигурации `config.json`
13+
3. Скачайте [последнюю версию приложения](https://github.com/raziEiL/twitch-widgets/releases), и откройте любым текстовым редактором файл конфигурации `config.json`
1414
4. Вставьте ранее скопированный пароль авторизации напротив ключа `password` и напишите название своего канала напротив ключа `login`. Значения обязательно должны быть заключены в двойные кавычки!
15-
5. Запустите приложение `twitch-events`.
15+
5. Запустите приложение `twitch-widgets`.
1616
6. Для просмотра данных перейдите на веб-сайт http://localhost:80. Сайт доступен только на вашей локальной машине и не "виден" из интернета.
1717

1818
<details>
@@ -91,7 +91,7 @@ Connected to razie1l Twitch channel
9191
|------|----------|------------|
9292
|password|Пароль авторизации (Twitch OAuth)|[Ссылка генерации пароля](https://twitchapps.com/tmi/)<br>*Значение обязательно должно быть заключено в двойные кавычки!*|
9393
|login|Логин Twitch/название канала|*Значение обязательно должно быть заключено в двойные кавычки!*|
94-
|httpPort|Порт для веб-севера|При изменении порта веб-сайт будет достпуен по следующему адресу `http://localhost:ПОРТ`<br>[Решение проблемы недоступности веб-сайта](#веб-сайт-не-доступен)|
94+
|httpPort|Порт для веб-севера|При изменении порта веб-сайт будет доступен по следующему адресу `http://localhost:ПОРТ`<br>[Решение проблемы недоступности веб-сайта](#веб-сайт-не-доступен)|
9595
|ircPort|Порт для обмена данными с Twitch|Порт должен быть открыт в фаерволе/брандмауэре и виден из вне|
9696
<details>
9797
<summary>Объект twitch</summary>
@@ -110,7 +110,7 @@ Connected to razie1l Twitch channel
110110
Объект `commands` хранит коллекцию объектов отвечающих за настройку определенной чат команды. Имена ключей вложенных объектов редактировать не разрешается!
111111
| Ключ | Значение | Примечание |
112112
|-|-|-|
113-
|prefix|Символ приставки команд|Подобрная информация в разеде [Команды](#команды)<br>*Значение обязательно должно быть заключено в двойные кавычки!*|
113+
|prefix|Символ приставки команд|Подробная информация в разделе [Команды](#команды)<br>*Значение обязательно должно быть заключено в двойные кавычки!*|
114114
|name|Название команды для её вызова|<br>*Значение обязательно должно быть заключено в двойные кавычки!*|
115115
|admin|При значении `true` команда доступна только стримеру, `false` позволит любому пользователю использовать команду|Не рекомендуется изменять|
116116
<details>
@@ -205,7 +205,7 @@ Connected to razie1l Twitch channel
205205

206206
# Изменение дизайна виджетов через OBS
207207
Для изменения дизайна виджетов отредактируйте поле CSS выбрав `Браузер` в `Источники` OBS.
208-
![](https://github.com/raziEiL/twitch-events/blob/master/git-img/5.png)
208+
![](https://github.com/raziEiL/twitch-widgets/blob/master/git-img/5.png)
209209
## Текст
210210
За цвет текста виджетов отвечает CSS свойства `color`. Для изменения цвета пропишите новое значение `color` в элементе `body` (черный по умолчанию) и в классе `.color-a` для второстепенного цвета (красный по умолчанию). В примере ниже основной текст теперь томатный, а второстепенный бирюзовый.
211211
```css
@@ -216,22 +216,22 @@ body {
216216
color: #008080;
217217
}
218218
```
219-
![](https://github.com/raziEiL/twitch-events/blob/master/git-img/1.png)
219+
![](https://github.com/raziEiL/twitch-widgets/blob/master/git-img/1.png)
220220
## Фон
221221
За фоновый цвет виджетов отвечает CSS свойство `background` элемента `body`. По умолчанию используется белый цвет фона, в примере ниже розовый.
222222
```css
223223
body {
224224
background: hotpink;
225225
}
226226
```
227-
![](https://github.com/raziEiL/twitch-events/blob/master/git-img/2.png)
227+
![](https://github.com/raziEiL/twitch-widgets/blob/master/git-img/2.png)
228228
В этом примере прозрачный фон.
229229
```css
230230
body {
231231
background: rgba(0, 0, 0, 0);
232232
}
233233
```
234-
![](https://github.com/raziEiL/twitch-events/blob/master/git-img/3.png)
234+
![](https://github.com/raziEiL/twitch-widgets/blob/master/git-img/3.png)
235235
## Фон элементов
236236
Некоторые элементы используют класс `.color-bg-a` и `.color-bg-b` для применения цвета фона. Изменим цвет прогресса голосования на зеленый для первого участника и желтый для второго.
237237
```css
@@ -242,7 +242,7 @@ body {
242242
background: yellow;
243243
}
244244
```
245-
![](https://github.com/raziEiL/twitch-events/blob/master/git-img/4.png)
245+
![](https://github.com/raziEiL/twitch-widgets/blob/master/git-img/4.png)
246246
# Как работает приложение
247247
1. При запуске приложения происходит авторизация с Twitch API и предоставляется доступ к чату вашего Twitch канала.
248248
2. На вашем компьютере создается локальный веб-сервер, который по средствам REST API предоставляет данные Twitch обработанные приложением.
@@ -256,7 +256,7 @@ body {
256256
`listen EADDRINUSE: address already in use :::80` - см. [Веб-сайт не доступен](#веб-сайт-не-доступен)
257257
`Configuration file not found in ...` - отсутствует файл конфигурации `config.json`
258258

259-
При наличии других ошибок создайте [Issue](https://github.com/raziEiL/twitch-events/issues) и прикрепите файл `crash.log`
259+
При наличии других ошибок создайте [Issue](https://github.com/raziEiL/twitch-widgets/issues) и прикрепите файл `crash.log`
260260
## Чат команды не работают
261261
Проверьте консоль приложения на наличие сообщений `Failed to connect to Twitch channel` или `Login authentication failed`. При наличии данных сообщения проверьте правильность введенных данных авторизации в файле `config.json` (поля `password` и `login`). Вам может потребоваться сгенерировать пароль авторизации снова (см. раздел [Установка и запуск](#установка-и-запуск)). В случае отсутствии сообщений возможно был поврежден файл конфигурации `config.json`, попробуйте скачать приложение еще раз.
262262
## Веб-сайт не доступен

git-img/0.png

-404 KB
Loading

git-img/1.png

-35.6 KB
Loading

git-img/2.png

-13.1 KB
Loading

git-img/3.png

-78.8 KB
Loading

git-img/4.png

-26.8 KB
Loading

git-img/5.png

-4.92 KB
Loading

package.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"name": "twitch-events",
2+
"name": "twitch-widgets",
33
"version": "1.0.0",
4-
"description": "Provides Twitch chat commands for broadcaster to create custom events",
4+
"description": "Provides Twitch chat commands and web-widgets for broadcasters",
55
"main": "dist/backend/index.js",
66
"scripts": {
77
"start": "node --unhandled-rejections=strict dist/backend/index.js",
8-
"start-pkg": "cd pkg-release && cmd /k twitch-events-win",
8+
"start-pkg": "cd pkg-release && cmd /k twitch-widgets-win",
99
"build": "npm run build-full && npm run build-pkg",
1010
"build-full": "npm run build-front && npm run build-end",
1111
"build-dev": "gulp build-dev && rm -rf dist/backend && tsc --sourceMap true -p tsconfig.dev.json",
@@ -23,7 +23,7 @@
2323
},
2424
"repository": {
2525
"type": "git",
26-
"url": "https://github.com/raziEiL/twitch-events.git"
26+
"url": "https://github.com/raziEiL/twitch-widgets.git"
2727
},
2828
"author": {
2929
"name": "Denis Medvedev (raziEiL)",
@@ -94,8 +94,8 @@
9494
"vinyl-source-stream": "^2.0.0"
9595
},
9696
"dependencies": {
97+
"@raz1el/util": "^1.0.5",
9798
"express": "^4.17.1",
98-
"tmi.js": "^1.5.0",
99-
"ts-raz-util": "^1.0.3"
99+
"tmi.js": "^1.5.0"
100100
}
101-
}
101+
}

src/backend/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import express from "express";
66
import fs from "fs";
77
import path from "path";
88
import tmi from "tmi.js";
9-
import { REGEX_COMMAND_LINE, REGEX_QUOTES } from "ts-raz-util";
9+
import { REGEX_COMMAND_LINE, REGEX_QUOTES } from "@raz1el/util";
1010
import VotePoll from "./src/vote-command";
1111
import Draw from "./src/draw-command";
1212
import { removeCommandPrefix } from "./src/helpers";

src/backend/src/draw-command.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
import { timestamp } from "ts-raz-util";
2-
import { getRandomInt } from "./helpers";
1+
import { timestamp, getRandomInt } from "@raz1el/util";
32
import { DrawData } from "./types";
43
import { config } from "./pkg-config";
54

0 commit comments

Comments
 (0)