Created page with "A common goal for Headlesses] is to load a specific world on start-up. This article guides you through doing that with the goal of as much success as possible. == Preparing the World for a Headless == The first step is also the most important for success, we need to ensure the world is ready for a Headless. The steps required for this depend on where the world will be stored. * Using User's Inventory * Using a [[Group|Group's Inventory ** Th..." |
Marked this version for translation |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
A common goal for [[Headless Server Software|Headlesses] is to load a specific world on start-up. This article guides you through doing that with the goal of as much success as possible. | <languages/> | ||
<translate><!--T:1--> A common goal for [[Headless Server Software|Headlesses]] is to load a specific world on start-up. This article guides you through doing that with the goal of as much success as possible.</translate> | |||
== Preparing the World for a Headless == | == <translate><!--T:2--> Preparing the World for a Headless</translate> == | ||
The first step is also the most important for success, we need to ensure the world is ready for a Headless. The steps required for this depend on where the world will be stored. | <translate><!--T:3--> The first step is also the most important for success, we need to ensure the world is ready for a Headless. The steps required for this depend on where the world will be stored.</translate> | ||
* Using User's Inventory | * <translate><!--T:4--> Using User's Inventory</translate> | ||
* Using a [[Group|Group's]] Inventory | * <translate><!--T:5--> Using a [[Group|Group's]] Inventory</translate> | ||
** This option is the easiest, but does require a [[Groups|Group]] | ** <translate><!--T:6--> This option is the easiest, but does require a [[Groups|Group]]</translate> | ||
=== User's inventory === | === <translate><!--T:7--> User's inventory</translate> === | ||
# Setup your world as per normal | # <translate><!--T:8--> Setup your world as per normal</translate> | ||
# Save your world to your inventory | # <translate><!--T:9--> Save your world to your inventory</translate> | ||
# Spawn a world orb of the world and click on it | # <translate><!--T:10--> Spawn a world orb of the world and click on it</translate> | ||
# Select "Edit Meta-Data" | # <translate><!--T:11--> Select "Edit Meta-Data"</translate> | ||
# Ensure "Who can open this world?" is set to "Anyone" | # <translate><!--T:12--> Ensure "Who can open this world?" is set to "Anyone"</translate> | ||
[[File:WorldAccessAnyone.png|Screenshot of the world meta-data screen showing "Anyone" selected under "Who can open this world?"]] | [[File:WorldAccessAnyone.png|<translate><!--T:13--> Screenshot of the world meta-data screen showing "Anyone" selected under "Who can open this world?"</translate>]] | ||
# Click save | # <translate><!--T:14--> Click save</translate> | ||
# Wait for your Sync status to say "All Synced" | # <translate><!--T:15--> Wait for your Sync status to say "All Synced"</translate> | ||
=== Group's inventory === | === <translate><!--T:16--> Group's inventory</translate> === | ||
# Setup your world as per normal | # <translate><!--T:17--> Setup your world as per normal</translate> | ||
# Save your world to your Group's Inventory | # <translate><!--T:18--> Save your world to your Group's Inventory</translate> | ||
# Ensure that the Headless User is a member of your target Group | # <translate><!--T:19--> Ensure that the Headless User is a member of your target Group</translate> | ||
# Wait for your Sync status to say "All Synced" | # <translate><!--T:20--> Wait for your Sync status to say "All Synced"</translate> | ||
== Getting the Record URL == | == <translate><!--T:21--> Getting the Record URL</translate> == | ||
The next step is ensuring that you have the correct url. There are a variety of world urls available and for Headlesses you need the "Record Url". | <translate><!--T:22--> The next step is ensuring that you have the correct url. There are a variety of world urls available and for Headlesses you need the "Record Url".</translate> | ||
To get this: | <translate><!--T:23--> To get this:</translate> | ||
# Select the world in the World Browser | # <translate><!--T:24--> Select the world in the World Browser</translate> | ||
# Click the Right Arrow in the top right of the world preview. This will open an expanded world dialog. | # <translate><!--T:25--> Click the Right Arrow in the top right of the world preview. This will open an expanded world dialog.</translate> | ||
# Click "Copy Record URL" | # <translate><!--T:26--> Click "Copy Record URL"</translate> | ||
If you want to check if the URL is correct, ensure that it starts with <code>resrec:///</code>, it should also have your user id, or group id as the first part of the URL. | <translate><!--T:27--> If you want to check if the URL is correct, ensure that it starts with <code>resrec:///</code>, it should also have your user id, or group id as the first part of the URL.</translate> | ||
<code>resrec:///GROUP OR USER ID/WORLD RECORD ID</code> | <code>resrec:///<translate><!--T:28--> GROUP OR USER ID/WORLD RECORD ID</translate></code> | ||
== Adding the Record URL to the configuration == | == <translate><!--T:29--> Adding the Record URL to the configuration</translate> == | ||
Once you have the Record URL, you just need to add it to the [[Headless Server Software/Configuration File]], in the <code>loadWorldURL</code> property of a world. | <translate><!--T:30--> Once you have the Record URL, you just need to add it to the [[Headless Server Software/Configuration File]], in the <code>loadWorldURL</code> property of a world.</translate> | ||
An example is available on our [[Headless_Server_Software/Example_Configurations#Minimal_with_Specified_World|example configuration page]]. | <translate><!--T:31--> An example is available on our [[Headless_Server_Software/Example_Configurations#Minimal_with_Specified_World|example configuration page]].</translate> | ||
== <translate><!--T:32--> See Also</translate> == | |||
* [[Headless Server Software/Setup|Setup a Headless]] - <translate><!--T:33--> How to setup a headless for the first time</translate> | |||
* [[Headless Server Software/Managing Worlds|Managing Worlds]] - <translate><!--T:34--> Guidance on world management with a headless.</translate> | |||
* [[Headless Server Software/Docker|Docker Setup]] - <translate><!--T:35--> Guidance on creating a headless using Docker.</translate> | |||
* [[Headless Server Software/Configuration File|Configuration File]] - <translate><!--T:36--> Learn about Headless Configuration Files</translate> | |||
* [[Headless Server Software/Commands|Commands]] - <translate><!--T:37--> Learn about Headless Commands</translate> | |||
* [[Headless Server Software/Troubleshooting|Troubleshooting]] - <translate><!--T:38--> A guide for troubleshooting Headless issues.</translate> | |||
{{FurtherHelp}} | |||
Latest revision as of 00:46, 2 June 2024
A common goal for Headlesses is to load a specific world on start-up. This article guides you through doing that with the goal of as much success as possible.
Preparing the World for a Headless
The first step is also the most important for success, we need to ensure the world is ready for a Headless. The steps required for this depend on where the world will be stored.
- Using User's Inventory
- Using a Group's Inventory
- This option is the easiest, but does require a Group
User's inventory
- Setup your world as per normal
- Save your world to your inventory
- Spawn a world orb of the world and click on it
- Select "Edit Meta-Data"
- Ensure "Who can open this world?" is set to "Anyone"
- Click save
- Wait for your Sync status to say "All Synced"
Group's inventory
- Setup your world as per normal
- Save your world to your Group's Inventory
- Ensure that the Headless User is a member of your target Group
- Wait for your Sync status to say "All Synced"
Getting the Record URL
The next step is ensuring that you have the correct url. There are a variety of world urls available and for Headlesses you need the "Record Url".
To get this:
- Select the world in the World Browser
- Click the Right Arrow in the top right of the world preview. This will open an expanded world dialog.
- Click "Copy Record URL"
If you want to check if the URL is correct, ensure that it starts with resrec:///, it should also have your user id, or group id as the first part of the URL.
resrec:///GROUP OR USER ID/WORLD RECORD ID
Adding the Record URL to the configuration
Once you have the Record URL, you just need to add it to the Headless Server Software/Configuration File, in the loadWorldURL property of a world.
An example is available on our example configuration page.
See Also
- Setup a Headless - How to setup a headless for the first time
- Managing Worlds - Guidance on world management with a headless.
- Docker Setup - Guidance on creating a headless using Docker.
- Configuration File - Learn about Headless Configuration Files
- Commands - Learn about Headless Commands
- Troubleshooting - A guide for troubleshooting Headless issues.
Further Help
If you need further help then you can: