From OpenSimulator
(Difference between revisions)
m (Robot: Cosmetic changes) |
m (Robot: Replacing 'OpenSim' to 'OpenSimulator', which is the precise name) |
||
Line 8: | Line 8: | ||
== Initial Setup == | == Initial Setup == | ||
* [[Download]] - Download instructions | * [[Download]] - Download instructions | ||
− | * [[Dependencies]] - The other packages you need to install that | + | * [[Dependencies]] - The other packages you need to install that OpenSimulator relies upon |
− | * [[Build Instructions]] - How to build and compile | + | * [[Build Instructions]] - How to build and compile OpenSimulator from source |
− | * [[Configuration]] - How to configure | + | * [[Configuration]] - How to configure OpenSimulator so you can get the server up and running |
* [[Configuring Regions]] - More details on configuring regions in Regions.ini | * [[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. | * [[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 | * [[Database Settings]] - Detailed configurations to connect to your database | ||
− | * [[Upgrading]] - How to upgrade your | + | * [[Upgrading]] - How to upgrade your OpenSimulator version so that you can use your existing data |
* [[Network Settings]] - NAT, Ports, Services and more. | * [[Network Settings]] - NAT, Ports, Services and more. | ||
− | * [[Firewall Settings]] - Incomplete operating system specific instructions on how to open firewall ports for external | + | * [[Firewall Settings]] - Incomplete operating system specific instructions on how to open firewall ports for external OpenSimulator access. |
− | * [[Troubleshooting]] - How to trouble shoot your | + | * [[Troubleshooting]] - How to trouble shoot your OpenSimulator installation. |
* [[Tips]] - Useful tips from users like you | * [[Tips]] - Useful tips from users like you | ||
* [[OpenSim Graphics]] - Graphics that can be used on OpenSimulator websites, viewer login pages or products. | * [[OpenSim Graphics]] - Graphics that can be used on OpenSimulator websites, viewer login pages or products. | ||
Line 23: | Line 23: | ||
== User Guide == | == User Guide == | ||
− | * [[Connecting]] - How to connect a compatible viewer to | + | * [[Connecting]] - How to connect a compatible viewer to OpenSimulator |
== Administrator Guide == | == Administrator Guide == | ||
− | * [[Server Commands]] - Commands to control | + | * [[Server Commands]] - Commands to control OpenSimulator |
* [[OpenSim.exe Command Line Options]] - Switches when you launch OpenSimulator. | * [[OpenSim.exe Command Line Options]] - Switches when you launch OpenSimulator. | ||
− | * [[Useful Queries]] - Some useful queries for manipulating the | + | * [[Useful Queries]] - Some useful queries for manipulating the OpenSimulator database. |
− | * [[Logging]] - Logging in | + | * [[Logging]] - Logging in OpenSimulator |
− | * [[Monitoring]] - Monitoring | + | * [[Monitoring]] - Monitoring OpenSimulator |
* [[Automating Tasks]] - How to make administrating a walk in the park | * [[Automating Tasks]] - How to make administrating a walk in the park | ||
* [[RemoteAdmin]] - Using the XMLRPC administration interface for executing commands remotely | * [[RemoteAdmin]] - Using the XMLRPC administration interface for executing commands remotely | ||
* [[RestConsole]] - Using the remote console. | * [[RestConsole]] - Using the remote console. | ||
* [[Performance]] - How to tweak OpenSim's performance | * [[Performance]] - How to tweak OpenSim's performance | ||
− | * [[Console-less OpenSim]] - How to run | + | * [[Console-less OpenSim]] - How to run OpenSimulator without console |
− | * [[Backups]] - How to backup your | + | * [[Backups]] - How to backup your OpenSimulator data. |
== Core Features == | == Core Features == | ||
− | * [[Feature Matrix]] - Matrix of features currently implemented by | + | * [[Feature Matrix]] - Matrix of features currently implemented by OpenSimulator. |
− | * [[Scripting Documentation]] - Everything you need to know about | + | * [[Scripting Documentation]] - Everything you need to know about OpenSimulator scripting, and the list of sample scripts |
− | * [[OpenSim Archives]] - Loading and saving whole region archives with | + | * [[OpenSim Archives]] - Loading and saving whole region archives with OpenSimulator |
− | * [[Inventory Archives| | + | * [[Inventory Archives|OpenSimulator Inventory Archives]] - Loading and saving user inventory items and folders with OpenSimulator |
* [[NPC]] - Use of Non Player Characters (NPCs) in OpenSim, also known as bots. | * [[NPC]] - Use of Non Player Characters (NPCs) in OpenSim, also known as bots. | ||
− | * [[Custom Libraries]] - Describes how to add custom content to your | + | * [[Custom Libraries]] - Describes how to add custom content to your OpenSimulator server |
− | * [[IRCBridgeModule]] - A core | + | * [[IRCBridgeModule]] - A core OpenSimulator module for integrating IRC with a simulator. |
* [[Hypergrid]] - Information about how to configure the experimental hypergrid architecture | * [[Hypergrid]] - Information about how to configure the experimental hypergrid architecture | ||
* [[GridInfo]] - how to provide information about your grid to smart clients | * [[GridInfo]] - how to provide information about your grid to smart clients | ||
− | * [[PhysicsEngines]] — Options for physics engines in | + | * [[PhysicsEngines]] — Options for physics engines in OpenSimulator. |
* [[:Category:Tech Reference|Technical Reference]] - Technical Reference Guide | * [[:Category:Tech Reference|Technical Reference]] - Technical Reference Guide | ||
== Optional Features == | == Optional Features == | ||
* [[Feature Proposals/AutoBackup|AutoBackup]] - Module for automatically backing up a region to an OAR regularly using a different filename. | * [[Feature Proposals/AutoBackup|AutoBackup]] - Module for automatically backing up a region to an OAR regularly using a different filename. | ||
− | * [[Freeswitch Module]] - Using FreeSWITCH for voice in | + | * [[Freeswitch Module]] - Using FreeSWITCH for voice in OpenSimulator. |
− | * [[Mumble]] - Using Mumble/Whisper for voice in | + | * [[Mumble]] - Using Mumble/Whisper for voice in OpenSimulator. |
* [[Enabling Groups]] — How to enable creating groups in your regions | * [[Enabling Groups]] — How to enable creating groups in your regions | ||
Line 73: | Line 73: | ||
=== Platform specific === | === Platform specific === | ||
* [[Linux Gridserver, the ubuntu way]] the quick and dirty way to install opensim under ubuntu (Linux) | * [[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 | + | * [[Wiimote]] - How to use a wiimote/nunchuk controller with the OpenSimulator viewer (Linux) |
* [[Cacti]] - Generate Serverstats using the Cacti-Tool and SNMP (Linux) | * [[Cacti]] - Generate Serverstats using the Cacti-Tool and SNMP (Linux) | ||
− | * [http://sunredbeach.com/dokuwiki/doku.php?id=opensim:minimal-server Installing an openSUSE 11.1 Minimal server setup for an | + | * [http://sunredbeach.com/dokuwiki/doku.php?id=opensim:minimal-server Installing an openSUSE 11.1 Minimal server setup for an OpenSimulator server] - Quick and Dirty setup on an openSUSE 11.1 server |
* [[Streaming Media in OpenSim]] | * [[Streaming Media in OpenSim]] | ||
Line 81: | Line 81: | ||
=== Cross-platform === | === Cross-platform === | ||
− | * [[Getting Started with Region Modules]] - The Hello World of | + | * [[Getting Started with Region Modules]] - The Hello World of OpenSimulator application development |
* [[Using L3DT]] - How to create custom terrains | * [[Using L3DT]] - How to create custom terrains | ||
* [[Detailed cross-region terrain making]] - A workflow for creating large cross-region custom terrains | * [[Detailed cross-region terrain making]] - A workflow for creating large cross-region custom terrains | ||
* [http://update.multiverse.net/wiki/index.php/About_Terrain How to make a good Terrain (includes 4 programs to use)] | * [http://update.multiverse.net/wiki/index.php/About_Terrain How to make a good Terrain (includes 4 programs to use)] | ||
− | * [http://www.nsl.tuis.ac.jp/xoops/modules/d3downloads/index.php?page=singlefile&cid=8&lid=22 Japanese Manual for Construction of | + | * [http://www.nsl.tuis.ac.jp/xoops/modules/d3downloads/index.php?page=singlefile&cid=8&lid=22 Japanese Manual for Construction of OpenSimulator Server System on Linux] by NSL (Sorry, Japanese only) |
=== Application === | === Application === | ||
Line 91: | Line 91: | ||
== Gforge Projects == | == Gforge Projects == | ||
− | * [[OpenSimSearch]] - Search for your | + | * [[OpenSimSearch]] - Search for your OpenSimulator |
− | * [[ServerStats]] - RRD/Proc serverstats using the | + | * [[ServerStats]] - RRD/Proc serverstats using the OpenSimulator module for Berlios Serverstats (Linux) |
<cleanpage title=hide cats=hide /> | <cleanpage title=hide cats=hide /> | ||
Revision as of 23:03, 3 March 2012
Contents |
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 OpenSimulator relies upon
- Build Instructions - How to build and compile OpenSimulator from source
- Configuration - How to configure OpenSimulator 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 OpenSimulator 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 OpenSimulator access.
- Troubleshooting - How to trouble shoot your OpenSimulator 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 OpenSimulator
Administrator Guide
- Server Commands - Commands to control OpenSimulator
- OpenSim.exe Command Line Options - Switches when you launch OpenSimulator.
- Useful Queries - Some useful queries for manipulating the OpenSimulator database.
- Logging - Logging in OpenSimulator
- Monitoring - Monitoring OpenSimulator
- 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 OpenSimulator without console
- Backups - How to backup your OpenSimulator data.
Core Features
- Feature Matrix - Matrix of features currently implemented by OpenSimulator.
- Scripting Documentation - Everything you need to know about OpenSimulator scripting, and the list of sample scripts
- OpenSim Archives - Loading and saving whole region archives with OpenSimulator
- OpenSimulator Inventory Archives - Loading and saving user inventory items and folders with OpenSimulator
- NPC - Use of Non Player Characters (NPCs) in OpenSim, also known as bots.
- Custom Libraries - Describes how to add custom content to your OpenSimulator server
- IRCBridgeModule - A core OpenSimulator 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 OpenSimulator.
- 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 OpenSimulator.
- Mumble - Using Mumble/Whisper for voice in OpenSimulator.
- 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.
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 OpenSimulator viewer (Linux)
- Cacti - Generate Serverstats using the Cacti-Tool and SNMP (Linux)
- Installing an openSUSE 11.1 Minimal server setup for an OpenSimulator 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 OpenSimulator 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 OpenSimulator 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 OpenSimulator
- ServerStats - RRD/Proc serverstats using the OpenSimulator module for Berlios Serverstats (Linux)
UNIQ1cae7cd3c3f5afc-cleanpage-00000000-QINU