// ============================================
// OBBY SYSTEM - README / SETUP GUIDE
// ============================================
// Version: 1.0
//
// This README explains how to set up and customize
// your obby system. Read through all sections below.
// ============================================
TABLE OF CONTENTS
=================
1. Quick Start
2. Checkpoint Setup
3. Configuration
4. Product IDs
5. Gamepasses
6. Rebirth Rewards
7. Troll Products
8. Other requirements
9. Troubleshooting
============================================
1. QUICK START
============================================
To get your obby running:
1. Create a folder in Workspace called "Checkpoints"
2. Add checkpoint models (see section 2)
3. Set your product IDs in Config module
4. Add rebirth tools to ServerStorage (see section 6)
5. Test in Studio!
============================================
2. CHECKPOINT SETUP
============================================
Each checkpoint is a MODEL with this structure:
Workspace.Checkpoints
├── 0 (Model) - Starting spawn point
│ ├── Base (UnionOperation/Part) - Visual platform
│ ├── Touch (Part) - Trigger part with PointLight/Sparkles
│ └── Spawn (SpawnLocation) - Where players teleport to
├── 1 (Model)
│ ├── Base
│ ├── Touch
│ └── Spawn
├── 2 (Model)
│ └── ...
└── 9 (Model) - Final checkpoint
IMPORTANT:
- Checkpoint names MUST be numbers: 0, 1, 2, 3...
- Stage 0 is the spawn/starting point
- Each checkpoint MUST have a "Touch" part (the trigger)
- Each checkpoint MUST have a "Spawn" part (teleport location)
- Checkpoints must be contiguous (no gaps in numbering)
============================================
3. CONFIGURATION
============================================
All configurable values are in: ReplicatedStorage.Modules.Config
Key settings:
- Config.Checkpoints.TouchDebounce = 1
How many seconds between touches (prevents spam)
- Config.Checkpoints.TeleportHeightOffset = 3
How high above spawn point players appear
- Config.Data.MaxStage = 1000
Maximum stage number allowed
- Config.Rebirth.ToolsFolderName = "Rebirth Tools"
Name of folder in ServerStorage containing reward tools
- Config.Debug.EnableLogging = true
Show debug messages in console
============================================
4. PRODUCT IDs
============================================
To set up Robux purchases:
1. Go to: create.roblox.com > Creator Dashboard > Your Game > Passes
2. Create a pass for each product
3. Copy the Product ID (NOT the Gamepass ID)
4. Paste into Config.Products section:
Config.Products = {
SkipStage = 123456789, -- Your product ID here
KillAll = 123456790,
FlingAll = 123456791,
-- etc.
}
NOTE: Product IDs are for consumable purchases (can buy multiple times)
Gamepass IDs are for one-time purchases
============================================
5. GAMEPASSES
============================================
To set up gamepasses:
1. Go to: create.roblox.com > Creator Dashboard > Your Game > Passes
2. Create a pass
3. Copy the Gamepass ID (NOT Product ID)
4. Paste into Config.Gamepasses section:
Config.Gamepasses = {
GravityCoil = {
Id = 123456789, -- Your gamepass ID here
ToolName = "Gravity Coil", -- Must match tool name in Rebirth Tools folder
},
SpeedCoil = {
Id = 123456790,
ToolName = "Speed Coil",
},
-- etc.
}
============================================
6. REBIRTH REWARDS
============================================
When players rebirth, they get a random tool:
1. Create a folder in ServerStorage called "Rebirth Tools"
(Or change Config.Rebirth.ToolsFolderName)
2. Add Tool objects to this folder:
ServerStorage
└── Rebirth Tools
├── Gravity Coil (Tool)
├── Speed Coil (Tool)
└── MagicCarpet (Tool)
3. Tools are given randomly when player rebirths
4. Players can't get duplicates until they own all tools
============================================
7. TROLL PRODUCTS
============================================
Troll products let players pay Robux to affect others:
- KillAll: Kills all players in server
- FlingAll: Flings all players
- FreezeAll: Freezes all players with damage over time
- FireAll: Sets all players on fire
- LaunchAll: Launches all players into the sky
- Jumpscare: Scary visual effect for all players
- RainbowWorld: Changes all part colors randomly
- KillPlayer: Kills a specific targeted player
- FlingPlayer: Flings a specific targeted player
- SlipPlayer: Makes targeted player slip and ragdoll
Settings in Config.TrollSettings:
- BuyerImmune = true -- Buyer is immune to their own troll
- ShowAnnouncements = true -- Show "X bought Y" messages
============================================
8. TROUBLESHOOTING
============================================
Problem: Players not spawning at checkpoints
Solution: Check that each checkpoint has a "Spawn" part
Problem: Checkpoints not working
Solution: Check that "Touch" part exists and has CanCollide = true
Problem: Products not working
Solution: Verify Product IDs (not Gamepass IDs) in Config
Problem: Gamepasses not giving items
Solution: Verify Gamepass IDs and ToolName matches tool in Rebirth Tools
Problem: Rebirth not giving items
Solution: Check ServerStorage has "Rebirth Tools" folder with tools
Problem: Data not saving
Solution: Ensure ProfileService is installed in ServerScriptService.Services
Problem: "No checkpoints found" error
Solution: Check Workspace.Checkpoints folder exists with numbered models
Problem: Nothing is Working
Solution: Make sure the game is published and not in studio
============================================
SUPPORT
============================================
For additional help:
- Check the Config module for all settings
- Enable Config.Debug.EnableLogging to see console messages
- Test in Studio before publishing
============================================
Other
============================================
For additional help:
- IF you have any probems With the System Make Sure To Contact The Me
- PLEASE Do NOT Leak Or give the system to anyone else wihtout my permissoin
- Hope you Enjoy
- Made by: @gasterblaster787388 nickname: Vode
- discord acc: vode_o <-- Contact me
// OBBY SYSTEM - README / SETUP GUIDE
// ============================================
// Version: 1.0
//
// This README explains how to set up and customize
// your obby system. Read through all sections below.
// ============================================
TABLE OF CONTENTS
=================
1. Quick Start
2. Checkpoint Setup
3. Configuration
4. Product IDs
5. Gamepasses
6. Rebirth Rewards
7. Troll Products
8. Other requirements
9. Troubleshooting
============================================
1. QUICK START
============================================
To get your obby running:
1. Create a folder in Workspace called "Checkpoints"
2. Add checkpoint models (see section 2)
3. Set your product IDs in Config module
4. Add rebirth tools to ServerStorage (see section 6)
5. Test in Studio!
============================================
2. CHECKPOINT SETUP
============================================
Each checkpoint is a MODEL with this structure:
Workspace.Checkpoints
├── 0 (Model) - Starting spawn point
│ ├── Base (UnionOperation/Part) - Visual platform
│ ├── Touch (Part) - Trigger part with PointLight/Sparkles
│ └── Spawn (SpawnLocation) - Where players teleport to
├── 1 (Model)
│ ├── Base
│ ├── Touch
│ └── Spawn
├── 2 (Model)
│ └── ...
└── 9 (Model) - Final checkpoint
IMPORTANT:
- Checkpoint names MUST be numbers: 0, 1, 2, 3...
- Stage 0 is the spawn/starting point
- Each checkpoint MUST have a "Touch" part (the trigger)
- Each checkpoint MUST have a "Spawn" part (teleport location)
- Checkpoints must be contiguous (no gaps in numbering)
============================================
3. CONFIGURATION
============================================
All configurable values are in: ReplicatedStorage.Modules.Config
Key settings:
- Config.Checkpoints.TouchDebounce = 1
How many seconds between touches (prevents spam)
- Config.Checkpoints.TeleportHeightOffset = 3
How high above spawn point players appear
- Config.Data.MaxStage = 1000
Maximum stage number allowed
- Config.Rebirth.ToolsFolderName = "Rebirth Tools"
Name of folder in ServerStorage containing reward tools
- Config.Debug.EnableLogging = true
Show debug messages in console
============================================
4. PRODUCT IDs
============================================
To set up Robux purchases:
1. Go to: create.roblox.com > Creator Dashboard > Your Game > Passes
2. Create a pass for each product
3. Copy the Product ID (NOT the Gamepass ID)
4. Paste into Config.Products section:
Config.Products = {
SkipStage = 123456789, -- Your product ID here
KillAll = 123456790,
FlingAll = 123456791,
-- etc.
}
NOTE: Product IDs are for consumable purchases (can buy multiple times)
Gamepass IDs are for one-time purchases
============================================
5. GAMEPASSES
============================================
To set up gamepasses:
1. Go to: create.roblox.com > Creator Dashboard > Your Game > Passes
2. Create a pass
3. Copy the Gamepass ID (NOT Product ID)
4. Paste into Config.Gamepasses section:
Config.Gamepasses = {
GravityCoil = {
Id = 123456789, -- Your gamepass ID here
ToolName = "Gravity Coil", -- Must match tool name in Rebirth Tools folder
},
SpeedCoil = {
Id = 123456790,
ToolName = "Speed Coil",
},
-- etc.
}
============================================
6. REBIRTH REWARDS
============================================
When players rebirth, they get a random tool:
1. Create a folder in ServerStorage called "Rebirth Tools"
(Or change Config.Rebirth.ToolsFolderName)
2. Add Tool objects to this folder:
ServerStorage
└── Rebirth Tools
├── Gravity Coil (Tool)
├── Speed Coil (Tool)
└── MagicCarpet (Tool)
3. Tools are given randomly when player rebirths
4. Players can't get duplicates until they own all tools
============================================
7. TROLL PRODUCTS
============================================
Troll products let players pay Robux to affect others:
- KillAll: Kills all players in server
- FlingAll: Flings all players
- FreezeAll: Freezes all players with damage over time
- FireAll: Sets all players on fire
- LaunchAll: Launches all players into the sky
- Jumpscare: Scary visual effect for all players
- RainbowWorld: Changes all part colors randomly
- KillPlayer: Kills a specific targeted player
- FlingPlayer: Flings a specific targeted player
- SlipPlayer: Makes targeted player slip and ragdoll
Settings in Config.TrollSettings:
- BuyerImmune = true -- Buyer is immune to their own troll
- ShowAnnouncements = true -- Show "X bought Y" messages
============================================
8. TROUBLESHOOTING
============================================
Problem: Players not spawning at checkpoints
Solution: Check that each checkpoint has a "Spawn" part
Problem: Checkpoints not working
Solution: Check that "Touch" part exists and has CanCollide = true
Problem: Products not working
Solution: Verify Product IDs (not Gamepass IDs) in Config
Problem: Gamepasses not giving items
Solution: Verify Gamepass IDs and ToolName matches tool in Rebirth Tools
Problem: Rebirth not giving items
Solution: Check ServerStorage has "Rebirth Tools" folder with tools
Problem: Data not saving
Solution: Ensure ProfileService is installed in ServerScriptService.Services
Problem: "No checkpoints found" error
Solution: Check Workspace.Checkpoints folder exists with numbered models
Problem: Nothing is Working
Solution: Make sure the game is published and not in studio
============================================
SUPPORT
============================================
For additional help:
- Check the Config module for all settings
- Enable Config.Debug.EnableLogging to see console messages
- Test in Studio before publishing
============================================
Other
============================================
For additional help:
- IF you have any probems With the System Make Sure To Contact The Me
- PLEASE Do NOT Leak Or give the system to anyone else wihtout my permissoin
- Hope you Enjoy
- Made by: @gasterblaster787388 nickname: Vode
- discord acc: vode_o <-- Contact me
