Skip to main content
[02/2026] Warning to Customers: Some pages and sections in ‘Features and Pages’ are currently not added, or the information is not fully complete. Please bear with us while we get this sorted. If you require assistance with individual sections of unfinished documentation pages ,contact support.

​
Getting started

Ensure you have the licence for this product, by creating a support ticket
You must enable HTTP Requests and API Services within the Game Settings tab in Roblox Studio. This is located under the Security section. Please ensure this is enabled before opening a ticket with our support team.
1

Add the LuaSIMS bot to your discord server

If you have not already added the discord bot, you can do so here. Please note, that you must be an Administrator of the guild (server) you wish to setup the LuaSIMS bot in
2

Place the file in workspace

After downloading the product file from the licensing message, drag and drop into Workspace under your game
3

Ensure HTTP requests/API services are enabled

Check to make sure your security settings are correct. You can do this by heading to Home in Roblox Studio, then Game Settings
4

Ensure LoadString is enabled

Check to make sure that LoadString is enabled and is correct. You can do this by heading to ServiceScriptSpace in Roblox Studio, then Properties

​
ROBLOX Configuration

Under the LuaSIMS folder provided, there will be a Settings script. Please open it to continue.
An example for configuring your group is below
["APIKey"] = "YOUR_API_KEY", -- API Key 
["SchoolName"] = "jaDevelopment", -- School name
["Domain"] = "jadev.group", -- Domain name for login
["LogoID"] = 0, -- Custom school logo ID
OptionsDescription
APIKeyYour unique licence key to the product. This can be found within your direct messages from LuaSIMS Cloud Bot
SchoolNameYour specific school name
DomainThe unique address for staff to login, this is a cosmetic feature, meaning it can be anything.
LogoIDA designated decal Image ID for your school, appears on all LuaSIMS assets/features
A series of attributes for nametags can be toggled to adjust to your needs
["NametagsEnabled"] = true, -- Toggle nametags being visible
["NametagVariant"] = 2, -- Enter type of screen position (1: Modern, 2: Default)
["StaffIcon"] = true, -- Toggles staff icon above nametag
["IsolationTag"] = true, -- Given when a student is put in isolation
  • To disable one of the above, just change true to false
To disable the gamepass feature, just set the GamepassID to 0 . Otherwise, replace 0 with your gamepass ID if you wish to use this feature.
["NonUniformPass"] = { 
	Enabled = false, 
	GamepassID = 0, 
},
  • To**disable ** the above, just change true to false 
["Isolation"] = {
	["IsolationTeam"] = game:GetService("Teams")["Isolation"], -- Set a designated Team for students to be isolated into
	["ExcludeOnLeave"] = true, -- If student leaves the game mid isolation
},
  1. To make students be sent to a designated isolation team  input the following game:GetService("Teams")["Isolation"]
  2. Toenable or disable exclusion on leave, change true to false. This selects if a student should be excluded from the game if they leave while in isolation
An example for configuring your session data is below
	["SessionData"] = { 
		["Positive"] = { -- Positive points 
			"2 - Respect",
			"2 - Equality",
			"1 - Hardworking",
			"3 - Working well",
		},
		["Negative"] = { -- Negative points 
			"2 - Truancy",
			"1 - Disrespect",
		},
		["Locations"] = { -- locations 
			"Main Building",
			"Physical Education Building",
			"Sixth Form Building",
		},
		["LessonPeriods"] = { 
			"Period:1",  
			"Period:2",
			"Period:3",
			"Period:4",
			"Club & Misc:5",
		},
		["ExclusionTypes"] = {
			"Fighting",
			"Fail Roleplay",
			"Other"
OptionsDescription
PositiveThe reasons behind and the number of points that a student can receive for positive behaviour.
NegativeThe reasons behind and the number of points that a student can receive for negative behaviour.
LocationsThe specific locations that are used when logging behaviour are displayed on the dashboard for logging purposes.
LessonPeriodsThe different periods/lessons for the regular day appear on the behaviour dashboard for logging purposes.
ExclusionTypesThe reasons that senior leadership members can use in order to exclude students.
We recommend you use the specific text formats provided below when setting up this section, however this is optional if this does not suit your needs. 
  • AMOUNTOFPOINTS - Reason- for positive and negative behaviour logging
  •  Title:Number - for lesson period logging

​
Discord Configuration

Work in Progress
We are sorry but due to the Version 2.1.1 LuaSIMS BotTS Rewrite, the bot configuration section for permissions is not able to be viewed via the main support documentation yet. Please create a discord ticket and request for LuaSIMS support on how to setup your permissions (as this is required to make LuaSIMS work)This will be available soon.