RustFlash

The configuration file is located at `oxide/config/MyTutorial.json`. Basic Structure { "TaskGroups": [ { "Tasks": [ { "Description": ["Line 1", "Line 2"], "CompletionCondition": "ItemInInventory", "CompletionType": "shortname", "CompletionValue": "item.shortname" } ] } ], "DefaultPosition": "MiddleLeft" } Please remember that your space is very limited! --- Config (Detailed) DefaultPosition Sets the default UI position when the player hasn't chosen one yet. Valid Values: - `TopLeft`, `TopCenter`, `TopRight` - `MiddleLeft`, `Center`, `MiddleRight` - `BottomLeft`, `BottomCenter`, `BottomRight` Example: Note: Players can change the position via the `UI`. --- 2.TaskGroups An array of task groups. Each group contains multiple tasks that the player must complete. Structure of a TaskGroup: { "Tasks": [ { /* Task 1 */ }, { /* Task 2 */ }, { /* Task 3 */ } ] } Flow: 1. Player sees Task Group 1 first 2. When all tasks in Group 1 are completed → Task Group 2 3. When all groups are completed → Tutorial complete 4. Tutorial UI is completely removed --- 3. Task Structure (Detailed) Each task consists of 4 properties: Description The description of the task shown to the player. Features: - Can contain multiple lines - Automatic line wrapping for long text - Supports Rust color codes (`<color=#RRGGBB>`, `<color=orange>`) - Emojis: `⇨`, `⇝`, `✔`, `✕` Example: "Description": [ "⇨ Property acquisition:", " ⇝ Visit the town hall", " ⇝ Buy a property", " ⇝ Receive a mailbox", " ", " ⇝ This is optional text <color=#ffed00>optional</color>" ] --- CompletionCondition Determines how the task is completed. There are 6 options: `ItemInInventory` - Player obtains a specific item (crafted, bought, or found) | On each inventory update `Group` - Player is added to a group | On group changes `Command` - Player executes a command | On each chat command `BuildingPlaced` - Player places a specific structure/deployable | When placing (`OnEntityBuilt`) `LocationVisit` - Player enters a specific area | Every 5 seconds (position check) `PlayTime` - Player is online X seconds (current task) | Every 5 seconds (cumulative) --- CompletionType The type of value in `CompletionValue`. Possible Combinations: | CompletionCondition | Valid CompletionType | |-------------------|----------------------| ItemInInventory - `shortname` Group - `group` Command | `command` BuildingPlaced - `shortname` LocationVisit - `location` PlayTime - `seconds` --- CompletionValue The actual value the plugin checks. For `ItemInInventory` (shortname): - One or more item shortnames, separated by commas - The plugin checks for **at least one** of them - Examples: `mailbox`, `cupboard.tool,cupboard.tool.shockbyte` For `Group` (group): - One or more group names, separated by commas - The plugin checks for **at least one** of them - Examples: `vip,tierone,tiertwo` For `Command` (command): - An exact command (case-insensitive) - Only this command is accepted - Example: `/info`, `/help` For `BuildingPlaced` (shortname): - One or more `ShortPrefabName` values (deployable/structure), separated by commas - The plugin checks for **at least one** of them, triggered when player places the item - Examples: `door.hinged.wood`, `cupboard.tool,cupboard.tool.shockbyte`, `workbench1.deployed` - **Note:** The value is the prefab name of the placed entity, not the item shortname (usually the same, but please be careful!) For `LocationVisit` (location): - Format: `x,y,z,radius` (four comma-separated numbers) - `x`, `y`, `z` are world coordinates, `radius` is the tolerance in meters - Example: `100,0,-250,15` (player must be within 15m of point (100, 0, -250)) - **Tip:** Get coordinates in Rust with `client.showpos 1` (F1 console), but this is only useful for recurring maps, otherwise you need to adjust it each time For `PlayTime` (seconds): - A single number: required seconds the player must be **online in the current task group** - Example: `300` (5 minutes), `600` (10 minutes) - **Note:** Time only counts while player is online and accumulates from entering the current task group --- Examples ### Example 1: Simple Tutorial with Items ```json { "TaskGroups": [ { "Tasks": [ { "Description": [ "⇨ Obtain a pickaxe", " ⇝ Start mining" ], "CompletionCondition": "ItemInInventory", "CompletionType": "shortname", "CompletionValue": "pickaxe" }, { "Description": [ "⇨ Build a simple house", " ⇝ Gather wood", " ⇝ Craft planks" ], "CompletionCondition": "ItemInInventory", "CompletionType": "shortname", "CompletionValue": "wood" } ] } ], "DefaultPosition": "MiddleLeft" } ``` --- ### Example 2: Multi-stage Tutorial (Groups) ```json { "TaskGroups": [ { "Tasks": [ { "Description": [ "⇨ Welcome to our server!", " ⇝ Explore the map", " ⇝ Build a first base" ], "CompletionCondition": "ItemInInventory", "CompletionType": "shortname", "CompletionValue": "cupboard.tool" } ] }, { "Tasks": [ { "Description": [ "⇨ Support the server", " ⇝ Become a VIP member", " ⇝ Enjoy exclusive benefits" ], "CompletionCondition": "Group", "CompletionType": "group", "CompletionValue": "vip" } ] } ], "DefaultPosition": "TopRight" } ``` --- ### Example 3: Command-based Tutorial ```json { "TaskGroups": [ { "Tasks": [ { "Description": [ "⇨ Choose your playstyle", " ⇝ Open chat", " ⇝ Type: /joys" ], "CompletionCondition": "Command", "CompletionType": "command", "CompletionValue": "/joys" } ] } ], "DefaultPosition": "Center" } ``` --- ### Example 4: Location, Building, Item & Playtime ```json { "TaskGroups": [ { "Tasks": [ { "Description": [ "⇨ Visit Bandit Camp", " ⇝ Explore the map and find the trading post" ], "CompletionCondition": "LocationVisit", "CompletionType": "location", "CompletionValue": "100,0,-250,25" }, { "Description": [ "⇨ Build a wooden door", " ⇝ Place it on your base" ], "CompletionCondition": "BuildingPlaced", "CompletionType": "shortname", "CompletionValue": "door.hinged.wood" }, { "Description": [ "⇨ Craft a rope", " ⇝ Open your crafting menu", " ⇝ Make a rope" ], "CompletionCondition": "ItemInInventory", "CompletionType": "shortname", "CompletionValue": "rope" }, { "Description": [ "⇨ Explore at your leisure", " ⇝ Simply stay online for 5 minutes" ], "CompletionCondition": "PlayTime", "CompletionType": "seconds", "CompletionValue": "300" } ] } ], "DefaultPosition": "MiddleLeft" } ``` --- ### Example 5: Complex Multi-Item Tutorial ```json { "TaskGroups": [ { "Tasks": [ { "Description": [ "⇨ Get a mailbox", " ⇝ Go to the town hall", " ⇝ Buy a mailbox" ], "CompletionCondition": "ItemInInventory", "CompletionType": "shortname", "CompletionValue": "mailbox" }, { "Description": [ "⇨ Set up your base", " ⇝ Place the mailbox", " ⇝ Build a house", " ⇝ Place a Tool Cupboard" ], "CompletionCondition": "ItemInInventory", "CompletionType": "shortname", "CompletionValue": "cupboard.tool,cupboard.tool.shockbyte,cupboard.tool.retro" } ] } ], "DefaultPosition": "MiddleLeft" } ``` UI Positions The plugin supports 9 different UI positions: TopLeft TopCenter TopRight MiddleLeft Center MiddleRight BottomLeft BottomCenter BottomRight Players can change positions via the UI buttons and find the best position for them. Data & Persistence Storage Locations Progress Data: oxide/data/MyTutorial/Progress.json Completed Players: oxide/data/MyTutorial/Completed.json DO NOT DELETE THIS OR PLAYERS MUST REDO TUTORIALS! Automatic Saving Data is saved every 5 minutes or on server save automatically Player progress persists after plugin reloads Progress is preserved after a wipe (server restart) Tips & Best Practices 1. Keep Descriptions Short and Concise Keep task descriptions short and to the point. Very long text makes the UI crowded. Good: "Description": [ "⇨ Obtain a pickaxe", " ⇝ Start mining" ] Too long: "Description": [ "⇨ In this step you must obtain a pickaxe...", " ⇝ After that you can start mining..." ] 2. Multiple Items Per Task Use comma separation for flexible item checks: "CompletionValue": "cupboard.tool,cupboard.tool.shockbyte,cupboard.tool.retro" The plugin recognizes each of these items as successful. 3. Multiple Groups Per Task Same as items: "CompletionValue": "vip,tierone,tiertwo,tierthree" The player needs only one of these groups. 4. Optional Tasks You can use color codes for "optional" text: "Description": [ "⇨ Server Support <color=#ffed00>(optional)</color>:", " ⇝ Support our server" ] 5. Icons & Emojis Use meaningful symbols: ⇨ for main tasks ⇝ for sub-points ✔ for completed tasks ✕ for close button ♥ for appreciation

I'm currently working through my to-do list in order of priority. I recently became a dad and my time is limited.

Changed Status from Work in Progress to Fixed

Changed Status from Work in Progress to Fixed

Changed Status from Pending to Work in Progress Changed Fixed In to Next Version

Changed Status from Pending to Work in Progress Changed Fixed In to Next Version

That's a cool addition, I'll include it in the update.

Unfortunately, I don't have access and I'm not familiar with the MonumentEvents plugin by @Iftebinjan. My top priority right now is to create the combination with TruePvE, SimplePvE and WarMode.

Changed Status from Pending to Closed Changed Fixed In to Next Version

Hey Firelord, you're right, it seems I made a mistake during the last ForceWipe update. Thanks for letting us know.

Changed Status from Pending to Fixed Changed Fixed In to Next Version

Hey you use Carbon?

Changed Status from Pending to Work in Progress Changed Fixed In to Next Version

Actually, I've already done this, as you can see, I've uploaded a lot of ForceWipe updates, and there are a few more to come, including TheTorchHolder. Give me a little breathing room, I just became a dad, so my time at the computer is limited.

Changed Status from Pending to Closed Changed Fixed In to Next Version