OpenWonderland

This material is distributed under the GNU General Public License Version 2. _To obtain a copy of the original source code, make a request on the Wonderland Forum.

Open Wonderland Documentation Wiki

Everyone | Users | Sys Admins | Content Developers | Developers | Students | Historic |

For Everyone

Open Wonderland web site
The web site contains FAQs, pointers to community resources, instructions on downloading software, and many other helpful resources

Wonderblog
The blog features articles from the open source community describing projects and events related to Open Wonderland.

Community Wiki
This wiki contains a constantly growing collection of documentation, notes from community meetings, video links, and other useful resources.

For Users

Launching the Client
This tutorial describes how users launch the Open Wonderland client using Java(TM) Web Start.

Quickstart Guides
This set of very short guides provides a brief introduction to the basic features of Open Wonderland. These guides are also available in-world from the Help menu.

Learning the Basics
Introductory user-focused tutorial explaining how to start Wonderland and use the basic features.

Troubleshooting and Testing
This document contains troubleshooting information applicable to everyone as well as more advanced topics for system administrators and developers.

Troubleshooting Tips
Tips for handling a variety of problems new users might encountered running Wonderland.

Client Hardware Performance
This page lists the reported performance of various hardware and software configurations with Open Wonderland

For System Administrators

Wonderland Module Warehouse
Collection of Wonderland "apps" available to download and install in your own Wonderland server.

Download and Install Wonderland
Leads you step-by-step to download, install, configure, and run Open Wonderland.

Wonderland Server Administration Console Guide
A reference guide for configuring and administering the Open Wonderland server via a web-based interface.

Firewall Configuration
This tutorial describes how to configure Open Wonderland if your server is behind a firewall or NAT.

Configuring Authentication
This tutorial describes how to configure authentication for Open Wonderland

Connecting to the Telephone Network
This guide explains how to connect a Wonderland installation to the telephone network. For original documentation see: Project Wonderland Phone Setup Guide and Telephone Integration

Creating Backups
Several strategies for backing up your Wonderland worlds.

Sys Admin Tips
Some tips for managing Wonderland-related processes.

World Builder Installation and Usage
This guide covers how to install the World Builder module and how to use the Builder

For Content Developers

Importing 3D Models
This tutorial provides an introduction to importing existing 3D models into Open Wonderland.

Assembling Worlds
This tutorial provides an introduction to assembling worlds. You may insert new objects into your world and move, rotate, and resize them.

Building an Open Wonderland World From Scratch
This tutorial explains how to start with an empty world, populate it with content, and save a snapshot.

Creating and Importing Artwork for Non-Artists
Learn to use Google SketchUp to create simple, but attractive 3D models and import them into Wonderland.

Using Capabilities
This is a reference guide covering the default capabilities that come bundled with Wonderland as well as the common optional capabilities.

Creating Posters
This guide describes how to create in-world posters that include links to external content as well as links to locations within the virtual world.

ExportingBlenderModels
Matthew Schmidt provides advice on how to export models from Blender to import into Wonderland.

Saving Work with Subsnapshots
This blog post explains Subsnapshots and how to use this import/export functionality to save work on your own computer.

For Developers

Open Wonderland: Extensible Virtual World Architecture
This IEEE Internet Computing paper provides a high-level overview of the Wonderland architecture.

Download, Build, Configure, and Run from the Source Code
This tutorial provides an introduction for all developers: how to download and compile the source code, configure the Wonderland distribution, and run both the server and client.

Download, Build, and Deploy Optional Modules from the Source Code
This tutorial describes how developers can download and compile the source code, and deploy the optional add-on modules.

Open Wonderland Core APIs
JavaDoc reference for all core packages and classes.

Communications Architecture
This document describes the Open Wonderland extensible communication architecture.

Developing With NetBeans
This page describes how to use NetBeans to develop, run and debug Wonderland 0.5.

Working with Modules
This tutorial describes the basics of the Open Wonderland module system and how to install modules. Modules allow developers to extend the functionality of the platform by providing custom code and/or content. The community wiki has some notes on Using a database in a module at the server-side.

Tutorial for Beginners
These two tutorials (Part 1, Part 2) by Douglas Finnigan provide a high-level introduction to Open Wonderland for developers, describing basic concepts for all of its technologies.

Developing a New Cell
The primary means to extend Open Wonderland is by developing a new kind of Cell. There are a number of tutorials, from basic and advanced on this page. The following four-part tutorial series goes in-depth for developers on how to create a new Cell: Part 1, Part 2, Part 3, Part 4.

Developing a New Cell Component (aka Capability)
In this tutorial, you will learn how to develop new cell components. A cell component is add-on functionality that can be attached to any kind of cell.

Writing 2D Applications
This tutorial describes how to develop 2D applications in-world that use the Java Swing GUI toolkit.

Writing a Client or Server "Plugin"
This tutorial describes how to write client and server plugins for Open Wonderland. Plugins are code that runs when either the client or server is first initialized.

Sample HUD Tutorial
This tutorial describes the basics of creating a window on the HUD (Heads-up display).

Developing a HUD-enabled module
This more advanced tutorial describes how to develop a more complex module that displays a window on the HUD (Heads-up display).

Adding Entries to the Context Menu
This tutorial describes how to add entries to the right-click context menu.

How to Create Modules from Snapshots
Learn how to convert a snapshot into a module that will show up in the "Initial Worlds" section of the Manage Worlds page in the Server Admin Console.

ChangingTheSkybox
This brief tutorial explains how, as a developer building from source, you can easily change the skybox.

EZ Script
Documentation for the EZScript module, one of two scripting options for Open Wonderland. Click on the "Cell Scripting" tab.

Scripting
The Open Wonderland Scripting sub-group maintains a Google Group to discuss scripting related issues. To get started with scripting, refer to the collection of scripting tutorials, including a guide to Scripting Commands.

jMonkeyEngine (jME) Resources
This page provides a collection of web links to tutorials and documentation for jMonkeyEngine, the 3D rendering API used by Open Wonderland.

MT-Game Programming Guide
Programming guide for the MT (Multi-Threaded) Game layer on top of jMonkeyEngine (document source, download PDF)

jVoiceBridge Developer's Guide
This guide covers topics such as building and running the voice bridge, configuring a VoIP to PSTN gateway, parameters for call setup, technical specs, and troubleshooting help.

Community Documentation
A wiki containing documents for features being worked on by the community including Development Tips and Tricks, System Admin Tips, and Group Security Tips. (Old Community Wiki)

Version 0.5 Technical Documents
A wiki containing technical documents and plans for Open Wonderland v0.5

For Students

Project Ideas for Students (and others)
An ever-growing list of Wonderland projects, organized by level-of-effort, suitable for students or others interesting in extending Wonderland.

Historic

(documents are now out-of-date)

Project Roadmap and Release Plan Estimates
Our best guess at the timeframes for the upcoming releases and what will be included in them

Multimedia Resources
This page has a collection of videos, presentations, screenshots, and web resources on Open Wonderland.

Feature Wish List
This page has a collection of proposals for new small-scale features in Open Wonderland, suggested both by the core team and the community.

Proposals
This page has a collection of proposals for new large-scale features in Open Wonderland, suggested both by the core team and the community.