-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
700 additions
and
396 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
First Launch | ||
============ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,30 @@ | ||
Content Creator Integration Documentation | ||
========================================= | ||
Content Creator Integration - Documentation | ||
=========================================== | ||
|
||
This is the official documentation for [Content Creator Integration] | ||
Welcome to the official documentation for [Content Creator Integration](https://www.curseforge.com/minecraft/mc-mods/content-creator-integration/). | ||
|
||
This documentation is up to date as of CCI v0.0.20. | ||
This documentation was written based off of version 1.8.0. These docs are aimed to be a reference or a guide for people trying to understand how Content Creator Integration works. | ||
|
||
Contribute to the docs at [GitHub]. | ||
Contribute to the docs at [GitHub](https://github.com/iChun/ContentCreatorIntegration-IssuesAndDocumentation). | ||
|
||
[Content Creator Integration]: http://url.tbd | ||
[GitHub]: https://github.com/iChun/ContentCreatorIntegration-IssuesAndDocumentation | ||
|
||
What is Content Creator Integration? | ||
------------------------------------ | ||
|
||
Content Creator Integration (CCI) is a Minecraft mod made to bridge the gap between content creators/livestreamers and their viewers, with the aim of being as flexible and versatile as possible. It aims to allow stream events (subscriptions, tips, chat messages, etc) to be parsed and acted upon in a sensical and predicable manner. | ||
|
||
CCI works on being primarily [Object-oriented](https://en.wikipedia.org/wiki/Object-oriented_programming), configured by [JSON](https://en.wikipedia.org/wiki/JSON) files to define the fields of said objects. No scripting is required, CCI does all of that for you, though some experience with scripting or programming would be invaluable in understanding the workings of this mod. | ||
|
||
CCI connects to a variety of services using an array of methods, [Socket.IO](https://socket.io/), Websockets, or manually polling. The following services are supported: | ||
|
||
**Socket.IO** | ||
* [Streamlabs](https://streamlabs.com/) | ||
* [StreamElements](https://streamelements.com/) | ||
|
||
**Websocket** | ||
* [Twitch Chat](https://www.twitch.tv/) | ||
|
||
**Polling** | ||
* [YouTube Chat](https://www.youtube.com/) | ||
|
||
More layers of support may be added depending on the demand and the ease of integration. Request them on the [GitHub](https://github.com/iChun/ContentCreatorIntegration-IssuesAndDocumentation)! |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.