forked from Ballsdex-Team/BallsDex-DiscordBot
-
Notifications
You must be signed in to change notification settings - Fork 0
/
json-config-ref.json
154 lines (154 loc) · 6.07 KB
/
json-config-ref.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "Ballsdex configuration",
"description": "Core settings for the Ballsdex Discord bot",
"type": "object",
"required": ["discord-token", "text-prefix", "about", "collectible-name", "bot-name", "players-group-cog-name", "admin-command", "prometheus", "owners"],
"properties": {
"discord-token": {
"description": "The Discord bot token",
"type": "string",
"minLength": 72,
"maxLength": 72
},
"text-prefix": {
"description": "The prefix for old text commands",
"type": "string",
"minLength": 1,
"default": "b."
},
"about": {
"type": "object",
"description": "Information used in /about",
"properties": {
"description": {
"type": "string",
"description": "Defines the beginning of the description of /about. The other parts are automatically generated"
},
"github-link": {
"type": "string",
"description": "A GitHub repository for source code, if using a fork",
"format": "uri"
},
"discord-invite": {
"type": "string",
"description": "A Discord server to link for support",
"pattern": "^https?://(discord.gg|discord(app)?.com/invite)/[a-zA-Z0-9]+$"
},
"terms-of-service": {
"type": "string",
"description": "A link to the terms of service",
"format": "uri"
},
"privacy-policy": {
"type": "string",
"description": "A link to the privacy policy",
"format": "uri"
}
},
"required": ["description", "github-link", "discord-invite", "terms-of-service", "privacy-policy"]
},
"collectible-name": {
"type": "string",
"description": "The name of the collectible, used everywhere except command descriptions. An 's' is appended to the end of this string for pluralization",
"example": "ball"
},
"bot-name": {
"type": "string",
"description": "The name of the bot, used in places such as the /completion command",
"example": "BallsDex"
},
"players-group-cog-name": {
"type": "string",
"description": "Name of the slash command managing the collectibles (list, info, completion...). Do not add a leading slash!",
"example": "balls"
},
"admin-command": {
"type": "object",
"description": "Manages access to the admin command",
"properties": {
"guild-ids": {
"type": ["array", "null"],
"description": "IDs of guilds with the /admin command registered",
"items": {
"type": "integer",
"minimum": 10000000000000000,
"maximum": 99999999999999999999
}
},
"root-role-ids": {
"type": ["array", "null"],
"description": "IDs of roles with full access to /admin",
"items": {
"type": "integer",
"minimum": 10000000000000000,
"maximum": 99999999999999999999
}
},
"admin-role-ids": {
"type": ["array", "null"],
"description": "IDs of roles with partial access to /admin: blacklist control and guilds ownership inspection",
"items": {
"type": "integer",
"minimum": 10000000000000000,
"maximum": 99999999999999999999
}
}
},
"required": ["guild-ids", "root-role-ids", "admin-role-ids"]
},
"prometheus": {
"type": "object",
"description": "Prometheus metrics configuration",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether to enable Prometheus metrics server",
"default": false
},
"host": {
"type": "string",
"description": "Host to bind to",
"default": "0.0.0.0"
},
"port": {
"type": "integer",
"description": "Port to bind to",
"default": 15260
}
}
},
"log-channel": {
"type": ["integer", "null"],
"description": "ID of the channel to log events to",
"minimum": 10000000000000000,
"maximum": 99999999999999999999
},
"owners": {
"type": "object",
"description": "Manages ownership of the bot",
"properties": {
"team-members-are-owners": {
"type": "boolean",
"description": "Whether to consider Discord developer team members as owners",
"default": false
},
"co-owners": {
"type": ["array", "null"],
"description": "IDs of users with ownership",
"items": {
"type": "integer",
"minimum": 10000000000000000,
"maximum": 99999999999999999999
}
}
}
},
"max-favorites": {
"type": "integer",
"default": 50,
"description": "Maximum number of favorite countryballs allowed per player",
"minimum": 0
}
}
}