-
Notifications
You must be signed in to change notification settings - Fork 2
Distributing Levels
To install your level inside the HUD (and distribute it) you'll want to use the xMod level Installer that comes with the xMod unpacker. Note that if you want something visually appealing, you just need to drag the SceneInstaller script into the installer prim of your choosing.
Note: The SceneInstaller will auto update from the HUD when you rez the installer, make sure to wear your HUD!
Each level object placed in the installer needs to be accompanied by a notecard with the same name as the prim, plus .scene. For an example, if you have the level My Level, you need to add a notecard named exactly My Level.scene. It's case sensitive.
The level notecard is a simple config file where each row has a property, followed by a :, followed by the value. Ex: Name: My Awesome level. The property is not case sensitive.
| Property Name | Type | Optional | Description |
|---|---|---|---|
| Name | String | No | The full name of your level (doesn't have to match the object name) |
| Category | String | No | The category of your level (categories are shown in the browser, and are case sensitive). Common categories are "Wipeout" and "Ghost". You can make your own categories (see below). |
| LandImpact | Integer | No | Roughly the amount of land impact when the level is rezzed and started |
| MinPlayers | Integer | No | Min players that can play this map |
| MaxPlayers | Integer | No | Max players that can play this map |
| Description | String | No | Describe your map |
| Creator | String | No | Name of the person or organization that created the map |
| Version | String | No | Version of your map. There's no fixed versioning scheme, pick one you like |
| Rotation | Rotation | Yes | Rez rotation of your map, SL rotation format. Ex: <0,0,-.71,.71>. Default is ZERO_ROTATION. |
You can create and install custom categories with a category notecard. The notecard should be called the name of your category and end with .category. For an example, if you wanted the category Fighting Game you'd name the notecard Fighting Game.category. Categories have the same syntax as levels. All settings properties are required.
| Property Name | Type | Description |
|---|---|---|
| Description | String | A short description describing your category. Such as A basic side-view fighting game where you use your arrow keys E and C to move, attack and block.. |
| Color | String | A hex color for the button. Use a light color with no color less than AA. Ex: #FFAAAA for light red (ghost uses this). |
There's no built in distribution system, use the marketplace. Add [xMod Level] to the name of your level for it to show up in the default search for the HUD.