|
1 |
| -# Chat Overflow |
2 |
| -Chat Overflow is a framework to enable better interaction in livestream events by connecting several inputs and outputs, e.g. chat messages, sub notifications and screen overlays. |
3 |
| -The software is developed by three computer science students @ [KIT, Karlsruhe](http://www.kit.edu/) and is headed by [skate702](http://skate702.de). For more information please visit http://codeoverflow.org. |
| 1 | +<p align="center"> |
| 2 | + <img src = "chatoverflow-logo.png"/> |
| 3 | +</p> |
| 4 | + |
| 5 | +Imagine an [IFTTT](https://ifttt.com/), solely developed for livestreaming. |
| 6 | +Living in a event-triggered environment, chat overflow reacts on inputs like twitch chat, sub messages, bits, ... |
| 7 | + |
| 8 | +Looking for a new chat bot, stream overlay or custom lighting in your living room, whenever someone subscribes? |
| 9 | +Everything can be developed with the easy-to-use API from the chat overflow framework. |
| 10 | + |
| 11 | +One example: Chatbot. Starting with two lines of code: |
| 12 | + |
| 13 | +``` |
| 14 | + twitchChat = require.input.twitchChat(...) |
| 15 | + twitchChat.get.registerMessageHandler(msg => ...) |
| 16 | +``` |
| 17 | + |
| 18 | +Chat overflow fills the gap between simple but limited services like IFTTT and own from-scratch developed applications. |
| 19 | + |
| 20 | +*Current development state: **Pre-Alpha*** |
4 | 21 |
|
5 | 22 | ## Chat Overflow Framework
|
6 | 23 | The framework contains all information to connect to livestream inputs and outputs. Combined with the [API Project](https://github.com/codeoverflow-org/chatoverflow-api), plugins can be executed. They provide defined behavior, e.g. the [public plugins](https://github.com/codeoverflow-org/chatoverflow-plugins).
|
7 | 24 |
|
8 |
| -### Getting Started |
| 25 | +### Development |
9 | 26 |
|
10 | 27 | Start with the [Installation](https://github.com/codeoverflow-org/chatoverflow/wiki/Installation). Then learn more about the [CLI](https://github.com/codeoverflow-org/chatoverflow/wiki/Using-the-CLI).
|
11 | 28 |
|
12 |
| -You can find [here](https://github.com/codeoverflow-org/chatoverflow/wiki/The-initialization-process) a brief documentation on the framework processes. |
| 29 | +Please see the wiki to learn how to code new [platform sources](https://github.com/codeoverflow-org/chatoverflow/wiki/Adding-a-new-platform-source) and new [plugins](https://github.com/codeoverflow-org/chatoverflow/wiki/Writing-a-plugin). |
13 | 30 |
|
14 |
| -### Development |
| 31 | +### Usage |
| 32 | + |
| 33 | +Chat Overflow releases are not yet available. ETA Q2 2019. |
| 34 | + |
| 35 | +### About Code Overflow |
15 | 36 |
|
16 |
| -Please see the wiki to learn how to code new [platform sources](https://github.com/codeoverflow-org/chatoverflow/wiki/Adding-a-new-platform-source) and new [plugins](https://github.com/codeoverflow-org/chatoverflow/wiki/Writing-a-plugin). |
| 37 | +Code Overflow started as a coding-livestream project by three computer science students @ [KIT, Karlsruhe](http://www.kit.edu/) and is headed by [skate702](http://skate702.de). |
0 commit comments