Skip to content

Commit b5df0e7

Browse files
committed
Update README.md
1 parent 4d72ec2 commit b5df0e7

1 file changed

Lines changed: 10 additions & 26 deletions

File tree

README.md

Lines changed: 10 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,13 @@
1-
### Description
2-
Cross-platform chat message aggregator for twitch, youtube, goodgame, peka2tv
3-
4-
### Features
5-
* Emoteicons (including BetterTTV, FrankerFaceZ)
6-
* Message highlight, nickname color, user badges
7-
* Viewers counter
8-
* Available 3 skins for now
9-
* Click through the window mode(windows only), window on top mode, borderless window mode
10-
* Ability to hide a message after configurable amount of time
11-
* Ability to display images by link
12-
* Custom emoticons
13-
* Customization
14-
* Turn on/off badges, nickname color, status messages
15-
* Zoom
16-
* Background color
17-
* Template for deleted message
18-
* Window transparency
19-
* Ignore list, moderation
20-
* Ability to clear chat and to temporarily show hidden messages
21-
* Could be captured by OBS Browser, CLR Browser or the same plugins
22-
* Separate configuration for the failchat window and for the OBS Browser(or the same plugins)
23-
* Skin customization via html/css/js
1+
Failchat is a desktop application for streamers. It aggregates chat messages from multiple sources, shows you viewer count, etc.
2+
Detailed description could be found [on the site](https://onoderis.github.io/failchat/).
243

254
### Requirements
26-
Java 8 (recommended update 1.8.0_202)
5+
Java 11 with bundled JavaFX. [Liberica JDK](https://bell-sw.com/pages/downloads/#/java-11-lts) is recommended.
276

28-
### Screenshots
29-
[Imgur album](https://imgur.com/a/AVYzrmo)
7+
### Before you build
8+
Create file `src/main/resources/config/private.properties` with the following properties and replace the values:
9+
```properties
10+
twitch.bot-name = BOT_NAME
11+
twitch.bot-password = BOT_PASSWORD (has prefix "oauth:")
12+
twitch.api-token = API_TOKEN
13+
```

0 commit comments

Comments
 (0)