### Blacklist Input Items Example Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/assets/crafting-blacklist-asset.md This example demonstrates how to specify items that, when used as input, will prevent blueprints from being crafted. It shows how to list individual item GUIDs and group them within curly braces. ```unturnedasset Input_Items [ // Orange Hoodie "GUID" "67c76cdf16024bf68b6e5d14d4c617ab" // Individual items can also be enclosed in brackets { } { // Eaglefire GUID b03d581a5c1a490f995f8deba57b0f17 } // Jeans dab78cc4d66645bfb8169be7c15cf876 55c69817a31448b685c7f788ec7d2d0c bdae9d26ca704d729b2b0f34812d2a36 67a6ec52e4b24ffd89f75ceee0eb5179 ] ``` -------------------------------- ### Define Server Browser Labels Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/servers/server-browser-curation.md Example configuration for defining custom labels with rich text formatting to be applied to servers in the browser. ```unturneddat Labels [ { Name Verified Text MyNetwork Verified } { Name Fake Text MyNetwork Imposter } ] ``` -------------------------------- ### Unturned Blueprint Conditions and Rewards Example Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/items/blueprints.md Demonstrates how blueprint conditions and rewards can be integrated, often used for seasonal events. Conditions and rewards are prefixed with 'Blueprint_#_', showing an example of a holiday-specific condition type. ```unturneddat Blueprint_0_Condition_0_Type Holiday ``` -------------------------------- ### Blacklist Specific Blueprints Example Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/assets/crafting-blacklist-asset.md This example shows how to prevent specific blueprints from being crafted by referencing their associated item GUID and either their BlueprintName or Blueprint index. It's recommended to use BlueprintName for stability. ```unturnedasset Blueprints [ { Item a6099002318e4d58b8e59d431bcf1b8a BlueprintName Salvage } ] ``` -------------------------------- ### Unturned Data File Syntax Examples Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/assets/data-file-format.md Demonstrates the basic key-value pair structure, quoting rules, and how keys and values are parsed in Unturned data files. It shows how spaces and special characters are handled. ```unturneddat Key1 First value "Key2 in quotes" Second value Key3 "Third value" ``` ```text "Key1" = "First value" "Key2 in quotes" = "Second value" "Key3" = "Third value" ``` -------------------------------- ### Define Spawn Table Configuration Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/assets/spawn-asset.md An example of a spawn table configuration using the modern GUID-based format. It defines two items with specific weights, resulting in a 90% and 10% spawn chance respectively. ```text Tables [ { // Military Magazine Guid dbfb1d0d11ca438e9dffb95f76e61274 Weight 180 } { // Eaglefire Guid b03d581a5c1a490f995f8deba57b0f17 Weight 20 } ] ``` -------------------------------- ### Placeable Asset Crafting Tags Example Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/items/placeable-asset.md Demonstrates how to define crafting tags for a placeable asset. These tags are used to specify blueprint requirements for crafting recipes that utilize this placeable. ```unturneddat PlaceableProvidesCraftingTags [ // Heat Source (for backwards compatibility) 20f30322bbcc4b01a4f116d22b24c21a // Enclosed Heat Source d2cc65b749e5477f95103601df89cdbc ] ``` -------------------------------- ### Unturned Blueprint Input Item Value Format Examples Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/items/blueprints_inputitem.md Demonstrates the straightforward value format for specifying blueprint input items, including item IDs, amounts, and using 'this' for owning assets. ```unturneddat // Canned Beans: 78fefdd23def4ab6ac8301adfcc3b2d4 // Or, using Canned Beans' legacy ID: 13 // Two cans of beans: 13 x 2 // Owning asset: this // Two of owning asset: this x 2 ``` -------------------------------- ### Define Unturned Server Curation List Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/servers/server-browser-curation.md An example of a configuration file for the NelsonNet network. It demonstrates how to define labels for UI display and rules for filtering servers based on ServerID and Name using regex. ```unturneddat Name NelsonNet Verification Example IconURL https://cdn.smartlydressedgames.com/ShareX/2024/12/ExampleIcon.png Labels [ { Name Verified Text NelsonNet Official } ] Rules [ { Action Allow Description Verify NelsonNet's Steam IDs Label Verified Type ServerID Values [ 85568392932910946 ] } { Action Deny Description Hide fake NelsonNet servers (case-insensitive check for "NelsonNet" in the name) Type Name Regex (?i)(NelsonNet) } ] ``` -------------------------------- ### Define Server Browser IP Filters Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/servers/server-browser-curation.md Example configuration for defining IP address filters using CIDR notation, specific ports, or port ranges to match server addresses. ```unturneddat Filters [ // Matches any port on this IP address. 10.8.0.1 // Matches port 27015. 10.8.0.1:27015 // Matches ports 27015 through 27030 (inclusive). 10.8.0.1:27015-27030 // Matches any port on IP addresses in the range 192.168.1.0 through 192.168.1.255. 192.168.1.0/24 ] ``` -------------------------------- ### Unturned .dat Asset Pointer Syntax Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/data/asset-ptr.md Demonstrates the syntax for an Asset Pointer within Unturned's .dat files. The GUID is not enclosed in quotes as these files are treated as string pairs. ```unturneddat MyAssetPtr ################################ ``` -------------------------------- ### Create Symbolic Link for Workshop Map on Linux Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/sdg/hosting-servers-using-private-workshop-files.md Create a symbolic link from the downloaded workshop content directory to the server's Maps folder. This allows the server to access the private map files as if they were local. ```bash ln -S ../../workshop/content/304930/(workshopfileid)/MyMap Maps/MyMap ``` -------------------------------- ### Define Asset Redirects in Unturned Editor Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/mapping/editor-asset-redirectors.md This snippet demonstrates the format for defining asset redirects in the 'EditorAssetRedirectors.txt' file. Each line specifies a GUID to be replaced and the new GUID it should be replaced with. Comments starting with '//' or '#' and empty lines are ignored. ```text // Replace Boulder_00 with Boulder_01 6125b4de591b44359237f6d7191dd919 -> ee402fc9debe4f03bffb31a49eb04fb7 // Replace Maple_0 with Maple_3 63cb368c94b14000aabc5325b048cfa3 -> 011d1369cd56497488827b44509b0b4b ``` -------------------------------- ### Configure Default Battery Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/assets/vehicle-asset.md Specifies the GUID of the default battery item provided to the player if no specific battery is installed. This defaults to the standard Vehicle Battery used in official vehicles. ```unturneddat Default_Battery 098b13be34a7411db7736b7f866ada69 ``` -------------------------------- ### Define Blueprint Output Items using Dictionary Format Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/items/blueprints_outputitem.md Demonstrates the dictionary format for complex blueprint output configurations. This structure allows for explicit property definitions like Amount, ID, and Origin. ```unturneddat OutputItems [ { // First output item properties } { // Second output item properties } ] ``` -------------------------------- ### GET /assets/vehicle/handling Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/assets/vehicle-asset.md Retrieves the schema and configuration properties for vehicle handling physics. ```APIDOC ## GET /assets/vehicle/handling ### Description Defines the physics and handling parameters for vehicle assets in the game. ### Method GET ### Endpoint /assets/vehicle/handling ### Parameters #### Request Body - **Air_Steer_Max** (float32) - Optional - Maximum air steering angle. - **Air_Steer_Min** (float32) - Optional - Minimum air steering angle. - **Air_Turn_Responsiveness** (float32) - Optional - Responsiveness of air turns (Default: 2). - **Brake** (float32) - Optional - Braking force. - **Center_Of_Mass** (vector3) - Optional - Coordinate for the center of mass. - **Carjack_Force_Multiplier** (float32) - Optional - Multiplier for carjack force (Default: 1.0). - **Engine_Force_Multiplier** (float32) - Optional - Multiplier for engine force (Default: 1.0). - **Speed_Max** (float32) - Optional - Maximum speed (Default: 0). - **Physics_Profile** (GUID) - Optional - Unique identifier for the physics profile. ### Request Example { "Air_Turn_Responsiveness": 2.0, "Carjack_Force_Multiplier": 1.0, "Engine_Force_Multiplier": 1.0 } ### Response #### Success Response (200) - **status** (string) - Success message #### Response Example { "status": "success" } ``` -------------------------------- ### GET /item-asset-configuration Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/items/introduction.md Retrieves the schema and default values for item asset definitions within the Unturned engine. ```APIDOC ## GET /item-asset-configuration ### Description Defines the configuration parameters for item assets. This schema is used to define how items behave, appear, and interact within the game world. ### Method GET ### Endpoint /item-asset-configuration ### Parameters #### Request Body - **Instantiated_Item_Name_Override** (string) - Optional - Custom name for the instantiated item. - **InventoryAudio** (Master Bundle Pointer) - Optional - Audio asset associated with inventory interactions. - **Left_Handed_Characters_Mirror_Equipable** (bool) - Optional - Whether the item model mirrors for left-handed characters (Default: true). - **Quality_Max** (uint8) - Optional - Maximum possible quality value (Default: 90). - **Quality_Min** (uint8) - Optional - Minimum possible quality value (Default: 10). - **Rarity** (EItemRarity) - Optional - The rarity tier of the item (Default: Common). - **Size_X** (uint8) - Optional - Horizontal inventory size (Default: 1). - **Size_Y** (uint8) - Optional - Vertical inventory size (Default: 1). - **Type** (EItemType) - Required - The classification type of the item. ### Request Example { "Rarity": "Common", "Size_X": 1, "Size_Y": 1, "Type": "Gear" } ### Response #### Success Response (200) - **status** (string) - Success message. #### Response Example { "status": "success" } ``` -------------------------------- ### Level Configuration - Main Menus Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/mapping/level-config.md Configuration options for displaying level information in the main menus. ```APIDOC ## Level Config - Main Menus ### Description Configuration options for displaying level information in the main menus. ### Method N/A (Configuration File) ### Endpoint N/A (Config.json within level directory) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body **Creators** (string[]) - Names in credits. **Collaborators** (string[]) - Names in credits. **Thanks** (string[]) - Names in credits. **Associated_Stockpile_Items** (int[]) - Economy itemdefids to feature on map screens. One is chosen at random each time the map is shown. Used by curated maps to link their items which have payment splits. **Feedback** (string) - URL to discussions. If not explicitly set, defaults to the workshop item’s discussions page. **Visible_In_Matchmaking** (bool) - Should this map be listed in the matchmaking menu? Used to filter out test and demo maps. **Version** (string) - #.#.#.# format version number. Vanilla version numbers use 3.Year.Update.Patch, but that is optional. Incrementing the version number for every upload is good practice because: 1. When client and server files do not match it is more helpful to show a version number error message rather than a generic file mismatch error. 2. Searching by map in the server browser can filter servers running the same version of the map. **Tips** (int) - Number of Tip_# keys defined in level’s localization files, if any. Overrides vanilla tip messages on the loading screen. ### Request Example ```json { "Creators": ["Player1", "Player2"], "Collaborators": ["Dev1"], "Thanks": ["Community Member"], "Associated_Stockpile_Items": [1001, 1002], "Feedback": "http://example.com/feedback", "Visible_In_Matchmaking": true, "Version": "3.18.1.0", "Tips": 5 } ``` ### Response #### Success Response (200) N/A (Configuration file content) #### Response Example N/A ``` -------------------------------- ### Launch Unturned Internet Server on Linux Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/servers/steamcmd.md This command launches an Unturned dedicated server configured for internet play. It requires the ServerHelper.sh script and a server name (e.g., MyServer). Ensure you are in the correct directory. ```batch ./ServerHelper.sh +InternetServer/MyServer ``` -------------------------------- ### GET /assets/magazine Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/items/magazine-asset.md Retrieves the configuration schema for magazine attachments, defining how explosive projectiles and weapon interactions are handled. ```APIDOC ## GET /assets/magazine ### Description Defines the properties for magazine attachments, including explosive damage, reload speed, and projectile behavior. ### Method GET ### Endpoint /assets/magazine ### Parameters #### Request Body - **Projectile_Damage_Multiplier** (float32) - Optional - Multiplier on explosive projectile damage. - **Projectile_Launch_Force_Multiplier** (float32) - Optional - Multiplier on projectile launch force. - **Range** (float32) - Optional - Radius of the explosion in meters. - **Resource_Damage** (float32) - Optional - Damage dealt to resources. - **Structure_Damage** (float32) - Optional - Damage dealt to structures. - **Vehicle_Damage** (float32) - Optional - Damage dealt to vehicles. - **Zombie_Damage** (float32) - Optional - Damage dealt to zombies. - **Should_Fill_After_Detach** (bool) - Optional - Refill ammo on detach. - **Speed** (float32) - Optional - Reload speed multiplier. - **Stuck** (uint8) - Optional - Quality loss on hit. - **Tracer** (GUID/uint16) - Optional - Tracer effect ID. ### Request Example { "Projectile_Damage_Multiplier": 1.0, "Range": 5.0, "Speed": 1.2 } ### Response #### Success Response (200) - **status** (string) - Configuration applied successfully. #### Response Example { "status": "success" } ``` -------------------------------- ### GET /assets/vehicle/properties Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/assets/vehicle-asset.md Retrieves the list of configurable properties for vehicle assets, including physics, camera offsets, and audio settings. ```APIDOC ## GET /assets/vehicle/properties ### Description This endpoint returns the schema definitions for vehicle asset properties, allowing developers to understand how to configure vehicle behavior in Unturned. ### Method GET ### Endpoint /assets/vehicle/properties ### Parameters #### Query Parameters - **include_deprecated** (boolean) - Optional - Whether to include deprecated properties like 'Crawler'. ### Request Example GET /assets/vehicle/properties?include_deprecated=false ### Response #### Success Response (200) - **properties** (array) - A list of vehicle configuration keys and their associated types. #### Response Example { "properties": [ {"name": "ID", "type": "uint16", "default": "0"}, {"name": "Can_Be_Locked", "type": "bool", "default": "true"}, {"name": "Cam_Follow_Distance", "type": "float32", "default": "5.5"} ] } ``` -------------------------------- ### ItemBackpackAsset Configuration Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/items/backpack-asset.md Defines the configuration requirements for creating a backpack asset in the game data files. ```APIDOC ## DATA DEFINITION: ItemBackpackAsset ### Description Backpacks are wearable items that occupy the player's backpack slot. They inherit from ItemBagAsset and define storage capacity and visual properties. ### Required Properties - **GUID** (string) - Required - Unique identifier for the asset. - **ID** (integer) - Required - Unique numeric ID for the asset. - **Type** (string) - Required - Must be set to `Backpack`. - **Useable** (string) - Required - Must be set to `Clothing`. ### Inherited Behavior Notes - **Armor**: Backpacks do not provide armor protection as they do not cover specific body parts. - **InventoryAudio**: Automatically defaults based on dimensions: - < 3x3: `Sounds/Inventory/LightMetalEquipment.asset` - < 6x6: `Sounds/Inventory/MediumMetalEquipment.asset` - >= 6x6: `Sounds/Inventory/HeavyMetalEquipment.asset` ### Configuration Example { "GUID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ID": 1001, "Type": "Backpack", "Useable": "Clothing", "Width": 4, "Height": 4 } ``` -------------------------------- ### Unturned Multi-line Value Example Source: https://github.com/smartlydressedgames/unturned-docs/blob/latest/assets/data-file-format.md Shows how to represent multi-line values in Unturned data files using the '\n' escape sequence. ```unturneddat Text First line\nSecond line ``` ```text First line Second line ``` -------------------------------- ### Configure Asset Header and Metadata Source: https://context7.com/smartlydressedgames/unturned-docs/llms.txt Shows the mandatory header structure for all Unturned assets, requiring a GUID and Type, with optional ID for legacy support. ```unturneddat // Standard asset header format GUID 7e4b847061b64272b42ea8869fd053c7 Type SDG.Unturned.VehicleAsset ID 100 // Alternative metadata format Metadata { GUID 7e4b847061b64272b42ea8869fd053c7 Type SDG.Unturned.Asset } // Asset body with properties Asset { ID 100 Key1 Value Key2 Value } ```