Tauticord

Tauticord configuration (v2)

Type object
File match tauticord.yml tauticord.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/tauticord/latest.json
Source https://raw.githubusercontent.com/nwithan8/tauticord/master/.schema/config_v2.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

Properties

Tautulli object required

Settings for the Tautulli instance

5 nested properties
URL hostWithIpAndOptionalPort required

A Tautulli URL

APIKey string required

A Tautulli API key

pattern=^[a-zA-Z0-9]{32}$
UseSelfSignedCert boolean required

Whether to use a self-signed certificate for the Tautulli instance (ignore SSL warnings)

RefreshSeconds integer required

How often, in seconds, the bot pulls new live activity data. A 5-second minimum is built-in; it's for your own good

min=5multipleOf=5
TerminateMessage string required

The message to send when a stream is terminated

Discord object required

Settings for the Discord bot and server

10 nested properties
BotToken string required

A Discord Bot Token

pattern=^[MNO][a-zA-Z0-9_-]{23,25}\.[a-zA-Z0-9_-]{6}\.[a-zA-Z0-9_-]{27,}$
ServerID string required

A Discord server ID

pattern=^[0-9]{17,20}$
AdminIDs discordUserId[] required

The IDs of the Discord users who will have admin permissions

PostSummaryMessage boolean required

Whether to post a summary message in the activity summary channel

AdminChannelName string required

A Discord text channel name. No emojis allowed.

pattern=^[a-z0-9-]{2,100}$
EnableSlashCommands boolean required

Whether to enable slash commands for the bot

PostRecentlyAddedMessage boolean

Whether to post a poster carousel of recently-added content in the announcements channel

PublicChannelName string

A Discord text channel name. No emojis allowed.

pattern=^[a-z0-9-]{2,100}$
EnableTermination boolean

Whether to enable stream termination

StatusMessage object

Settings regarding the bot's Discord status/activity

3 nested properties
Enable boolean

Whether to enable the bot's activity status

CustomMessage string

Display a custom activity status message. Overrides default if not-empty

ShowStreamCount boolean

Whether to display current active stream count in activity status message

Display object required

Settings for how the bot displays information

5 nested properties
Anonymize object required

Settings for anonymizing user information

8 nested properties
HideBandwidth boolean required

Whether to hide bandwidth information

HideETA boolean required

Whether to hide ETAs for streams

HidePlatforms boolean required

Whether to hide stream platform information

HidePlayerNames boolean required

Whether to hide stream player names

HideProgress boolean required

Whether to hide stream progress

HideQuality boolean required

Whether to hide stream quality information

HideTranscode boolean required

Whether to hide stream transcoding information

HideUsernames boolean required

Whether to hide Plex usernames

ServerName string required

The name of the Plex server

ThousandsSeparator string required

The character to use as a numerical thousands separator

Time object required

Settings for how the bot handles time

UseFriendlyNames boolean required

Whether to use Plex user names instead of Plex usernames

Extras object required

Extra settings for the bot

2 nested properties
AllowAnalytics boolean required

Whether to allow the bot to collect and send analytics data

EnableUpdateReminders boolean required

Whether to enable update reminders

Stats object required

Settings for the bot's stat tracking features (via voice channels)

3 nested properties
Activity object required
3 nested properties
CategoryName string required

A Discord category name. No emojis allowed.

pattern=^[a-zA-Z0-9-_ ]{2,100}$
Enable boolean required

Whether to enable activity stats

StatTypes object required

The types of activity stats to track

6 nested properties
Bandwidth object required
LocalBandwidth object required
PlexServerAvailability object required
RemoteBandwidth object required
StreamCount object required
TranscodeCount object required
Libraries object required

Settings for Plex library stats

5 nested properties
Enable boolean required

Whether to enable library stats

CategoryName string required

A Discord category name. No emojis allowed.

pattern=^[a-zA-Z0-9-_ ]{2,100}$
RefreshSeconds integer required

How often, in seconds, the bot pulls new library data. A 5-minute minimum is built-in; it's for your own good

min=300multipleOf=5
Libraries library[] required

Libraries to track

CombinedLibraries combinedLibrary[] required

Combined libraries to track

Performance object required

Settings for performance stats

3 nested properties
CategoryName string required

A Discord category name. No emojis allowed.

pattern=^[a-zA-Z0-9-_ ]{2,100}$
Enable boolean required

Whether to enable performance stats

Metrics object required

The performance metrics to track

4 nested properties
CPU object required
DiskSpace object required
Memory object required
UserCount object required

Definitions

emptyString string
emptyableString emptyString | string
numberZero number
positiveInteger integer
hostWithIpAndOptionalPort string
discordBotToken string

A Discord Bot Token

discordChannelId string

A Discord channel ID

discordUserId string

A Discord user ID

discordServerId string

A Discord server ID

discordTextChannelName string

A Discord text channel name. No emojis allowed.

discordVoiceChannelName string

A Discord voice channel name. No emojis allowed.

discordCategoryName string

A Discord category name. No emojis allowed.

tautulliApiKey string

A Tautulli API key

tautulliUrl string
voiceChannel object
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

recentlyAddedVoiceChannel object
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Hours integer required

The number of hours to look back for recently added items

min=1
library object
Name string required

The name of the library as it appears in Plex

AlternateName discordVoiceChannelName | emptyString required

An alternate name for the library (used as the voice channel name)

ID positiveInteger | numberZero

The ID of the library as it appears in Tautulli. Use if the library name is not unique

Albums object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Artists object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Episodes object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Movies object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Series object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Seasons object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Tracks object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

RecentlyAdded object
5 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Hours integer required

The number of hours to look back for recently added items

min=1
combinedLibrarySubLibrary object
Name string required

The name of the library as it appears in Tautulli

ID positiveInteger | numberZero

The ID of the library as it appears in Tautulli. Use if the library name is not unique

combinedLibrary object
Name discordVoiceChannelName | emptyString required

The name for the combined library (used as the voice channel name)

Libraries combinedLibrarySubLibrary[] required

The libraries to combine

Albums object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Artists object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Episodes object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Movies object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Series object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Seasons object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Tracks object
4 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

RecentlyAdded object
5 nested properties
CustomName discordVoiceChannelName | emptyString required

The custom name to use for the voice channel (overrides the default name)

CustomEmoji string required

The custom emoji to use for the voice channel (overrides the default emoji)

Enable boolean required

Whether to enable the voice channel

VoiceChannelID discordChannelId | numberZero required

The ID of the voice channel

Hours integer required

The number of hours to look back for recently added items

min=1