World Paths is a feature of Resonite that allows for an alternative way to load a world within Headless Configuration Files, Startup Config Files, ProtoFlux etc.
Using a world path, results in a cleaner and easier to remember URL for your worlds.
World Path Structure
A world path is comprised of 4 Parts:
- The Platform prefix: "resrec:///"
- The Group or User ID where the world is saved. E.g. U-Cheese or G-Cheese.
- The "Folder" for the world path
- The Name of the World.
Putting it all together an example world path might be: resrec:///G-Cheese/Worlds/Cool Cheese World
Setting up a World Path
To set up a world path, you just need a World Orb for the world you want to set one up on. Once you have that just follow these steps:
- Click the World Orb
- Select "Edit Metadata"
- The following form will show:
For World Paths, there are two important things in this window: - The World Name - The value in the world path input box.
The rest can be ignored for the purposes of world paths.
If you want your world to be within "Worlds\Test", simply enter Worlds\Test in the world path input box. Once that's done take a note of the world name and then press save.
Now wait for everything to Sync by checking your dash. Once that's done you should be good to go! To construct your world path URI you combine the World Path and World Name using the following format:
resrec:\\<your group or user id>\<The World Path>\<The World Name>.
Examples
| User/Group ID | World Path | World Name | Full World Path URI |
|---|---|---|---|
| U-Frooxius | Worlds\Fruit | Mango | resrec:///U-Frooxius/Worlds/Fruit/Mango
|
| G-Cheese | Worlds\Cheese | Gouda | resrec:///G-Cheese/Worlds/Cheese/Gouda
|
Using a World Path
Once you have a world path you can use it in a number of places:
- As the URL for loadWorldURL within Headless Configuration Files and Startup Config Files
- As the value for the URI property of the Open World Protoflux node.
- As the value for the URI property of the Focus World Protoflux node.