🌊Getting started

Please make sure you read all the information provided in this page as all the information is important and will make sure SIMS works.

Roblox Rate-Limiting

Please make sure you don't have any of the following in your experience:

• You don't have any join / leave discord webhook loggers

• You don't have any admin discord webhook loggers

• You don't have any chat discord webhook loggers

If you have any of the provided listed SIMS won't work as functioned and will be rate limited by Roblox servers.

Step 1. Invite the discord link with the provided link in the DM or email and click the blue authorise message. This will add the bot to the server you want.

Bot Invite

Make sure you invite the bot to the same server with the ID you provided in the SIMS Purchase Ticket if not your SIMS Licence won't apply.

Step 2. Add your groups role ids to SIMS using /authrobloxadd in the discord server you added SIMS to.

Step 3. Download the SIMS file from the releases channel from the communications server (if you can't see it please create a support ticket with proof of DM from the SIMS Assistant bot or the Email sent to you.)

Automated setup script

If you would like to use the automated SIMS setup scripts that auto sets up sims use the steps below else skip this section.

Step 1. Copy this script to your clipboard

game.Workspace["SIMS Production V1.1 | CTRL-U"]["ServerScriptService | CTRL-U"].SIMS.Parent = game.ServerScriptService game.Workspace["SIMS Production V1.1 | CTRL-U"]["Teams | CTRL-U"].Isolation.Parent = game.Teams game.Workspace["SIMS Production V1.1 | CTRL-U"]["Workspace | CTRL-U"].IsolationSpawn.Parent = game.Workspace  game.Workspace["SIMS Production V1.1 | CTRL-U"]["ServerScriptService | CTRL-U"]:Destroy() game.Workspace["SIMS Production V1.1 | CTRL-U"]["Teams | CTRL-U"]:Destroygame.Workspace["SIMS Production V1.1 | CTRL-U"]["Workspace | CTRL-U"]:Destroy()

Step 2. Go to studio and paste the script in the command bar at the bottom of your screen in studio.

Step 3. Press enter on your keyboard and you are done, now edit the config settings file within ServerScriptService to your liking

MAKE SURE TO ENABLE LOADSTRING SERVICE AS THE SCRIPT DOESN'T ENABLE IT DUE TO ROBLOX.

Step 4. Place the script into ServerScriptService, it should look like this.

Step 5. Make sure you have LoadStringEnabledset to true in ServerScriptService properties or SIMS won't work.

Step 6. The file explorer should look something like this.

SIMS Tablet

You can put the SIMS tablet anywhere, just make sure staff can access it to use SIMS. If a student get's a hold of the tablet don't worry, it won't let them use it.

Step 7. Edit the settings file for SIMS, an example of the SIMS config file is shown below.

SIMSServer/Settings.lua

return {
	["Branding"] = {
		--[[
		  _                                                         
		 | |                                                        
		 | |_   _  __ _  __ _ _ __ ___  _   _ _ __  __  ___   _ ____
		 | | | | |/ _` |/ _` | '__/ _ \| | | | '_ \ \ \/ / | | |_  /
		 | | |_| | (_| | (_| | | | (_) | |_| | |_) | >  <| |_| |/ / 
		 |_|\__,_|\__,_|\__, |_|  \___/ \__,_| .__(_)_/\_\\__, /___|
		                 __/ |               | |           __/ |    
		                |___/                |_|          |___/     
		--]]
	},
	
	["Configuration"] = {
		["APIKey"] = "YOUR API KEY HERE, REPLACE THIS TEXT",
		
		["Appearance"] = {
			["SchoolName"] = "YOUR SCHOOL NAME HERE, REPLACE THIS TEXT",
			["Domain"] = "YOUR SCHOOL DECOR DOMAIN HERE, REPLACE THIS TEXT",
			["LogoID"] = 0 --// Not currently used
		},
		
		["Plugins"] = {
			["OverheadRP"] = {
				["Enabled"] = true,
				["TeamColour"] = true,
				["RankTag"] = true,
				["IsolationTag"] = true,
			}
		},
		
		["Options"] = {
			["SearchConsole"] = {
				["DisplayStaff"] = true,
			},
		},
		
		["Isolation"] = {
			["Team"] = game.Teams["Isolation"],
			["ExcludeOnLeave"] = true
		},
		
		["Debug"] = false,
		
		["Data"] = {
			--[[
			-- Positive Data Format --
			"[NUMBER OF POINTS] - [REASON]"
			Example: "2 - Respect", this will give you 2 positive points and the reason of "Respect"
			--]]
			["Positive"] = {
				"2 - Respect",
				"2 - Equality",
				"1 - Hardworking",
				"3 - Working well",
			},
			
			--[[
			-- Negative Data Format --
			"[NUMBER OF POINTS] - [REASON]"
			Example: "2 - Truancy", this will give you 2 negative points and the reason of "Truancy"
			--]]
			["Negative"] = {
				"2 - Truancy",
				"1 - Disrespect",
			},
			
			--[[
			-- Locations Data Format --
			"[LOCATION NAME]"
			Example: "Main Building", this will be the Main Building of the school
			--]]
			["Locations"] = {
				"Main Building",
				"PE Building",
				"Six Form Building",
			},
			
			--[[
			--Lesson Period Data Format--
			"[PERIOD NAME]:[PERIOD NUMBER]"
			Example: "Period:1"
			Example: "Club:5"
			--]]
			["LessonPeriods"] = {
				"Period:1",
				"Period:2",
				"Period:3",
				"Period:4",
				"Club & Misc:5",
			},
			
			--[[
			--Exclusion Types Data Format--
			"[REASON]"
			Example: "Fighting"
			Example: "Fail Roleplay"
			--]]
			["ExclusionTypes"] = {
				"Fighting",
				"Fail Roleplay",
				"Other"
			}
		},
	},
}

Step 8. Edit the settings file to your liking, all the references are listed below.

Setting Type	Description	Required
APIKey	Your API key given to you by the SIMS Assistant bot.	true
Appearance	This will be the Appearance of your SIMS Tablet	false
Isolation	This will be the settings for isolation	true
Plugins	These are offlical SIMS plugins that can be turned on and off	false
Options	These are SIMS options for tablet and other general things	false
Debug	SIMS Debug option for development	false

If you are having trouble with setup, please check console then create a support ticket.