Skip to content

Commit

Permalink
Tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
iChun committed Aug 2, 2018
1 parent f952d32 commit fea5c98
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 12 deletions.
18 changes: 12 additions & 6 deletions docs/gettingstarted/configs.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
First Launch and Mod Configs
============================
First Launch, Mod Configs and Commands
======================================

Before we get started, I want to make something very clear.

Expand All @@ -11,7 +11,9 @@ CCI also has its own JSON configurations which I will refer to primarily as "con

------------------------------

## The Client Mod Config
## Client

### Mod Config

Mod config options for layers. For the supported layers, leaving the option empty will disable them.

Expand All @@ -32,17 +34,21 @@ General mod config options
| OnlineConfigs | URLs to pull online configs from. These configs will override local configs |


## Client Commands
## Commands

| Command | Description |
|---------|-------------|
| /cci edit | Opens up the config editing GUI |
| /cci reload | Reloads configs and notes from file, reloads online configs |




------------------------------

## The Server Mod Config
## Server

### Mod Config

As mentioned earlier. The Client and Server mod configs differ. Most of the processing is done on the client, but some things need to be done on the server. The server's config is to define who can and cannot do things on the server.

Expand All @@ -54,7 +60,7 @@ General mod config options
| enableBlacklist | Turning this on will convert the whitelist into a blacklist |


## Server Commands
## Commands

| Command | Description |
|---------|-------------|
Expand Down
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ Content Creator Integration Documentation

This is the official documentation for [Content Creator Integration]

This documentation is up to date as of CCI v0.0.20. Contribute to the docs at [GitHub].
This documentation is up to date as of CCI v0.0.20.

Contribute to the docs at [GitHub].

[Content Creator Integration]: http://url.tbd
[GitHub]: https://github.com/iChun/ContentCreatorIntegration-IssuesAndDocumentation
8 changes: 4 additions & 4 deletions docs/whatiscci.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ What is Content Creator Integration?
Content Creator Integration (CCI) is a Minecraft mod made to bridge the gap between content creators/streamers and their viewers, with as much flexibility as possible. Its aim is to allow events, such as subscriptions, tips, chat messages, and the like, to trigger events in within the game, as set by the streamer and/or their mods/editors.

It connects to a third party either using a websocket or [Socket.IO](https://socket.io/). At this current moment, it supports the following:
- [Streamlabs](https://streamlabs.com/) (Socket.IO)
- [StreamElements](https://streamelements.com/) (Socket.IO)
- [Twitch](https://www.twitch.tv/) Chat (Websocket)
- [Mixer](https://mixer.com/) Chat (Websocket)
* [Streamlabs](https://streamlabs.com/) (Socket.IO)
* [StreamElements](https://streamelements.com/) (Socket.IO)
* [Twitch](https://www.twitch.tv/) Chat (Websocket)
* [Mixer](https://mixer.com/) Chat (Websocket)

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)!
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ pages:
- Home: 'index.md'
- What is CCI: 'whatiscci.md'
- Getting Started:
- First Launch and Mod Configs: 'gettingstarted/configs.md'
- First Launch, Mod Configs and Commands: 'gettingstarted/configs.md'

# Do not edit in PRs below here
site_name: Content Creator Integration Documentation
Expand Down

0 comments on commit fea5c98

Please sign in to comment.