You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 18, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+38-13Lines changed: 38 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -2,35 +2,58 @@
2
2
<imgsrc = "chatoverflow-logo.png"/>
3
3
</p>
4
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, ...
5
+
What if you could **combine** the power of
6
+
-**Chat bots** like *nightbot*, *moobot* and *botler*
7
+
-**Supporting services** like *StreamElements*, *Streamlabs*, *TipeeeStream*, *Loots* and
8
+
-**Social Media** and Chat software, e.g. *Twitter*, *Discord*, *YouTube* etc.
7
9
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
+
with your interactive chat in your livestream. What if you could easily react on events, e.g.
10
11
11
-
One example: Chatbot. Starting with two lines of code:
12
+
- Automatically **share** your new subscribers on twitter
13
+
- Automatically **control** your studio's lighting colors trough chat messages
14
+
- Automatically **post** an user's cheer on your minecraft server
15
+
- Automatically **upload** a youtube video with stream highlights when your stream stops
16
+
17
+
and so much more. We know, there is [IFTTT](https://ifttt.com/). But sometimes, building blocks are to generic and services not optimized for your streaming environment.
18
+
19
+
The alternative: Develop everything by yourself and waste hundreds of hours with API-integration. We already solved this problem for you. This is **Chat Overflow**.
20
+
21
+
## The ChatOverflow Project
22
+
23
+
**Chat Overflow** is a plugin framework, which offers ready-to-use platform integrations for all* major streaming- and social-media-sites.
24
+
25
+
**Chat Overflow** enables you to to level up your stream with by writing simple, platform-independent plugins in java or scala**.
26
+
27
+
It's getting even better: The **Chat Overflow** license allows you to sell your custom plugins, creating new services for other streamers.
28
+
29
+
And it's so easy. Here is all the code to get started with a simple twitch chat bot:
12
30
13
31
```
14
-
twitchChat = require.input.twitchChat(...)
32
+
twitchChat = require.input.twitchChat()
15
33
twitchChat.get.registerMessageHandler(msg => ...)
16
34
```
17
35
18
-
Chat overflow fills the gap between simple but limited services like IFTTT and own from-scratch developed applications.
36
+
**Chat Overflow** fills the gap between simple but limited services like IFTTT and own from-scratch developed applications.
19
37
20
38
*Current development state: **Pre-Alpha***
21
39
22
-
## Chat Overflow Framework
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).
40
+
* There are still missing platforms. This is a open-source project. You can [help](https://github.com/codeoverflow-org/chatoverflow/issues), too!
41
+
** The API is written in java. So, every JVM-compatible language is possible. Java, Scala, Kotlin, ...
42
+
43
+
### Installation / Releases
44
+
Head over to [releases](https://github.com/codeoverflow-org/chatoverflow/releases).
45
+
46
+
Just download the newest zip file, make sure that java is installed and launch the framework.
47
+
48
+
Note, that you'll have to develop your own plugins or search for plugins online (e.g. on our [Discord Server](https://discord.gg/p2HDsme)). **Chat Overflow** is only the framework.
24
49
25
50
### Development
26
51
27
52
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).
28
53
29
54
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).
30
55
31
-
### Usage
32
-
33
-
Chat Overflow releases are not yet available. ETA Q2 2019.
56
+
***Pre-Alpha note***: Please note, that the development workflow and the documentation will be updated soon.
34
57
35
58
### Discord
36
59
@@ -40,4 +63,6 @@ The perfect place if you need help with the framework, found a bug or want to sh
40
63
41
64
### About Code Overflow
42
65
43
-
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).
66
+
Code Overflow started as a coding-livestream project from 3 computer science students @ [KIT, Karlsruhe](http://www.kit.edu/).
67
+
Now, it is a team of free open-source developers, sitting all over the world (really, lol).
68
+
The project is headed by [skate702](http://skate702.de).
0 commit comments