User Documentation

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
 
(108 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{Template:Quicklinks}}
+
__NOTOC__
 +
{{Quicklinks}}
  
[[Technical Reference | Technical Reference]] -> [[Technical Reference/terms | Terms]] -> [[User_Documentation | User Documentation]]
+
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]].
  
==Initial Setup==
+
For a summary of what features have been implemented in OpenSimulator, please see the [[Feature Matrix]].
 +
 
 +
{| width="100%" cellpadding=10 margin: 10px 10px 10px 10px;
 +
|-
 +
|valign="top" |
 +
{{Portal_Part|Setup|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 
* [[Download]] - Download instructions
 
* [[Download]] - Download instructions
* [[Dependencies]] - The other packages you need to install that OpenSim relies upon
+
* [[Dependencies]] - The other packages you need to install that OpenSimulator relies upon
* [[Build Instructions]] - How to build and compile OpenSim from Source
+
* [[Build Instructions]] - How to build and compile OpenSimulator from source
* [[Configuration]] - How to configure your OpenSim server up and running
+
* [[Configuration]] - How to configure OpenSimulator so you can get the server up and running
* [[Upgrading]] - How to upgrade your OpenSim version so that you can use your existing data
+
* [[Configuring Regions]] - More details on configuring regions in Regions.ini
* [[Connecting]] - How to connect a compatible viewer to OpenSim
+
* [[Configuring Simulator Parameters]] - More details on the structure and configuration simulator parameters after the initial setup.
* [[Troubleshooting]] - How to trouble shoot your OpenSim installation.
+
* [[Direct Service Requests]] - Details on how some requests that are by default handled by the viewer (e.g. GetTexture capability) could instead be handled directly by the service.
 +
* [[Shared Services Configuration]] - An approach for sharing user, asset and inventory services between two otherwise separate grids.
 +
* [[Database Settings]] - Detailed configurations to connect to your database
 +
* [[Map]] - Information on configuring OpenSimulator to serve map tiles.
 +
* [[Estate Support]] - Information about estates in OpenSimulator.
 +
* [[Economy]] - Information (incomplete) on setting up the economy aspects of OpenSimulator (e.g. land sales).
 +
* [[UserProfiles]] - Information on enabling the user profiles support included with OpenSimulator 0.7.6 onwards.
 +
* [[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.
 
* [[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.
 
* [[FAQ]] - Frequently Asked Questions
 
* [[FAQ]] - Frequently Asked Questions
* [[Technical Reference]] - Technical Reference Guide
+
{{Div col end}}
 +
}}
 +
{{Portal_Part|Optional Features|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[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 OpenSimulator.
 +
* [[Mumble]] - Using Mumble/Whisper for voice in OpenSimulator.
 +
* [[Enabling Groups]] - How to enable creating groups in your regions.
 +
* [[JsonStore Module]] - Module for storing and sharing structured data among region modules and scripts.
 +
* [[MuteList|MuteList Module]] - OpenSimMutelist is an add-on mutelist module for use with the Open Simulator project.
 +
* [[Offline_Instant_Messaging_v2|Offline Instant Messaging]] - Module to store and later replay instant messages received by users that are offline.
 +
* [[Trees Module]] - Module to populate region with different trees.
 +
{{Div col end}}
 +
}}
  
==Administrator Guide==
 
* [[Server Commands]] - Commands to control OpenSim
 
* [[OpenSim Database support]] - Dealing with databases
 
* [[Logging]] - Logging in OpenSim
 
* [[Custom Libraries]] - Describes how to add custom content to your OpenSim server
 
* [[Automating Tasks]] - How to make administrating a walk in the park
 
* [[Network Settings]] - NAT, Ports, Services and more...
 
* [[Management]] - All about being an effective administrator/moderator
 
* [[RemoteAdmin]] - Using the XMLRPC administration interface for executing commands remotely
 
* [[Performance]] - How to tweak OpenSim's performance
 
* [[Console-less OpenSim]] - How to run OpenSim without console
 
* [[Backups]] - How to backup your OpenSim data.
 
  
==Core Facilities==
+
{{Portal_Part|RealXtend (abandoned)|
* [[OpenSim Archives]] - Loading and saving whole region archives with OpenSim
+
The RealXtend modules for OpenSimulator have not been updated for a long time and should be considered dead.  However, this information may be useful for historical purposes.
* [[Inventory Archives|OpenSim Inventory Archives]] - Loading and saving user inventory items and folders with OpenSim
+
{{Div col|colwidth=12em|rules=yes|gap=1em}}
* [[IRCBridgeModule]] - A core OpenSim module for integrating IRC with a simulator.
+
* [[ModRex]] - How to setup the RealXtend server module
 +
* [[RealXtend Viewer Linux]] - This tutorial describes how to use the RealXtend viewer on Linux, using wine
 +
{{Div col end}}
 +
}}
 +
 
 +
|valign="top" width="50%"|
 +
 
 +
{{Portal_Part|Core Features|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[Feature Matrix]] - Matrix of features currently implemented by OpenSimulator.
 +
* [[Access Control]] - Controlling user access to OpenSimulator.
 +
* [[Attachments]] - Some information about avatar attachments.
 +
* [[Scripting Documentation]] - Everything you need to know about OpenSimulator scripting, and the list of sample scripts
 +
* [[ScriptEngines]] - Information about OpenSimulator's script engine.
 +
* [[OpenSim Archives]] - Loading and saving whole region archives with OpenSimulator
 +
* [[Inventory Archives|OpenSimulator Inventory Archives]] - Loading and saving user inventory items and folders with OpenSimulator
 +
* [[Mesh]] - Mesh support in 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
 
* [[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 OpenSimulator.
 +
* [[Media On A Prim]] - Media on a prim (shared media) functionality in OpenSimulator.
 +
* [[Varregion]] - Support for regions greater (or smaller!) than 256m x 256m.  Requires a compatible viewer.
 +
* [[:Category:Tech Reference|Technical Reference]] - Technical Reference Guide
 +
{{Div col end}}
 +
}}
  
==RealXtend==
+
{{Portal_Part|Troubleshooting|
* [[ModRex]] - How to setup the RealXtend server module
+
{{Div col|colwidth=12em|rules=yes|gap=1em}}
* [[RealXtend Viewer Linux]] - This tutorial describes how to use the RealXtend viewer on Linux, using wine
+
* [[Troubleshooting]] - General troubleshooting tips and links to other pages.
* [[Naali Viewer Linux]] - Describes how to compile the Naali viewer on a Kubuntu system
+
* [[Appearance Troubleshooting]] - Troubleshooting appearance specific issues (cloudy and grey avatars).
==Scripting==
+
{{Div col end}}
* [[Scripting Documentation]] - Everything you need to know about OpenSim scripting
+
}}
* [[Scripting Library]] - A list of example scripts
+
  
==Tutorials==
+
{{Portal_Part|User Guide|
===Platform specific===
+
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[Connecting]] - How to connect a compatible viewer to OpenSimulator.
 +
* [[Glossary]] - A glossary of terms used in OpenSimulator.
 +
{{Div col end}}
 +
}}
 +
 
 +
{{Portal_Part|Integration|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[RemoteAdmin]] - Using the XMLRPC administration interface for executing commands remotely.
 +
* [[AuthIntegration]] - How to integrate external systems (such as web frontends) with OpenSimulator.
 +
* [[UserManipulation]] - How to create users in OpenSimulator via external calls through ROBUST (only available when running in grid configuration).
 +
* [[CABP And Attachments Manipulation]] - How to change clothing and body parts on offline avatars via ROBUST service calls.
 +
* [[Known Web Interfaces within OpenSim]] - The set of [[CAPS]], XMLRPC, or REST entry points in the project.
 +
{{Div col end}}
 +
}}
 +
 
 +
{{Portal_Part|Administrator Guide|
 +
{{Div col|colwidth=12em|rules=yes|gap=1em}}
 +
* [[Server Commands]] - Commands to control OpenSimulator
 +
* [[OpenSim.exe Command Line Options]] - Switches when you launch OpenSimulator.
 +
* [[Directory Structure]] - Information about OpenSimulator's directory structure.
 +
* [[Useful Queries]] - Some useful queries for manipulating the OpenSimulator database.
 +
* [[Logging]] - Logging in OpenSimulator
 +
* [[Monitoring]] - Monitoring OpenSimulator
 +
* [[Threading]] - Information on the way that threads are used in OpenSimulator, including information on the thread tracking report.
 +
* [[Automating Tasks]] - How to make administrating a walk in the park
 +
* [[RestConsole]] - Using the remote console.
 +
* [[Performance]] - How to tweak OpenSim's performance and some tips on scaling.
 +
* [[Console-less OpenSim]] - How to run OpenSimulator without console
 +
* [[Backups]] - How to backup your OpenSimulator data.
 +
* [[AssetCache]] - Information about OpenSimulator's asset cache.
 +
{{Div col end}}
 +
}}
 +
 
 +
|}
 +
 
 +
== 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 ===
 +
* [[OSHT]] - OpenSim HowTo: Configuring a Grid. This tutorial describes how to install and configure OpenSimulator in grid mode on a Linux platform.
 
* [[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 OpenSim viewer (Linux)
+
* [[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 OpenSim server] - Quick and Dirty setup on an openSUSE 11.1 server
+
* [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]]
  
 
* [http://chapter-and-metaverse.blogspot.com Chapter & Metaverse] - Full suite of tutorials, tips and tricks, for the Windows user (Windows) Also very useful for Linux users!
 
* [http://chapter-and-metaverse.blogspot.com Chapter & Metaverse] - Full suite of tutorials, tips and tricks, for the Windows user (Windows) Also very useful for Linux users!
  
===Cross-platform===
+
* [http://opensimulator.org/wiki/User:Emperor_Starfinder How to install osmodules on Windows using IIS] - How to install osmodules on windows using IIS
* [[OSGrid Region Registration]] - Describes how to link your region into OS-Grid
+
* [[Collectd]] Generate Serverstats using  Collectd
* [[Hints & Tricks]] - A page for Hints and Tricks
+
 
* [[Getting Started with Region Modules]] - The Hello World of OpenSim application development
+
=== Cross-platform ===
* [[Building a bot]] - Getting started with bot design using libomv from the client side.
+
* [[Getting Started with Region Modules]] - The Hello World of OpenSimulator application development
* [[pCampBot]] - Physical OpenSim bots
+
 
* [[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 OpenSimulator Server System on Linux] by NSL (Sorry, Japanese text only)
  
==Gforge Projects==
+
=== Application ===
* [[OpenSimSearch]] - Search for your OpenSim
+
* [http://www.scribd.com/doc/57959626/OpenSimulator-School-Quick-Start-Guide 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.
* [[ServerStats]] - RRD/Proc serverstats using the OpenSim module for Berlios Serverstats (Linux)
+
  
==Contribution Policy==
 
* [[User_Wiki_Conventions|User Wiki Conventions]] - Read this carefully, before adding content to the wiki
 
  
  
 +
 +
<!--
 +
<cleanpage title=hide cats=hide />
 +
[[Category:Portals]]
 
[[Category:Users]]
 
[[Category:Users]]
 
[[Category:Support]]
 
[[Category:Support]]
[[Category:Tech Reference]]
 
 
[[Category:Help]]
 
[[Category:Help]]
 
[[Category:Configuration]]
 
[[Category:Configuration]]
[[Category:Getting_Started]]
+
[[Category:Getting Started]]
 
[[Category:Development]]
 
[[Category:Development]]
<cleanpage title=hide cats=hide />
+
-->

Latest revision as of 05:52, 9 April 2019

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.

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.
  • Direct Service Requests - Details on how some requests that are by default handled by the viewer (e.g. GetTexture capability) could instead be handled directly by the service.
  • Shared Services Configuration - An approach for sharing user, asset and inventory services between two otherwise separate grids.
  • Database Settings - Detailed configurations to connect to your database
  • Map - Information on configuring OpenSimulator to serve map tiles.
  • Estate Support - Information about estates in OpenSimulator.
  • Economy - Information (incomplete) on setting up the economy aspects of OpenSimulator (e.g. land sales).
  • UserProfiles - Information on enabling the user profiles support included with OpenSimulator 0.7.6 onwards.
  • 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.
  • 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
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.
  • JsonStore Module - Module for storing and sharing structured data among region modules and scripts.
  • MuteList Module - OpenSimMutelist is an add-on mutelist module for use with the Open Simulator project.
  • Offline Instant Messaging - Module to store and later replay instant messages received by users that are offline.
  • Trees Module - Module to populate region with different trees.


RealXtend (abandoned)

The RealXtend modules for OpenSimulator have not been updated for a long time and should be considered dead. However, this information may be useful for historical purposes.

  • ModRex - How to setup the RealXtend server module
  • RealXtend Viewer Linux - This tutorial describes how to use the RealXtend viewer on Linux, using wine
Core Features
  • Feature Matrix - Matrix of features currently implemented by OpenSimulator.
  • Access Control - Controlling user access to OpenSimulator.
  • Attachments - Some information about avatar attachments.
  • Scripting Documentation - Everything you need to know about OpenSimulator scripting, and the list of sample scripts
  • ScriptEngines - Information about OpenSimulator's script engine.
  • OpenSim Archives - Loading and saving whole region archives with OpenSimulator
  • OpenSimulator Inventory Archives - Loading and saving user inventory items and folders with OpenSimulator
  • Mesh - Mesh support in 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.
  • Media On A Prim - Media on a prim (shared media) functionality in OpenSimulator.
  • Varregion - Support for regions greater (or smaller!) than 256m x 256m. Requires a compatible viewer.
  • Technical Reference - Technical Reference Guide
Troubleshooting
User Guide
  • Connecting - How to connect a compatible viewer to OpenSimulator.
  • Glossary - A glossary of terms used in OpenSimulator.
Integration
Administrator Guide

[edit] 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.

[edit] Platform specific

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

[edit] Cross-platform

[edit] Application



Personal tools
General
About This Wiki