adb-plugin-welcome/plugin.json at main · AdvancedDiscordBot/adb-plugin-welcome · GitHub

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
{
	"name": "adb-plugin-welcome",
	"displayName": "Welcome",
	"version": "2.1.0",
	"description": "Customizable welcome & goodbye messages with canvas image cards, role-based routing, multi-channel onboarding, social links, buttons, and stats.",
	"author": "DeadIndian",
	"main": "index.js",
	"requiresRestart": false,
	"manifestVersion": 2,
	"process": {
		"model": "pooled",
		"maxExecutionMs": 5000,
		"memoryMb": 128,
		"persistentReason": null
	},
	"capabilities": {
		"storage": ["own-collection"],
		"discord": ["SendMessages", "EmbedLinks", "AttachFiles", "GuildInfo", "ManageRoles"],
		"hooks": ["subscribe"]
	},
	"permissions": {
		"storage": ["own-collection"],
		"discord": ["SendMessages", "EmbedLinks", "AttachFiles", "GuildInfo", "ManageRoles"],
		"hooks": ["subscribe"],
		"network": { "outbound": [] },
		"filesystem": { "read": [], "write": [] },
		"childProcess": false,
		"nativeAddons": false
	},
	"declaredDependencies": [],
	"discordPermissions": ["SendMessages", "EmbedLinks", "AttachFiles", "ManageRoles"],
	"webUi": {
		"memberPages": [
			{
				"path": "/me/join-history",
				"label": "My Join History",
				"icon": "DoorOpen",
				"source": { "model": "joinHistory", "scope": "member", "limit": 1 },
				"view": {
					"type": "stat",
					"stats": [
						{ "field": "joinedAt", "label": "Joined" },
						{ "field": "leftAt", "label": "Last Left" },
						{ "field": "welcomed", "label": "Welcomed" }
					]
				}
			}
		]
	},
	"engines": {
		"core": ">=2.0.0",
		"plugins": { "administration": ">=2.0.0" }
	},
	"settings": {
		"commandPermissions": true,
		"schema": [
			{ "key": "welcomeChannelId", "type": "channel", "label": "Default welcome channel" },
			{ "key": "welcomeMessage", "type": "string", "label": "Default welcome message", "default": "Welcome to the server, {user}! You are member #{memberCount}." },
			{ "key": "goodbyeChannelId", "type": "channel", "label": "Goodbye channel" },
			{ "key": "goodbyeMessage", "type": "string", "label": "Goodbye message", "default": "Goodbye {username}! We will miss you." },
			{ "key": "dmEnabled", "type": "boolean", "label": "Send welcome DM", "default": false },
			{ "key": "cardEnabled", "type": "boolean", "label": "Show welcome image card", "default": false }
		]
	},
	"configSchema": {
		"type": "object",
		"properties": {
			"welcomeChannelId": { "type": "string", "default": "" },
			"welcomeMessage": { "type": "string", "default": "Welcome to the server, {user}! You are member #{memberCount}." },
			"goodbyeChannelId": { "type": "string", "default": "" },
			"goodbyeMessage": { "type": "string", "default": "Goodbye {username}! We will miss you." },
			"dmEnabled": { "type": "boolean", "default": false },
			"cardEnabled": { "type": "boolean", "default": false },
			"channels": {
				"type": "object",
				"properties": {
					"welcome": { "type": "array", "items": { "type": "string" }, "default": [] },
					"goodbye": { "type": "string", "default": "" },
					"rules": { "type": "string", "default": "" },
					"verify": { "type": "string", "default": "" }
				}
			},
			"roleMessages": {
				"type": "array",
				"items": {
					"type": "object",
					"properties": {
						"roleId": { "type": "string" },
						"text": { "type": "string" },
						"channelId": { "type": "string" }
					}
				},
				"default": []
			},
			"backgrounds": {
				"type": "array",
				"items": {
					"type": "object",
					"properties": {
						"id": { "type": "string" },
						"url": { "type": "string" },
						"uploadedBy": { "type": "string" }
					}
				},
				"default": []
			},
			"defaultBackground": { "type": "string", "default": null },
			"roleBackgrounds": { "type": "object", "default": {} },
			"social": {
				"type": "object",
				"properties": {
					"discord": { "type": "string", "default": "" },
					"youtube": { "type": "string", "default": "" },
					"twitter": { "type": "string", "default": "" },
					"website": { "type": "string", "default": "" },
					"github": { "type": "string", "default": "" },
					"twitch": { "type": "string", "default": "" }
				}
			},
			"buttons": {
				"type": "array",
				"items": {
					"type": "object",
					"properties": {
						"label": { "type": "string" },
						"url": { "type": "string" },
						"type": { "type": "string", "enum": ["link", "role"] },
						"roleId": { "type": "string" }
					}
				},
				"default": []
			},
			"embed": {
				"type": "object",
				"properties": {
					"color": { "type": "string", "default": "#5865F2" },
					"title": { "type": "string", "default": "Welcome, {user}!" },
					"description": { "type": "string", "default": "" },
					"footer": { "type": "string", "default": "" },
					"thumbnail": { "type": "string", "default": "user" }
				}
			},
			"stats": {
				"type": "object",
				"properties": {
					"welcomeCount": { "type": "number", "default": 0 },
					"goodbyeCount": { "type": "number", "default": 0 },
					"since": { "type": "string", "default": null },
					"lastMilestone": { "type": "number", "default": 0 }
				}
			}
		}
	}
}