Revision as of 14:14, 2 January 2012

 

Home

 

Download

 

News

 

Support

 

Admin

 

Dev

 

Screen Shots

 

Grid List

 

Bugs

Languages:

English    Deutsch    Français    日本語

Introduction

This is user documentation for OpenSimulator, mainly aimed towards administrators of the system rather than the ultimate end-users who access the environment through a viewer. If you can't find what you want here you might want to try looking in the Developer Documentation.

For a summary of what features have been implemented in OpenSimulator, please see the Feature Matrix.

Initial Setup

• Download - Download instructions
• Dependencies - The other packages you need to install that OpenSim relies upon
• Build Instructions - How to build and compile OpenSim from source
• Configuration - How to configure OpenSim so you can get the server up and running
• Configuring Regions - More details on configuring regions in Regions.ini
• Configuring Simulator Parameters - More details on the structure and configuration simulator parameters after the initial setup.
• Database Settings - Detailed configurations to connect to your database
• Upgrading - How to upgrade your OpenSim version so that you can use your existing data
• Network Settings - NAT, Ports, Services and more.
• Firewall Settings - Incomplete operating system specific instructions on how to open firewall ports for external OpenSim access.
• Troubleshooting - How to trouble shoot your OpenSim installation.
• Tips - Useful tips from users like you
• OpenSim Graphics - Graphics that can be used on OpenSimulator websites, viewer login pages or products.
• FAQ - Frequently Asked Questions

User Guide

• Connecting - How to connect a compatible viewer to OpenSim

Administrator Guide

• Server Commands - Commands to control OpenSim
• OpenSim.exe Command Line Options - Switches when you launch OpenSimulator.
• Useful_Queries - Some useful queries for manipulating the OpenSim database.
• Logging - Logging in OpenSim
• Monitoring - Monitoring OpenSim
• Automating Tasks - How to make administrating a walk in the park
• RemoteAdmin - Using the XMLRPC administration interface for executing commands remotely
• RestConsole - Using the remote console.
• Performance - How to tweak OpenSim's performance
• Console-less OpenSim - How to run OpenSim without console
• Backups - How to backup your OpenSim data.

Core Features

• Feature Matrix - Matrix of features currently implemented by OpenSim.
• Scripting Documentation - Everything you need to know about OpenSim scripting, and the list of sample scripts
• OpenSim Archives - Loading and saving whole region archives with OpenSim
• OpenSim Inventory Archives - Loading and saving user inventory items and folders with OpenSim
• NPC - Use of Non Player Characters (NPCs) in OpenSim, also known as bots.
• Custom Libraries - Describes how to add custom content to your OpenSim server
• IRCBridgeModule - A core OpenSim module for integrating IRC with a simulator.
• Hypergrid - Information about how to configure the experimental hypergrid architecture
• GridInfo - how to provide information about your grid to smart clients
• PhysicsEngines — Options for physics engines in OpenSim.
• Technical Reference - Technical Reference Guide

Optional Features

• AutoBackup - Module for automatically backing up a region to an OAR regularly using a different filename.
• Freeswitch Module - Using FreeSWITCH for voice in OpenSim.
• Mumble - Using Mumble/Whisper for voice in OpenSim.
• Enabling Groups — How to enable creating groups in your regions

Experimental Features

These are even more alpha than the rest of the code and may not currently work properly.

• Setting Up Mega-Regions

RealXtend

• ModRex - How to setup the RealXtend server module
• RealXtend Viewer Linux - This tutorial describes how to use the RealXtend viewer on Linux, using wine

Tutorials

If you've written a tutorial or guide on this wiki or on an external site, then please feel free to add a link here and/or on more specific topic pages.

Platform specific

• Linux Gridserver, the ubuntu way the quick and dirty way to install opensim under ubuntu (Linux)
• Wiimote - How to use a wiimote/nunchuk controller with the OpenSim viewer (Linux)
• Cacti - Generate Serverstats using the Cacti-Tool and SNMP (Linux)
• Installing an openSUSE 11.1 Minimal server setup for an OpenSim server - Quick and Dirty setup on an openSUSE 11.1 server
• Streaming Media in OpenSim

• Chapter & Metaverse - Full suite of tutorials, tips and tricks, for the Windows user (Windows) Also very useful for Linux users!

Cross-platform

• Getting Started with Region Modules - The Hello World of OpenSim application development
• Using L3DT - How to create custom terrains
• Detailed cross-region terrain making - A workflow for creating large cross-region custom terrains
• How to make a good Terrain (includes 4 programs to use)
• Japanese Manual for Construction of OpenSim Server System on Linux by NSL (Sorry, Japanese only)

Application

• David W. Deeds' OpenSimulator School Quick Start Guide - David W. Deeds' OpenSimulator School Quick Start Guide courtesy of Changchun American International School. Has lots of useful and interesting info, including lesson plans.

Gforge Projects

• OpenSimSearch - Search for your OpenSim
• ServerStats - RRD/Proc serverstats using the OpenSim module for Berlios Serverstats (Linux)

UNIQ348c767a1f8bd40a-cleanpage-00000000-QINU