Skip to content
Permalink
Browse files

Updated readme, added logo.

  • Loading branch information...
sebinside committed Apr 10, 2019
1 parent 054c8f0 commit 41e92ae8cdf4cbaa558ec839499a54b546e57d75
Showing with 28 additions and 7 deletions.
  1. +28 −7 README.md
  2. BIN chatoverflow-logo.png
@@ -1,16 +1,37 @@
# Chat Overflow
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.
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.
<p align="center">
<img src = "chatoverflow-logo.png"/>
</p>

Imagine an [IFTTT](https://ifttt.com/), solely developed for livestreaming.
Living in a event-triggered environment, chat overflow reacts on inputs like twitch chat, sub messages, bits, ...

Looking for a new chat bot, stream overlay or custom lighting in your living room, whenever someone subscribes?
Everything can be developed with the easy-to-use API from the chat overflow framework.

One example: Chatbot. Starting with two lines of code:

```
twitchChat = require.input.twitchChat(...)
twitchChat.get.registerMessageHandler(msg => ...)
```

Chat overflow fills the gap between simple but limited services like IFTTT and own from-scratch developed applications.

*Current development state: **Pre-Alpha***

## Chat Overflow Framework
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).

### Getting Started
### Development

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).

You can find [here](https://github.com/codeoverflow-org/chatoverflow/wiki/The-initialization-process) a brief documentation on the framework processes.
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).

### Development
### Usage

Chat Overflow releases are not yet available. ETA Q2 2019.

### About Code Overflow

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).
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).
BIN +15.1 KB chatoverflow-logo.png
Binary file not shown.

0 comments on commit 41e92ae

Please sign in to comment.
You can’t perform that action at this time.