Plugin Configuration

File locations

Your configuration file (from now on, config.yml) stores general plugin configuration settings.

Platform-related configurations are stored in their respective files (i.e. Twitch-related configuration can be found in the twitch.yml file).
The settings inside the GLOBAL CONFIGURATION section of config.yml can be overriden for each platform in the OVERRIDES section, which is present on all platform YML files. See Global Configuration.

Alert strings are found in the locales.yml file. Feel free to edit them to translate them to your stream language or for further customisation. See Locales for more information.

You may also notice there other plugin files inside the folder. Those files are used internally by the plugin and are not intended to be edited manually. Modify them at your own risk. If you mess anything up, regenerate the files.

Resetting Configuration Files

You may regenerate any of ChatPointsTTV's configuration files by removing or renaming it. When the server starts, if the plugin is unable to find any file it will be created automatically with the default values.

Configuration Files

config.yml

Key	Description	Default
`ENABLE_TWITCH`	Whether the Twitch module should be loaded automatically	`true`
`ENABLE_TIKTOK`	Whether the TikTok module should be loaded automatically	`true`
`HIDE_LOGIN_CODES`	Prevents leaking Device Codes by not showing them in chat and instead requiring additional user action, such as hovering or clicking text, in order to view the code.	`false`
`IGNORE_OFFLINE_STREAMERS`	Whether to ignore all events coming from offline streamers. Allowed values: `true`, `false`	`false`
`LOG_EVENTS`	If enabled, all incoming events will be logged in the server console. Allowed values: `true`, `false`	`true`
`INGAME_ALERTS`	Determines how should events display for players with the broadcast permission. Allowed values: `none`, `chat`, `title`, `all`	`chat`

Global Configuration

Key	Description	Default
`MOB_GLOW`	Whether the event name should be displayed in bold in the in-game alerts. Allowed values: `true`, `false`	`true`
`DISPLAY_NAME_ON_MOB`	If enabled, spawned entities will have a tag with the viewer's username. Allowed values: `true`, `false \|`true`
`COLORS` (`USER_COLOR` & `ACTION_COLOR`)	Set the color for usernames and events for in-game alerts. Allowed values: `AQUA`, `BLACK`, `BLUE`, `DARK_AQUA`, `DARK_BLUE`, `DARK_GRAY`, `DARK_GREEN`, `DARK_PURPLE`, `DARK_RED`, `GOLD`, `GRAY`, `GREEN`, `LIGHT_PURPLE`, `RED`, `WHITE`, `YELLOW`	See template file

twitch.yml

Key	Description
`MANAGE_CHANNEL_POINT_REWARDS`	Show/Hide Channel Point Rewards once the Twitch Module connects/disconnects. Once the action for a Channel Point Reward finishes it automatically marks the redemption as completed in the Twitch Dashboard. (NOTE: this feature only works on rewards created by ChatPointsTTV, due to API Limitations)
`CHANNEL_POINTS_EVENTS`	This section is used to set up Actions for Channel Point Events. See Events and Actions. Actions will need to be inside a list named as the Channel Points Reward.
`FOLLOW_SPAM_PROTECTION`	Enables Follower Log.
`FOLLOW_EVENTS`	This section is used to set up Actions for Follow Events. See Events and Actions. This event type does not need any extra data.
`CHEER_EVENTS`	This section is used to set up Actions for Cheer Events. See Events and Actions. Actions will need to be inside a list named as the minimal Bits needed for the event to run.
`SUB_EVENTS`	This section is used to set up Actions for Subscription Events. See Events and Actions. Actions will need to be inside a list named as `TIER1`, `TIER2`, `TIER3` or `TWITCH_PRIME`.
`GIFT_EVENTS`	This section is used to set up Actions for Subscription Gift Events. See Events and Actions. Actions will need to be inside a list named as the minimal gifted subs needed for the event to run.
`RAID_EVENTS`	This section is used to set up Actions for Raid Events. See Events and Actions. Actions will need to be inside a list named as the minimal viewer needed for the event to run.
`CHAT_BLACKLIST`	Any usernames on this list will be muted from the in-game stream chat. You may use this option to hide any messages from bots that send automated messages or respond to commands.

You may override any global configuration from config.yml for this platform using the commented fields at the end of the file.

tiktok.yml

Key	Description
`EULERSTREAM_API_KEY`	This optional field allows the user to use a free or paid Eulerstream API key
`FOLLOW_SPAM_PROTECTION`	Enables Follower Log.
`FOLLOW_EVENTS`	This section is used to set up Actions for Follow Events. See Events and Actions. This event type does not need any extra data.
`LIKE_EVENTS`	This section is used to set up Actions for Like Events. See Events and Actions. Actions will need to be inside a list named as the minimal Like Combo needed for the event to run.
`GIFT_EVENTS`	This section is used to set up Actions for Gift Events. See Events and Actions Actions will need to be inside a list named as a TikTok LIVE Gift (you can see a list of names here).
`SHARE_EVENTS`	This section is used to set up Actions for LIVE Share Events. See Events and Actions. This event type does not need any extra data.
`CHAT_BLACKLIST`	Any usernames on this list will be muted from the in-game stream chat. You may use this option to hide any messages from bots that send automated messages or respond to commands.

You may override any global configuration from config.yml for this platform using the commented fields at the end of the file.

Event Section Structure

Event sections (which keys end with _EVENTS) are used to configure the behavior of each event type. Depending on the event type, you may include a threshold value or a name before your actions. See the table above to see what events need what.

Some other events, such as Follow and Share, do not need anything else before their actions, so they will look like:

FOLLOW_EVENTS:
  - ACTION 1
  - ACTION 2

Events that need a value, on the other hand, will look like this:

EXAMPLE_EVENTS:
  THRESHOLD / NAME:
    - ACTION 1
    - ACTION 2

To learn more about the different actions and see full real examples of events, see Events and Actions.