In separate terminals start the voice bridge and server:

(Note: another situation in which you might need the X11 sources is if you don't have the necessary versions of certain libraries on your system and need to recompile the X11 server to use the versions of the libraries that you do have. For example, right now the binary Xvfb shipped with Wonderland requires the following Ubuntu packages: LibXfont1^?, LibXext6^?, LibXau6^?, LibXdmcp6^?, LibXtst6^?, LibXi6^?). If you are, for example, running on a Red Hat system that doesn't have these versions of these libraries you will need to recompile Xvfb to use the libraries you do have.).

Download, Configure, Build and Run from the Wonderland Source

Basic Installation (Most common)

In the basic installation, you will download and compile the most essential elements of Project Wonderland.

Requirements

1. Have subversion installed on your system (http://subversion.tigris.org/), if you plan to install the optional add-on modules.

Download the lg3d-wonderland workspace

Download the wonderland-modules workspace (optional)

Configuring Project Wonderland

Building Project Wonderland

Running Project Wonderland

You can run Project Wonderland by using ant targets provided by the build system. If you are debugging Project Wonderland, it is best to open three terminal windows and start the Wonderland server, voice bridge, and Wonderland client in separate terminal windows.

% ant run-bridge

% ant run

If you'd like to run the smc (server-master client), part of the Wonderland X11 application sharing mechanism, you can run the following script from the lg3d-wonderland directory in a fourth terminal window:

Finally, if you wish to run all of the server components (the Wonderland server, the voice bridge, and the smc) all at once, rather than starting them separately as above, from a single terminal window within the lg3d-wonderland directory:

% ./src/scripts/server.sh

This script takes ~1 min to run and returns you to the prompt when complete. It automatically creates log files in the lg3d-wonderland directory for the Wonderland server, voice bridge, and smc (named wonderland-sgs.log, wonderland-bridge.log, and wonderland-smc.log, respectively).

Advanced Installation and Configuration

The following set of configuration steps are not required to get the Project Wonderland software up and running--they are optional and typically only advanced users would need to take these additional steps.

Download the lg3d-wonderland-art workspace

The lg3d-wonderland-art workspace contains all of the compiled artwork resources used in the default (MPK20) world provided with Project Wonderland. This artwork also resides over the Internet at 192.18.37.42, and by default, Project Wonderland will look there to download the resources. You also have the ability to have the client load the artwork resources locally.

You may wish to download the artwork if you plan to host the artwork that comes with Project Wonderland yourself (e.g. if you are behind a firewall and can't access the public art web server), or if you plan on creating new worlds that include the Project Wonderland artwork along with your own, new art.

Inside a terminal window:

% cd ~/Wonderland
% cvs -d :pserver:<username>@cvs.dev.java.net:/cvs checkout lg3d-wonderland-art

where you should replace <username> with your java.net user name.

Configuration for Different Artwork Repositories

wonderland.art.url.base

Load your own world in Project Wonderland

Downloading the Wonderland X11 Source Code

Other Advanced Configuration Options

For other more advanced configuration options for Project Wonderland, please see the following tutorials:

• Setup Project Wonderland for NATs, Firewalls, and Proxies
• Configuring Authentication for Project Wonderland
• Setting up Telephones for Project Wonderland

Where to Next?

Downloading the Wonderland X11 Source Code (Optional)

You only need the X11 sources if you plan to make modifications to it, a binary version is included with the Java sources for normal use.

1. Have Java SE 5 or Java SE 6 installed on your system (See these special instructions if you are running on Mac OS X).

1. Have git installed on your system (http://git.or.cz/), if you plan to download the XRemWin source code (optional).

Downloading the Wonderland X11 Source Code

Wonderland X11 App Sharing uses a special X server known as the "X Remote Window (XRemwin) Server." This server is similar to an VNC server except it handles windows separately. That is, instead of just displaying an entire X desktop inside the virtual world it allows windows to be individually integrated into the virtual world. This allows X windows to be treated as first class objects in the world. For example, these windows can be moved into different locations in the world and do not even have to reside in the same plane. They have complete freedom of movement and orientation.

The source code for XRW resides here. This source code is based on Xorg 7.3. It contains only the Xremwin-specific differences. It contains some entire files, which are new, and also some code fragments which change existing Xorg files. These changes must be applied incrementally to an existing Xorg source code tree. Both Linux and Solaris changes are available. There is a file in the zip bundles called README-XREMWIN which explains how to integrate this code into an Xorg server source base.

You may also obtain the Wonderland XRW source code via gif. The source code for XRW is contained in the Xorg master git repository in a branch called wonderland-dev. To obtain this code, do the following:

% git clone git://anongit.freedesktop.org/git/xorg/xserver 
% cd xserver 
% git checkout wonderland-dev 

Most of the XRW code lies in the directory xserver/hw/vfb. This code is licensed under the MIT License.

% ./src/scripts/runsmc

Note that the smc can only be run on either Solaris or Linux systems.

Finally, if you wish to run all of the server components (the Wonderland server, the voice bridge, and the smc) all at once, rather than starting them separately as above, from a single terminal window within the lg3d-wonderland directory:

% ./src/scripts/server.sh

This script takes ~1 min to run and returns you to the prompt when complete. It automatically creates log files in the lg3d-wonderland directory for the Wonderland server, voice bridge, and smc (named wonderland-sgs.log, wonderland-bridge.log, and wonderland-smc.log, respectively).

The Project Wonderland source code comes bundled with most of the software you will need, including an up-to-date version of Java 3D and Project Darkstar.

Requirements

1. Have Java SE 5 or Java SE 6 installed on your system (See these special instructions^? if you are running on Mac OS X).
2. Have ant installed on your system (http://ant.apache.org/).
3. Have cvs installed on your system (http://www.nongnu.org/cvs/).
4. Have subversion installed on your system (http://subversion.tigris.org/), if you plan to install the optional add-on -modules.
5. Have an account on java.net. To register for an account, visit: https://www.dev.java.net/servlets/Join

Download the lg3d-wonderland workspace

The lg3d-wonderland workspace contains all of the source code and any libraries that Project Wonderland depends upon and is available via cvs. It contains its own ant-based build system. This tutorial assumes you will place this workspace inside of a directory named ~/Wonderland, although you are free to place it anywhere. To download the source, inside a terminal window from your home directory, after you have created the Wonderland subdirectory:

% cd ~/Wonderland
% cvs -d :pserver:<username>@cvs.dev.java.net:/cvs checkout lg3d-wonderland

where you should replace <username> with your java.net user name.

Download the lg3d-wonderland-art workspace (optional)

The lg3d-wonderland-art workspace contains all of the compiled artwork resources used in the default (MPK20) world provided with Project Wonderland. This artwork also resides over the Internet at 192.18.37.42, and by default, Project Wonderland will look there to download the resources. You also have the ability (see Configuring Project Wonderland below) to have the client load the artwork resources locally.

Inside a terminal window:

% cd ~/Wonderland
% cvs -d :pserver:<username>@cvs.dev.java.net:/cvs checkout lg3d-wonderland-art

where you should replace <username> with your java.net user name.

Download the wonderland-modules workspace (optional)

The wonderland-modules workspace (see http://wonderland-modules.dev.java.net) contains a collection of optional add-on modules--for example, the PDF Viewer, and the audio and video recorder--for Project Wonderland. The source for these add-on modules is available via a subversion workspace. If you place the wonderland-modules workspace in the proper location (as shown below), the lg3d-wonderland workspace will know how to compile these add-on modules and include them in the Wonderland client and server software.

You should place your wonderland-modules workspace in the same directory as your lg3d-wonderland workspace (e.g. ~/Wonderland). Inside of a terminal window:

% cd ~/Wonderland
% svn checkout https://wonderland-modules.dev.java.net/svn/wonderland-modules/trunk wonderland-modules --username <username>

where you should replace <username> with your java.net user name.

Configuring Project Wonderland

The Project Wonderland software should require little configuration, if any at all. The configuration options are stored within a properties file within the lg3d-wonderland directory. The comprehensive list of properties and default values are stored within the build.properties file.

You can override any of these properties by creating a my.build.properties file in the lg3d-wonderland directory. Each entry is a key=value pair. The following describes some of properties that are commonly customized.

sgs.host

If you plan on running the Wonderland server on the same machine as the Wonderland client (for example, for testing purposes), you may leave this property as-is. Otherwise, you should set the IP address of your server.

For example,

sgs.host=18.203.0.46

wonderland.wfs.root

This property sets the URL of the location of the WFS that describes the world. By default, it is set to file:${src.dir}/worlds/default-wfs, where {src.dir} is typically _lg3d-wonderland/src. If you wish your world to be created from your own WFS, modify this property, for example:

wonderland.wfs.root=file:~/my-wfs

on Linux/Unix/Mac OS X and

wonderland.wfs.root=file://C:\my-wfs

on Windows.

Or if your WFS is located over the Internet inside an archive file:

wonderland.wfs.root=http://my.server.com/my-wfs.jar

wonderland.art.url.base

By default, each Wonderland client looks for artwork resources in a repository located at http://192.18.37.42/trunk/lg3d-wonderland-art/compiled_models. If you wish to use another repository, perhaps hosted by a web server on your own machine, override this property.

For example,

wonderland.art.url.base=http://127.0.0.1/my_models

Note that the wonderland.useLocalArt must be set to false in order for Wonderland to look for art remotely.

wonderland.useLocalArt and wonderland.art.url.local

When used in conjunction, these two parameters can be used to instruct Wonderland to use resources located locally. To use local artwork resources, first set the wonderland.useLocalArt property to true and set the wonderland.art.url.local property to the URL of the local artwork. By default, wonderland.art.url.local is set to ${wonderland.art.dir}/compiled_models, which is the lg3d-wonderland-art workspace if you chose to download it.

For example,

wonderland.useLocalArt=true
wonderland.art.url.local=file:~/my-models/compiled_models

on Linux/Unix/Mac OS X and

wonderland.useLocalArt=true
wonderland.art.url.local="file://C:\my-models\compiled_models

on Windows.

Building Project Wonderland

You can build the Project Wonderland source code (and the optional add-on modules if you chose to download the wonderland-modules workspace) by running the ant command in a terminal window:

% ant

Running Project Wonderland

You can run Project Wonderland by using ant targets provided by the build system. If you are debugging Project Wonderland, it is best to open three terminal windows and start the Wonderland server, voice bridge, and Wonderland client in separate terminal windows.

In one terminal:

% ant run-sgs

in a second terminal:

% ant run-bridge

In a third terminal:

% ant run

You should see the Wonderland client appear and ask for log in information (you can use an empty password by default).

Where to Next?

Once you have downloaded, configured, compiled, and ran Project Wonderland from the source code, you can explore the default world provided with the distribution. To learn how to navigate and use the features of Wonderland, read the User's Guide and also this Quick Reference Sheet.

If you are ready to develop content or extend Project Wonderland, visit the Project Wonderland Wiki for detailed documentation.

<-- This creates the navigation links to :  Home | Help | Index | etc.  -->

Download, Configure, Build and Run from the Wonderland Source

<-- Your JavaDesktop? article goes here. Please try to include at least one sentence describing this topic. -->

<-- Also please try to include at least one sentence describing where each link goes. -->

<-- Please make sure some other page points to your new article so that others can find it! -->

<-- For more on how to write Javapedia articles please read the WritingArticles? page. -->