Configuration

Example Config File

We provided you with an example configuration file if needed.

SpawnerConfig

--!strict
local Typings = require(game:GetService'ReplicatedStorage'.Spawner.SpawnerTypings);

--[[

ONLY EDIT THE CONFIG TABLE!

Need help? Visit

https://huxleysales.github.io/docs/spawner/config
or join https://discord.gg/yHH2cynGzD

]]

local config: Typings.Config = {
	theme = {
		title = "My Spawner",
		colorScheme = "dark",
		logoImageId = 9428951785,
	},

	categories = {
		Category1 = {
			title = "Spawn Bus",
			categoryType = "open",
		},
	},

	groupSettings = {
		enabled = false,
		groupId = 16419590,
		minimumSpawnerRank = 0,
		minimumAdminRank = 250,
		allowVipOwnersServerAdmin = false
	},

	webhookSettings = {
		enabled = true,
		receiver = "discord",
		webhookServerUrl = "",
		webhookClientUrl = "",
		bodies = {
			onSpawn = {
				username = "{{spawnerTitle}}",
				embeds = {
					{
						title = "**Bus Spawned**",
						description = "A bus was spawned",
						color = tonumber(0x9acd32),
						author = {
							name = "{{spawnerTitle}}"
						},
						thumbnail = {
							url = "{{userAvatarHeadShot}}"
						},
						fields = {
							{
								name = "Bus Spawned",
								value = "{{busNumber}}",
							},
							{
								name = "Bus Spawned by",
								value = "[{{displayName}} (@{{username}})](https://roblox.com/users/{{userId}}/profile)"
							},
							{
								name = "Bus Spawned at",
								value = "<t:{{timestamp}}> (<t:{{timestamp}}:R>)"
							}
						}
					}
				}
			},
			onDespawn = {
				username = "{{spawnerTitle}}",
				embeds = {
					{
						title = "**Bus Despawned**",
						description = "A bus was despawned",
						author = {
							name = "{{spawnerTitle}}"
						},
						thumbnail = {
							url = "{{userAvatarHeadShot}}"
						},
						color = tonumber(0x3c78d8),
						fields = {
							{
								name = "Bus Despawned",
								value = "{{busNumber}}"
							},
							{
								name = "Bus Despawned by",
								value = "[{{displayName}} (@{{username}})](https://roblox.com/users/{{userId}}/profile)"
							},
							{
								name = "Bus Despawned at",
								value = "<t:{{timestamp}}> (<t:{{timestamp}}:R>)"
							}
						}
					}
				}
			},
			onMessage = {
				username = "{{spawnerTitle}}",
				embeds = {
					{
						title = "**notification Broadcasted**",
						description = "Someone sent a notification!",
						color = tonumber(0x3c78d8),
						author = {
							name = "{{spawnerTitle}}"
						},
						thumbnail = {
							url = "{{userAvatarHeadShot}}"
						},
						fields = {
							{
								name = "notifiction Broadcasted by",
								value = "[{{displayName}} (@{{username}})](https://roblox.com/users/{{userId}}/profile)"
							},
							{
								name = "notification Broadcasted at",
								value = "<t:{{timestamp}}> (<t:{{timestamp}}:R>)"
							},
							{
								name = "notification Type",
								value = "{{messageType}}"
							},
							{
								name = "notification",
								value = "{{message}}"
							}
						}
					}
				}
			},
			onAdmin = {
				username = "{{spawnerTitle}}",
				embeds = {
					{
						title = "**Administrative Action**",
						description = "Someone executed something on the admin panel",
						color = tonumber(0xff4848),
						author = {
							name = "{{spawnerTitle}}"
						},
						fields = {
							{
								name = "Executed by",
								value = "[{{displayName}} (@{{username}})](https://roblox.com/users/{{userId}}/profile)"
							},
							{
								name = "Executed at",
								value = "<t:{{timestamp}}> (<t:{{timestamp}}:R>)"
							},
							{
								name = "Executed towards",
								value = "[{{moderatedDisplayName}} (@{{moderatedUsername}})](https://roblox.com/users/{{moderatedUserId}}/profile)"
							},
							{
								name = "Action",
								value = "{{action}}"
							},
							{
								name = "Reason",
								value = "{{reason}}"
							}
						}
					}
				}
			}
		}
	},

	busModelsLocation = game.ServerStorage.BusModels,
	depsawnonPlayerLeave = false,
	teleportPlayerToBus = false,
	busModelSpawnType = "basic"
}

return config;

Configuration Options

Basic Configuration Options

Name	Description	Type	Value Choices	DefaultValue
theme	Includes all the data for your theme such as a title, custom logo image, and color themes! (Blue & Dark Theme are the best 😎)	ThemeConfig	View this for value choices
categories	Includes all the data about the different categories.	CategoryConfigs	View this for value choices
groupSettings	Includes all the data about your group and group settings for the spawner.	GroupConfig	View this for value choices
webhookSettings	Includes all the data about your webhook settings for the spawner.	WebhookConfig	View this for value choices
busModelsLocation	If you want to add more spawner categories (up-to 3 extra).	Path to Folder	Any folder in game	game.ServerStorage.BusModels
depsawnonPlayerLeave	If you want a spawned bus to despawn when the associated player leaves the game	boolean	true/false	false
teleportPlayerToBus	If you want to teleport a player to their bus when they spawn it	boolean	true/false	false
busModelSpawnType	The method of spawning a bus - if using advanced, see Advanced Spawning	string	"basic"/"advanced"	"basic"

Theme Configuration Options

Name	Description	Type	Value Choices	DefaultValue
title	Includes all the data for your theme such as a title, custom logo image, and color themes! (Blue & Dark Theme are the best 😎)	string	Any string	"My Spawner"
colorScheme	Includes all the data about the different categories.	string	"light"/"dark"/"blue"	"dark"
logoImageId	Includes all the data about your group and group settings for the spawner.	number	Any number	9428951785

Category Configuration Options

Categories

Name	Required	Description	Type
Category1	yes	Includes all the data for Category1	CategoryConfig
Category2	no	Includes all the data for Category2	CategoryConfig
Category3	no	Includes all the data for Category3	CategoryConfig
Category4	no	Includes all the data for Category4	CategoryConfig
Category5	no	Includes all the data for Category4	CategoryConfig

Category

Name	Required	Description	Type	Value Choices	DefaultValue
title	yes	Title of this category	string	Any string	nil unless first - then "Spawn Bus"
categoryType	yes	The Category Type	number	CategoryTypeOption	nil unless first - then "open"
assetId	no	The asset ID to access this category	number	Any number	nil
mypodProduct	no	The Product Name for your mypod hub to access this category	string	Any String	nil
minimumRank	no	Minimum Group Rank to access this category	number	Any number	nil

Group Configuration Options

Name	Description	Type	Value Choices	DefaultValue
enabled	If any of these group features should be used	boolean	true/false	false
groupId	The ID of the Roblox Group	number	Any number	13299030
minimumSpawnerRank	Minimum Group Rank to see the spawner	number	Any number	1
minimumAdminRank	Minimum Group Rank to see the admin panel	number	Any number	255
allowVipOwnersServerAdmin	If VIP Server Owners should see the admin panel	boolean	true/false	false

Webhook Configuration Options

Name	Description	Type	Value Choices	DefaultValue
enabled	If any of these webhook features should be used	boolean	true/false	false
receiver	What system is receiving the webhook (most likely discord)	number		"discord"
webhookServerUrl	The Server/Service URL for the Webhook	string	Any string	""
webhookServerUrl	The Webhook URL	string	Any string	""
bodies	The templates/bodies	[string]:	Any object

bodies

You should not touch the names of the bodies (onSpawn, onMessage, etc...) but you can touch the contents inside of those names.

tip