| Creating Interreality: The Virtual Object System: Version 0.12.0 | ||
|---|---|---|
| Prev | Chapter 3. Using VOS to Explore and Build Virtual Worlds | Next |
The vosworld server runs a server process, usually in the background (as a "daemon"), containing A3DL objects. It can either create a completely empty world, or load the world from a COD (Compact Object Description) file.
vosworld can be found in the 3D source distribution in 3D/vosworld. If installed on your system, then you can simply run vosworld at a command prompt. A GUI frontend is planned for a future release.
Long options (e.g. --help) are not available an some platforms.
vosworld [-h|--help] [-t|--title title] [-d|--description description] [-N] [-L|--log logfile] [-E|--loglevel level] [-l|--load COD file] [-p|--parent parent URL] [-s service list URL] [-n name]
-h|--help
Display help text
-t|--title title
Short title for the world. Default is 'A VOS world'.
-d|--description description
Longer description of the world. Default is 'A VOS world'.
-N
Don't run in the background.
-L|--log logfile
Write log messages to logfile (default is /var/log/vosworld) Use "-L -" to log to stdout (-N is implied in this case).
-E|--loglevel level
Set log level to level (default is 2).
-l|--load COD file
Load object from the supplied COD file (which may be compressed with gzip).
-p|--parent parent URL
URL of a parent world into which objects in the COD input will be linked, rather than running as an independent sector.
-s service list URL
-n name
Name of the root sector object. If loading a COD, search the COD for an object with this name. If not loading a COD, create a new sector object with this name. Default is 'world'.
vosworld loads objects from a COD file and runs in the background servicing requests for those objects. The COD file may be generated by tools such as the Blender export script, the A3DL converter or Mesh. The COD file may be compressed with gzip if you wish. Use the -l option followed by the name of the COD file to load that file. Once it finishes loading, vosworld will print the sector URL to its log file (use "-L -" to log to standard output).
vosworld will attempt to register the new sector with a local service list if possible (use the servicelistd command to run a service list in the background). If you wish to register your world with another service list in addition to the local one, use the -s option followed by the URL to the service list: e.g. to register with the default interreality.org list that Ter'Angreal checks at startup, use -s vop://interreality.org/services. You should also set a title and description for your world using -t and -d.