OpenSimulator - User contributions [en]

OpenSim.Region.ScriptEngine.Common

2010-10-22T18:50:18Z

Tedd:

__NOTOC__
{{Template:Quicklinks}}
 

=WARNING! THIS PAGE IS OBSOLETE! ScriptEngine has been replaced by xengine!=

=OpenSim.Region.ScriptEngine.Common=

==How to implement your own script engine==
Creating a new script engine for OpenSim is simple (haha). 
What I mean by simple is that if you already have a VM (Virtual Machine) or script engine of some sort then integrating it as a OpenSim ScriptEngine plugin is simple. 
 

===What do I get for free?===
1. Loading/unloading of scripts are queued and executed in sequence. Only one load/unload at the time. 
 
2. What script belongs to what object is automatically taken care of. You just need to provide the scripts classes - nothing else. 
 
3. OpenSim events are translated and given to you as LSL events. Your script functions are executed automatically, no need to hook up to events or anything. 
If you want to implement your own event handlers, feel free to do so. Look in "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.EventManager.cs" how its done. Your own events can run together with LSL events without any problem. 
 
4. Whenever an event is executed, the execution is queued. Only one event per script is ever executed simultaneous. But multithreading is used to run multiple scripts in parallel. 
 
5. Errors during script execution is automatically handled and relayed to users in-world. 
 
6. You get all LSL commands in an easy to use object, no need to keep track of scene or objects to execute functions. Running an LSL command from your script engine is as easy as running it from inside any LSL-script. 
 
7. Long LSL-commands that returns with an event is also handled. 

===Getting started===
1. Create a new project named "OpenSim.Region.MySuperScriptEngine" (replace "MySuperScriptEngine" with the name of your scriptengine). 
2. Create a new class (file) named "ScriptEngine". It must be named exactly ScriptEngine for OpenSim to use it. ScriptEngine must inherit from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine". 
3. You need to override a couple of functions. Most probably you don't want to do any special work here, so look below for a sample default file. 
4. Create a new class (file) named "ScriptManager" that inherits from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager". 
5. Your ScriptManager class needs to override two functions. One to start a script and one to stop a script. 

===ScriptEngine class===
The main purpose of ScriptEngine class is to be able to intercept scene, for example starting with a "fake" scene instead of OpenSim's scene. You probably don't want this, so just go for the standard initialization. 
A standard class would look like this: 
using System;
using Nini.Config;
using OpenSim.Framework.Console;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.ScriptEngine.MySuperScriptEngine
{
[Serializable]
public class ScriptEngine : OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine
{
public override void Initialise(Scene scene, IConfigSource config)
{
InitializeEngine(scene, MainLog.Instance, true, GetScriptManager());
}
public override OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager _GetScriptManager()
{
return new ScriptManager(this);
}
}
}

===ScriptManager class===
A script is refecenced by object id "localID" (the object/prim it is inside) and script id "itemID" (the particular (unique) instance of that script). These parameters along with a string "Script" containing the script text (source code) are passed to your (overriden) start script function in your ScriptManager class. 
 
Keeping track of active scripts is done automatically, so your job is simply to create a new script and hand it over. After that your work is done until the script is asked to stop, then you have to do a few simple tasks to remove it again. 
Here is a sample on a minimal script startup:
public override void _StartScript(uint localID, LLUUID itemID, string Script)
{
SceneObjectPart m_host = World.GetSceneObjectPart(localID);
try
{
IScript CompiledScript = MySpecialCompiler.DoCompile(Script); // Compile and return an IScript object that is the actual script
CompiledScript.Source = ScriptSource; // Store source for recompile on script reset events
SetScript(localID, itemID, CompiledScript); // All is ok. Add script to OpenSim's script manager. From here on its on autopilot.
// Create a private instance of LSL commands (note that m_scriptEngine, m_host are from baseclass, so you don't need to change them)
LSL_BuiltIn_Commands LSLB = new LSL_BuiltIn_Commands(m_scriptEngine, m_host, localID, itemID);
CompiledScript.Start(LSLB); // Start the script - giving it LSL commands
// Fire the first start-event, this is the event run on LSL scripts when they first start
m_scriptEngine.m_EventQueueManager.AddToScriptQueue(localID, itemID, "state_entry", EventQueueManager.llDetectNull, new object[] { });
}
catch (Exception e)
{
// To see how you can send the compile error in-world, have a look at OpenSim.Region.ScriptEngine.DotNetEngine.ScriptManager
}
}

And your minimal script shutdown would be:
public override void _StopScript(uint localID, LLUUID itemID)
{
m_scriptEngine.m_LSLLongCmdHandler.RemoveScript(localID, itemID); // Stop long command on script like timers, http requests, etc.
IScript LSLBC = GetScript(localID, itemID); // Get the script we are stopping
if (LSLBC == null) // Nothing to do? Exit.
return;
try
{
LSLBC.Exec.StopScript(); // Tell script to stop
RemoveScript(localID, itemID); // Remove script from internal memory structure
}
catch (Exception e)
{
// You probably want to log this to console or something
}
}

===IScript interface===
So you have implemented the two classes described above. Now how does this connect to your JavaScript or Perl or YourCustomSuperLanguage script engine or VM? 
 
You have to create a class. This class must inherit "OpenSim.Region.ScriptEngine.Common.IScript". Inside IScript your class will have two important things: 
 
1. During script start (in ScriptManager), you call yourscript.Start() and give it a LSL command module. So insite your script class where you override this Start() function you need to remember this LSL command module. 
How you bind this LSL command module to your custom engine is totally up to you. The LSL command module contains all LSL functions, and any function you use there will affect the correct object/region/whatever. You don't need to do more than ''myLSLCommandModule.llSay(0, "Hello world!");'' to make it work. 
 
2. Any time a LSL event is generated either by an in-world event or by for example a timer, a function in your script class needs to be executed. For this you have the "Exec" override. I suggest you have a look at "OpenSim.Region.ScriptEngine.Common.Executor" to see how this work. Basically you receive a string containing function name and the parameters for that event. 
If you use the default Executor you need to initialize it by giving it a reference to yourself (the IScript script class). Then you need to have functions in your class matching LSL functions when it comes to both name and parameters. Example: 
public touch_start(int number_of_touches) {
// whatever code for this event... probably calling your own VM's function with the same name? ;)
}

===AppDomain security===
If you are writing a .Net based script engine and want AppDomain security and loading/unloading then:
// Load script:
IScript CompiledScript = m_scriptEngine.m_AppDomainManager.LoadScript(filename);
and
// Unload script:
m_scriptEngine.m_AppDomainManager.StopScript(LSLBC.Exec.GetAppDomain());

Startup script linux

2010-03-05T11:52:28Z

Tedd:

== /etc/init.d script for Linux ==

=== Instructions ===

Tested on Debian 5. CHUIDS user to opensim user. Supports: start, stop, restart, status

To implement: Type: cat > /etc/init.d/opensim Paste in script from this page Press: CTRL+D Type: chmod +x /etc/init.d/opensim Script should now be located on server and be executable.

Type: update-rc.d opensim defaults Script should now be in your startup.

Modify header in script to adapt it to your installation folder and user.

NOTE: stop-command currently doesn't work properly (it doesn't do a soft shutdown). It will kill OpenSim first with kill pid, then kill -9 pid. So make sure you have saved your data. :)

=== Script ===

<code></code>

#! /bin/sh
### BEGIN INIT INFO
# Provides: OpenSim
# Required-Start: $local_fs $network
# Required-Stop: $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Tedds OpenSim init.d-script
### END INIT INFO

# Put script in /etc/init.d/
# then execute: update-rc.d opensim defaults

set -e

#
# Directories
#
# Location of OpenSim installation
DIR=/home/opensim/OpenSim/bin/
# Different PID dir?
PIDDIR=$DIR

USER=opensim
SERVICES="OpenSim.Grid.UserServer.exe OpenSim.Server.exe OpenSim.exe"

#
# Kill values (in seconds)
#
# How long between each service being started
DELAY_STARTUP=10
# How long between each service is sent shutdown command
DELAY_KILL=10
# After shutdown has been sent to all we do another loop with "kill", then "kill -9". How long between "kill" and "kill -9".
DELAY_FORCEKILL=10

#
# Info on service handled by this script

# Name of service
NAME=opensim
# Description of service
DESC="OpenSim Server"

# Binaries
SCREEN=/usr/bin/screen
MONO=/usr/bin/mono

###########################
##### START OF SCRIPT #####
###########################

export PATH="${PATH:+$PATH:}/usr/sbin:/sbin"

 

# Load LSB log functions
_lsbFile=""
if [ -e /etc/debian_version ]; then
_lsbFile="/lib/lsb/init-functions"
if [ -f $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
else
# [ -e /etc/init.d/functions ] ; then
_lsbFile="/etc/init.d/functions"
if [ -e $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
fi

# Lets use fancy output
log_use_fancy_output

# Check that target directory exists
if test ! -d "$DIR"; then
log_failure_msg "$NAME" "Target directory \"$DIR\" does not exist. Can not continue."
exit 1
fi

# Create a reverse order for shutdown
SERVICES_REVERSE=""
reverse() { SERVICES_REVERSE="$9 $8 $7 $6 $5 $4 $3 $2 $1"; }
reverse $SERVICES

# Check if a service is running
isrunning() {
ISRUNNING="0"
# Do we have PID-file?
if [ -f "$PIDDIR/$1.pid" ]; then
# Check if proc is running
pid=`cat "$PIDDIR/$1.pid" 2> /dev/null`
if [ "$pid" != "" ]; then
if [ -d /proc/$pid ]; then
# Process is running
ISRUNNING="1"
fi
fi
fi
#ISRUNNING="0"
}

#
# Process commands
#
case "$1" in
start)
# Start all services one by one
for server in $SERVICES; do
log_daemon_msg "Starting $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "Process already started. Please stop first"; log_end_msg 1 ;;
0)
# Process is not running
# Start process and sleep...
exefile="/tmp/exe.OpenSim.$server.sh"

# Need to make external file, had big problems with screen params
echo \#\!/bin/bash > $exefile
echo cd $DIR >> $exefile
echo $MONO $server >> $exefile
chmod +x $exefile

cmd_screen="screen -S $server -d -m $exefile"
start-stop-daemon --start -b -x /bin/su -m --pidfile=/tmp/su.$server.pid --chdir "$DIR" -- - $USER "-c $cmd_screen"

# Delay between services that are started
sleep $DELAY_STARTUP

rm $exefile 2> /dev/null

# Make PID-file
ps afxu | grep "mono $server" | grep -iEv "grep|screen" | awk {'print $2'} > "$PIDDIR/$server.pid"

isrunning $server
case "$ISRUNNING" in
1)
# Process started ok
#log_progress_msg "Success";
log_end_msg 0
 ;;
0)
# Process didn't start... remove pid-file
rm "$PIDDIR/$server.pid" 2> /dev/null
#log_progress_msg "Failure";
log_end_msg 1
 ;;
esac
 ;;
esac

done
 ;;

 

stop)
_killCount=0

for server in $SERVICES_REVERSE; do
log_daemon_msg "Stopping $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1)
_killCount=`expr $_killCount + 1`
log_progress_msg "Sending shutdown command:";

# We add some backspaces to the command in case something is on the console already
echo `screen -S $server -X stuff \"

# Wait for it to shut down...
sleep $DELAY_KILL

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "is still running."; log_end_msg 0 ;;
0) log_progress_msg "has been shutdown"; log_end_msg 0 ;;
esac

 ;;
0)
log_progress_msg "is not running"; log_end_msg 0
 ;;
esac

done

# Check if any procs are still running
for server in $SERVICES; do
isrunning $server
case "$ISRUNNING" in
1)
log_warning_msg "Stopping $NAME" "$server is still running: Forcing kill"
echo `kill $pid 2> /dev/null`;
sleep $DELAY_FORCEKILL
echo `kill -9 $pid 2> /dev/null`;
sleep 1

# Now check again if it is still running...
isrunning $server
case "$ISRUNNING" in
0) log_progress_msg "Success"; log_end_msg 0 ;;
1) log_progress_msg "Process is still running... Even after \"kill -9 $pid\". WOW..."; log_end_msg 0 ;;
esac
 ;;
0)
#log_progress_msg "";
 ;;
esac
done

log_begin_msg "$NAME: All done (killed $_killCount procs)"; log_end_msg 0

 ;;

 

 

status)
# Count how many processes we need
PROCCOUNT=0
for i in $SERVICES; do
PROCCOUNT=`expr $PROCCOUNT + 1`
done

# Go through server PID files and count how many are running
log_begin_msg "$NAME: Running processed:"
_pidCount=0
for server in $SERVICES; do

isrunning $server
case "$ISRUNNING" in
1)
# This server is running
_pidCount=`expr $_pidCount + 1`
log_progress_msg "$server"
 ;;
0)
 ;;
esac
done

log_begin_msg " ($_pidCount of $PROCCOUNT processes are running)"; log_end_msg 0

# Check if running proc count matches requires proc count
log_begin_msg "$NAME is"
if [ $_pidCount -eq $PROCCOUNT ]; then
log_progress_msg "running"; log_end_msg 0
exit 0
else
log_progress_msg "NOT running"; log_end_msg 0
exit 1
fi
 ;;

restart)
$0 stop
$0 start
 ;;
*)
echo "Usage: /etc/init.d/$NAME {start|stop|restart|status}" >&2
exit 1
 ;;
esac

exit 0

Startup script linux

2010-03-05T11:52:01Z

Tedd: Undo revision 16911 by Tedd (Talk)

== /etc/init.d script for Linux ==

=== Instructions ===

Tested on Debian 5. CHUIDS user to opensim user. Supports: start, stop, restart, status

To implement: Type: cat > /etc/init.d/opensim Paste in script from this page Press: CTRL+D Type: chmod +x /etc/init.d/opensim Script should now be located on server and be executable.

Type: update-rc.d opensim defaults Script should now be in your startup.

Modify header in script to adapt it to your installation folder and user.

NOTE: stop-command currently doesn't work properly (it doesn't do a soft shutdown). It will kill OpenSim first with kill pid, then kill -9 pid. So make sure you have saved your data. :)

=== Script ===

<code></code>

#! /bin/sh
### BEGIN INIT INFO
# Provides: OpenSim
# Required-Start: $local_fs $network
# Required-Stop: $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Tedds OpenSim init.d-script
### END INIT INFO

# Put script in /etc/init.d/
# then execute: update-rc.d opensim defaults

set -e

#
# Directories
#
# Location of OpenSim installation
DIR=/home/opensim/OpenSim/bin/
# Different PID dir?
PIDDIR=$DIR

USER=opensim
SERVICES="OpenSim.Grid.UserServer.exe OpenSim.Server.exe OpenSim.exe"

#
# Kill values (in seconds)
#
# How long between each service being started
DELAY_STARTUP=10
# How long between each service is sent shutdown command
DELAY_KILL=10
# After shutdown has been sent to all we do another loop with "kill", then "kill -9". How long between "kill" and "kill -9".
DELAY_FORCEKILL=10

#
# Info on service handled by this script
#
# Name of service
NAME=opensim
# Description of service
DESC="OpenSim Server"

# Binaries
SCREEN=/usr/bin/screen
MONO=/usr/bin/mono

###########################
##### START OF SCRIPT #####
###########################

export PATH="${PATH:+$PATH:}/usr/sbin:/sbin"

 

# Load LSB log functions
_lsbFile=""
if [ -e /etc/debian_version ]; then
_lsbFile="/lib/lsb/init-functions"
if [ -f $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
else
# [ -e /etc/init.d/functions ] ; then
_lsbFile="/etc/init.d/functions"
if [ -e $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
fi

# Lets use fancy output
log_use_fancy_output

# Check that target directory exists
if test ! -d "$DIR"; then
log_failure_msg "$NAME" "Target directory \"$DIR\" does not exist. Can not continue."
exit 1
fi

# Create a reverse order for shutdown
SERVICES_REVERSE=""
reverse() { SERVICES_REVERSE="$9 $8 $7 $6 $5 $4 $3 $2 $1"; }
reverse $SERVICES

# Check if a service is running
isrunning() {
ISRUNNING="0"
# Do we have PID-file?
if [ -f "$PIDDIR/$1.pid" ]; then
# Check if proc is running
pid=`cat "$PIDDIR/$1.pid" 2> /dev/null`
if [ "$pid" != "" ]; then
if [ -d /proc/$pid ]; then
# Process is running
ISRUNNING="1"
fi
fi
fi
#ISRUNNING="0"
}

#
# Process commands
#
case "$1" in
start)
# Start all services one by one
for server in $SERVICES; do
log_daemon_msg "Starting $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "Process already started. Please stop first"; log_end_msg 1 ;;
0)
# Process is not running
# Start process and sleep...
exefile="/tmp/exe.OpenSim.$server.sh"

# Need to make external file, had big problems with screen params
echo \#\!/bin/bash > $exefile
echo cd $DIR >> $exefile
echo $MONO $server >> $exefile
chmod +x $exefile

cmd_screen="screen -S $server -d -m $exefile"
start-stop-daemon --start -b -x /bin/su -m --pidfile=/tmp/su.$server.pid --chdir "$DIR" -- - $USER "-c $cmd_screen"

# Delay between services that are started
sleep $DELAY_STARTUP

rm $exefile 2> /dev/null

# Make PID-file
ps afxu | grep "mono $server" | grep -iEv "grep|screen" | awk {'print $2'} > "$PIDDIR/$server.pid"

isrunning $server
case "$ISRUNNING" in
1)
# Process started ok
#log_progress_msg "Success";
log_end_msg 0
 ;;
0)
# Process didn't start... remove pid-file
rm "$PIDDIR/$server.pid" 2> /dev/null
#log_progress_msg "Failure";
log_end_msg 1
 ;;
esac
 ;;
esac

done
 ;;

 

stop)
_killCount=0

for server in $SERVICES_REVERSE; do
log_daemon_msg "Stopping $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1)
_killCount=`expr $_killCount + 1`
log_progress_msg "Sending shutdown command:";

# We add some backspaces to the command in case something is on the console already
echo `screen -S $server -X stuff \"

# Wait for it to shut down...
sleep $DELAY_KILL

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "is still running."; log_end_msg 0 ;;
0) log_progress_msg "has been shutdown"; log_end_msg 0 ;;
esac

 ;;
0)
log_progress_msg "is not running"; log_end_msg 0
 ;;
esac

done

# Check if any procs are still running
for server in $SERVICES; do
isrunning $server
case "$ISRUNNING" in
1)
log_warning_msg "Stopping $NAME" "$server is still running: Forcing kill"
echo `kill $pid 2> /dev/null`;
sleep $DELAY_FORCEKILL
echo `kill -9 $pid 2> /dev/null`;
sleep 1

# Now check again if it is still running...
isrunning $server
case "$ISRUNNING" in
0) log_progress_msg "Success"; log_end_msg 0 ;;
1) log_progress_msg "Process is still running... Even after \"kill -9 $pid\". WOW..."; log_end_msg 0 ;;
esac
 ;;
0)
#log_progress_msg "";
 ;;
esac
done

log_begin_msg "$NAME: All done (killed $_killCount procs)"; log_end_msg 0

 ;;

 

 

status)
# Count how many processes we need
PROCCOUNT=0
for i in $SERVICES; do
PROCCOUNT=`expr $PROCCOUNT + 1`
done

# Go through server PID files and count how many are running
log_begin_msg "$NAME: Running processed:"
_pidCount=0
for server in $SERVICES; do

isrunning $server
case "$ISRUNNING" in
1)
# This server is running
_pidCount=`expr $_pidCount + 1`
log_progress_msg "$server"
 ;;
0)
 ;;
esac
done

log_begin_msg " ($_pidCount of $PROCCOUNT processes are running)"; log_end_msg 0

# Check if running proc count matches requires proc count
log_begin_msg "$NAME is"
if [ $_pidCount -eq $PROCCOUNT ]; then
log_progress_msg "running"; log_end_msg 0
exit 0
else
log_progress_msg "NOT running"; log_end_msg 0
exit 1
fi
 ;;

restart)
$0 stop
$0 start
 ;;
*)
echo "Usage: /etc/init.d/$NAME {start|stop|restart|status}" >&2
exit 1
 ;;
esac

exit 0

Startup script linux

2010-03-05T11:50:53Z

Tedd:

== /etc/init.d script for Linux ==

=== Instructions ===

Tested on Debian 5. CHUIDS user to opensim user. Supports: start, stop, restart, status

To implement: Type: cat > /etc/init.d/opensim Paste in script from this page Press: CTRL+D Type: chmod +x /etc/init.d/opensim Script should now be located on server and be executable.

Type: update-rc.d opensim defaults Script should now be in your startup.

Modify header in script to adapt it to your installation folder and user.

NOTE: stop-command currently doesn't work properly (it doesn't do a soft shutdown). It will kill OpenSim first with kill pid, then kill -9 pid. So make sure you have saved your data. :)

=== Script ===
<pre>#! /bin/sh
### BEGIN INIT INFO
# Provides: OpenSim
# Required-Start: $local_fs $network
# Required-Stop: $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Tedds OpenSim init.d-script
### END INIT INFO
# Put script in /etc/init.d/
# then execute: update-rc.d opensim defaults

set -e

#
# Directories
#
# Location of OpenSim installation
DIR=/home/opensim/OpenSim/bin/
# Different PID dir?
PIDDIR=$DIR

USER=opensim
SERVICES="OpenSim.Grid.UserServer.exe OpenSim.Server.exe OpenSim.exe"

#
# Kill values (in seconds)
#
# How long between each service being started
DELAY_STARTUP=10
# How long between each service is sent shutdown command
DELAY_KILL=10
# After shutdown has been sent to all we do another loop with "kill", then "kill -9". How long between "kill" and "kill -9".
DELAY_FORCEKILL=10

#
# Info on service handled by this script
#
# Name of service
NAME=opensim
# Description of service
DESC="OpenSim Server"

# Binaries
SCREEN=/usr/bin/screen
MONO=/usr/bin/mono

###########################
##### START OF SCRIPT #####
###########################

export PATH="${PATH:+$PATH:}/usr/sbin:/sbin"

 

# Load LSB log functions
_lsbFile=""
if [ -e /etc/debian_version ]; then
_lsbFile="/lib/lsb/init-functions"
if [ -f $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
else
# [ -e /etc/init.d/functions ]&nbsp;; then
_lsbFile="/etc/init.d/functions"
if [ -e $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
fi

# Lets use fancy output
log_use_fancy_output

# Check that target directory exists
if test&nbsp;! -d "$DIR"; then
log_failure_msg "$NAME" "Target directory \"$DIR\" does not exist. Can not continue."
exit 1
fi

# Create a reverse order for shutdown
SERVICES_REVERSE=""
reverse() { SERVICES_REVERSE="$9 $8 $7 $6 $5 $4 $3 $2 $1"; }
reverse $SERVICES

# Check if a service is running
isrunning() {
ISRUNNING="0"
# Do we have PID-file?
if [ -f "$PIDDIR/$1.pid" ]; then
# Check if proc is running
pid=`cat "$PIDDIR/$1.pid" 2&gt; /dev/null`
if [ "$pid"&nbsp;!= "" ]; then
if [ -d /proc/$pid ]; then
# Process is running
ISRUNNING="1"
fi
fi
fi
#ISRUNNING="0"
}

#
# Process commands
#
case "$1" in
start)
# Start all services one by one
for server in $SERVICES; do
log_daemon_msg "Starting $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "Process already started. Please stop first"; log_end_msg 1&nbsp;;;
0)
# Process is not running
# Start process and sleep...
exefile="/tmp/exe.OpenSim.$server.sh"

# Need to make external file, had big problems with screen params
echo \#\!/bin/bash &gt; $exefile
echo cd $DIR &gt;&gt; $exefile
echo $MONO $server &gt;&gt; $exefile
chmod +x $exefile

cmd_screen="screen -S $server -d -m $exefile"
start-stop-daemon --start -b -x /bin/su -m --pidfile=/tmp/su.$server.pid --chdir "$DIR" -- - $USER "-c $cmd_screen"

# Delay between services that are started
sleep $DELAY_STARTUP

rm $exefile 2&gt; /dev/null

# Make PID-file
ps afxu | grep "mono $server" | grep -iEv "grep|screen" | awk {'print $2'} &gt; "$PIDDIR/$server.pid"

isrunning $server
case "$ISRUNNING" in
1)
# Process started ok
#log_progress_msg "Success";
log_end_msg 0
&nbsp;;;
0)
# Process didn't start... remove pid-file
rm "$PIDDIR/$server.pid" 2&gt; /dev/null
#log_progress_msg "Failure";
log_end_msg 1
&nbsp;;;
esac
&nbsp;;;
esac

done
&nbsp;;;

 

stop)
_killCount=0

for server in $SERVICES_REVERSE; do
log_daemon_msg "Stopping $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1)
_killCount=`expr $_killCount + 1`
log_progress_msg "Sending shutdown command:";

# We add some backspaces to the command in case something is on the console already
echo `screen -S $server -X stuff \"

# Wait for it to shut down...
sleep $DELAY_KILL

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "is still running."; log_end_msg 0&nbsp;;;
0) log_progress_msg "has been shutdown"; log_end_msg 0&nbsp;;;
esac

&nbsp;;;
0)
log_progress_msg "is not running"; log_end_msg 0
&nbsp;;;
esac

done

# Check if any procs are still running
for server in $SERVICES; do
isrunning $server
case "$ISRUNNING" in
1)
log_warning_msg "Stopping $NAME" "$server is still running: Forcing kill"
echo `kill $pid 2&gt; /dev/null`;
sleep $DELAY_FORCEKILL
echo `kill -9 $pid 2&gt; /dev/null`;
sleep 1

# Now check again if it is still running...
isrunning $server
case "$ISRUNNING" in
0) log_progress_msg "Success"; log_end_msg 0&nbsp;;;
1) log_progress_msg "Process is still running... Even after \"kill -9 $pid\". WOW..."; log_end_msg 0&nbsp;;;
esac
&nbsp;;;
0)
#log_progress_msg "";
&nbsp;;;
esac
done

log_begin_msg "$NAME: All done (killed $_killCount procs)"; log_end_msg 0

&nbsp;;;

 

 

status)
# Count how many processes we need
PROCCOUNT=0
for i in $SERVICES; do
PROCCOUNT=`expr $PROCCOUNT + 1`
done

# Go through server PID files and count how many are running
log_begin_msg "$NAME: Running processed:"
_pidCount=0
for server in $SERVICES; do

isrunning $server
case "$ISRUNNING" in
1)
# This server is running
_pidCount=`expr $_pidCount + 1`
log_progress_msg "$server"
&nbsp;;;
0)
&nbsp;;;
esac
done

log_begin_msg " ($_pidCount of $PROCCOUNT processes are running)"; log_end_msg 0

# Check if running proc count matches requires proc count
log_begin_msg "$NAME is"
if [ $_pidCount -eq $PROCCOUNT ]; then
log_progress_msg "running"; log_end_msg 0
exit 0
else
log_progress_msg "NOT running"; log_end_msg 0
exit 1
fi
&nbsp;;;

restart)
$0 stop
$0 start
&nbsp;;;
*)
echo "Usage: /etc/init.d/$NAME {start|stop|restart|status}" &gt;&amp;2
exit 1
&nbsp;;;
esac

exit 0
</pre>

Backup

2010-03-05T11:46:05Z

Tedd: New page: = Backup of OpenSim MySQL database = == Linux == Add something like this to crontab for a weekly/daily/hourly run. (“crontab -e” to edit, “man crontab” to understand how to ...

= Backup of OpenSim MySQL database =

== Linux ==

Add something like this to crontab for a weekly/daily/hourly run. (“crontab -e” to edit, “man crontab” to understand how to edit)
<pre>mysqldump -uuser -ppass dbname | gzip > /tmp/mydb_`date +%Y%m%d_%H%M%S`.sql.gz</pre>
Crontab should e-mail you and errors in backup if it fails. (If your *nix is set up correctly)

To verify the backup gunzip it and look inside the .sql-file, it should contain a DB-dump. For example by executing:
<pre>zcat /tmp/mydb_YYYYMMDD_HHmmSS.sql.gz | more</pre>
To restore a given db:
<pre>cat /tmp/mydb_YYYYMMDD_HHmmSS.sql.gz | gunzip | mysql -uuser -ppass dbname </pre>
== Windows ==

The same as above can be done in Windows, but rotating the date can't be done in batch scripting afaik. I do however have a script for Windows I wrote for my OpenSim.

This is a script for taking a full MySQL backup on Windows (all databases). It required ActiveState Perl and 7zip command line to work. ''It works equally well for Linux, but a few adjustments to paths in header needs to be made.''

ActiveState Perl: [http://www.activestate.com/activeperl/ http://www.activestate.com/activeperl/] 7-Zip Command line: [http://www.7-zip.org/download.html http://www.7-zip.org/download.html]
<pre>use strict;
use locale;
#
# MySQL Backup Script by Tedd Hansen, tedd@konge.net, feb 2010
#
# THIS SCRIPT REQUIRES PERL INSTALLED. FOR WINDOWS USE ACTIVESTATE PERL.
#
# (1)
# This script requires a backup-user to be created on the database.
# Execute this: GRANT ALL on *.* to 'backup-user'@'localhost' identified by 'ZeBackup0perat00r';

# (change user and password at start of script))
#
# (2)
# To schedule script in Windows you must create a user with log on locally rights like Administrator has.
# DO NOT USE ADMINISTRATOR USER. If you do then backup will stop working next time we change password.
# Set startup path to the location of script, and schedule script to execute every 5 hours for example.
#

# Where to put backup
my $DIR_ROOT = "E:\\Backup";
my $DIR_BACKUP = "$DIR_ROOT\\MySQL_Backup";

# What to name backup
# Note: !DB! will be replaced with database name, !DATE! with current date yyyyMMdd and !TIME! with current time HHmmss
my $FILETEMPLATE = "MySQL !DB! !DATE! !TIME!.sqldump.7z";

my $MYSQL_USER="backup-user";
my $MYSQL_PASSWORD="ZeBackup0perat00r";
my $MYSQL_HOST="localhost";

# Full path to binary files we need
my $BIN_7Z = "$DIR_ROOT\\7za.exe";
my $BIN_MYSQLDUMP = "E:\\MySQL\\bin\\mysqldump.exe";
my $BIN_MYSQL = "E:\\MySQL\\bin\\mysql.exe";
my $CMD_LIST_DB = "echo show databases; | $BIN_MYSQL -u$MYSQL_USER -p$MYSQL_PASSWORD -h $MYSQL_HOST";

# How long before we delete it?
my $KEEP_HISTORY_FOR_DAYS = 30;

# We are piping MySQLDump output directly into 7z for compression. 7z writes to filesystem.
#
# Note: !DB! and !OUTFILE! will be replaced with database name and filename for output file
# -t7z = 7zip format
# -mx5 = Medium compression: 0 = none , 9 = ultra .. Note: Increasing compression will use more CPU, and we want to reserve CPU for customers... :)
# -ms = Create solid archive
# -mmt = Multithreading
# -mo=PPMd = PPMd algorithm (good for text, and we have only text)
my $BACKUP_ARGS = "-u $MYSQL_USER -p$MYSQL_PASSWORD -h $MYSQL_HOST !DB! | $BIN_7Z a -y -t7z -mx7 -ms -mmt -si !OUTFILE!";

#####################
## START OF SCRIPT ##
### ###
my %DBDONE = {};

# Attempt to create missing dirs
mkdir "$DIR_ROOT" unless (-d $DIR_ROOT);
mkdir "$DIR_BACKUP" unless (-d $DIR_BACKUP);

# Check that we got all we need
die "ERROR: ROOT DIR $DIR_ROOT DOES NOT EXIS!\n" unless (-d $DIR_ROOT);
die "ERROR: BACKUP DIR $DIR_BACKUP DOES NOT EXIS!\n" unless (-d $DIR_BACKUP);
die "ERROR: 7Z DOES NOT EXIST AT $BIN_7Z!\n" unless (-f $BIN_7Z);
die "ERROR: MYSQLDUMP DOES NOT EXIST AT $BIN_MYSQLDUMP!\n" unless (-f $BIN_MYSQLDUMP);
die "ERROR: MYSQLDUMP DOES NOT EXIST AT $BIN_MYSQL!\n" unless (-f $BIN_MYSQL);

# Delete old backups
print "Removing backups older than $KEEP_HISTORY_FOR_DAYS days.\n";
CleanupOldies();

# Make new backup
print "Backing up all MySQL databases on $MYSQL_HOST...\n";
open(DBLIST, "$CMD_LIST_DB |");
while (my $dbname = <DBLIST>) {
chomp $dbname;
BackupDatabase($dbname);
}
close(DBLIST);

sub CleanupOldies
{
# Get what time we should delete files at
$KEEP_HISTORY_FOR_DAYS = 30 if ($KEEP_HISTORY_FOR_DAYS < 1);

my ($dsec,$dmin,$dhour,$dmday,$dmon,$dyear) = localtime(time - ($KEEP_HISTORY_FOR_DAYS * 24 * 60 * 60));
my $DDATE = "0000".($dyear+1900).":00".($dmon+1).":00$dmday";
my $DTIME = "00$dhour:00$dmin:00$dsec";
$DDATE =~ s/^0*([^:]{4}):0*([^:]{2}):0*([^:]{2}).*/$1$2$3/;
$DTIME =~ s/^0*([^:]{2}):0*([^:]{2}):0*([^:]{2}).*/$1$2$3/;
my $CLEANTIME = $DDATE.$DTIME;

opendir(BDIR, "$DIR_BACKUP");
while (my $bfile = readdir(BDIR))
{
# Does filename match?
if ($bfile =~ m/(\d{8})\s+(\d{6})/) {
my $bfiledate = $1.$2;
# Is it old?
if ($bfiledate < $CLEANTIME) {
print "Deleting old backup file: $bfile\n";
unlink "$DIR_BACKUP\\$bfile";
}
}
}
closedir(BDIR);
}

sub BackupDatabase
{
my $dbname = shift;

# Only process each DB once
return if ($DBDONE{lc($dbname)});
$DBDONE{lc($dbname)} = 1;

# Get current date
my ($sec,$min,$hour,$mday,$mon,$year,$wday,$yday,$isdst)=localtime(time);
my $DATE = "0000".($year+1900).":00".($mon+1).":00$mday";
my $TIME = "00$hour:00$min:00$sec";
$DATE =~ s/^0*([^:]{4}):0*([^:]{2}):0*([^:]{2}).*/$1$2$3/;
$TIME =~ s/^0*([^:]{2}):0*([^:]{2}):0*([^:]{2}).*/$1$2$3/;

# Get output filename
my ($backup_filename) = $FILETEMPLATE;
$backup_filename =~ s/!DB!/$dbname/i;
$backup_filename =~ s/!DATE!/$DATE/i;
$backup_filename =~ s/!TIME!/$TIME/i;
my ($backupfile) = "$DIR_BACKUP\\$backup_filename";

# Get output command
my ($cmd_mysqldump) = "$BIN_MYSQLDUMP $BACKUP_ARGS";
$cmd_mysqldump =~ s/!DB!/$dbname/i;
$cmd_mysqldump =~ s/!OUTFILE!/\"$backupfile\"/i;

#
# Make backup...
#
print "* Backing up database '$dbname'\nTo file: $backupfile\n";
print `$cmd_mysqldump`;
my ($dsec,$dmin,$dhour,$dmday)=localtime(time);
my $doneTime = "00".($dmday - $mday).":00".($dhour - $hour).":00".($dmin - $min).":00".($dsec - $sec);
$doneTime =~ s/^0*([^:]{2}):0*([^:]{2}):0*([^:]{2}):0*([^:]{2}).*/$1d $2:$3:$4/;
print "Backup of $dbname done in $doneTime.\n\n";

}
</pre>

Startup script linux

2010-02-20T07:20:44Z

Tedd:

==/etc/init.d script for Linux==
===Instructions===
Tested on Debian 5.
CHUIDS user to opensim user.
Supports: start, stop, restart, status

To implement:
Type: cat > /etc/init.d/opensim
Paste in script from this page
Press: CTRL+D
Type: chmod +x /etc/init.d/opensim
Script should now be located on server and be executable.

Type: update-rc.d opensim defaults
Script should now be in your startup.

Modify header in script to adapt it to your installation folder and user.

NOTE:
stop-command currently doesn't work properly (it doesn't do a soft shutdown). It will kill OpenSim first with kill pid, then kill -9 pid. So make sure you have saved your data. :)

===Script===

<code>
#! /bin/sh
### BEGIN INIT INFO
# Provides: OpenSim
# Required-Start: $local_fs $network
# Required-Stop: $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Tedds OpenSim init.d-script
### END INIT INFO

# Put script in /etc/init.d/
# then execute: update-rc.d opensim defaults

set -e

#
# Directories
#
# Location of OpenSim installation
DIR=/home/opensim/OpenSim/bin/
# Different PID dir?
PIDDIR=$DIR

USER=opensim
SERVICES="OpenSim.Grid.UserServer.exe OpenSim.Server.exe OpenSim.exe"

#
# Kill values (in seconds)
#
# How long between each service being started
DELAY_STARTUP=10
# How long between each service is sent shutdown command
DELAY_KILL=10
# After shutdown has been sent to all we do another loop with "kill", then "kill -9". How long between "kill" and "kill -9".
DELAY_FORCEKILL=10

#
# Info on service handled by this script
#
# Name of service
NAME=opensim
# Description of service
DESC="OpenSim Server"

# Binaries
SCREEN=/usr/bin/screen
MONO=/usr/bin/mono

###########################
##### START OF SCRIPT #####
###########################

export PATH="${PATH:+$PATH:}/usr/sbin:/sbin"

# Load LSB log functions
_lsbFile=""
if [ -e /etc/debian_version ]; then
_lsbFile="/lib/lsb/init-functions"
if [ -f $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
else
# [ -e /etc/init.d/functions ] ; then
_lsbFile="/etc/init.d/functions"
if [ -e $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
fi

# Lets use fancy output
log_use_fancy_output

# Check that target directory exists
if test ! -d "$DIR"; then
log_failure_msg "$NAME" "Target directory \"$DIR\" does not exist. Can not continue."
exit 1
fi

# Create a reverse order for shutdown
SERVICES_REVERSE=""
reverse() { SERVICES_REVERSE="$9 $8 $7 $6 $5 $4 $3 $2 $1"; }
reverse $SERVICES

# Check if a service is running
isrunning() {
ISRUNNING="0"
# Do we have PID-file?
if [ -f "$PIDDIR/$1.pid" ]; then
# Check if proc is running
pid=`cat "$PIDDIR/$1.pid" 2> /dev/null`
if [ "$pid" != "" ]; then
if [ -d /proc/$pid ]; then
# Process is running
ISRUNNING="1"
fi
fi
fi
#ISRUNNING="0"
}

#
# Process commands
#
case "$1" in
start)
# Start all services one by one
for server in $SERVICES; do
log_daemon_msg "Starting $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "Process already started. Please stop first"; log_end_msg 1 ;;
0)
# Process is not running
# Start process and sleep...
exefile="/tmp/exe.OpenSim.$server.sh"

# Need to make external file, had big problems with screen params
echo \#\!/bin/bash > $exefile
echo cd $DIR >> $exefile
echo $MONO $server >> $exefile
chmod +x $exefile

cmd_screen="screen -S $server -d -m $exefile"
start-stop-daemon --start -b -x /bin/su -m --pidfile=/tmp/su.$server.pid --chdir "$DIR" -- - $USER "-c $cmd_screen"

# Delay between services that are started
sleep $DELAY_STARTUP

rm $exefile 2> /dev/null

# Make PID-file
ps afxu | grep "mono $server" | grep -iEv "grep|screen" | awk {'print $2'} > "$PIDDIR/$server.pid"

isrunning $server
case "$ISRUNNING" in
1)
# Process started ok
#log_progress_msg "Success";
log_end_msg 0
;;
0)
# Process didn't start... remove pid-file
rm "$PIDDIR/$server.pid" 2> /dev/null
#log_progress_msg "Failure";
log_end_msg 1
;;
esac
;;
esac

done
;;

stop)
_killCount=0

for server in $SERVICES_REVERSE; do
log_daemon_msg "Stopping $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1)
_killCount=`expr $_killCount + 1`
log_progress_msg "Sending shutdown command:";

# We add some backspaces to the command in case something is on the console already
echo `screen -S $server -X stuff \"

# Wait for it to shut down...
sleep $DELAY_KILL

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "is still running."; log_end_msg 0 ;;
0) log_progress_msg "has been shutdown"; log_end_msg 0 ;;
esac

;;
0)
log_progress_msg "is not running"; log_end_msg 0
;;
esac

done

# Check if any procs are still running
for server in $SERVICES; do
isrunning $server
case "$ISRUNNING" in
1)
log_warning_msg "Stopping $NAME" "$server is still running: Forcing kill"
echo `kill $pid 2> /dev/null`;
sleep $DELAY_FORCEKILL
echo `kill -9 $pid 2> /dev/null`;
sleep 1

# Now check again if it is still running...
isrunning $server
case "$ISRUNNING" in
0) log_progress_msg "Success"; log_end_msg 0 ;;
1) log_progress_msg "Process is still running... Even after \"kill -9 $pid\". WOW..."; log_end_msg 0 ;;
esac
;;
0)
#log_progress_msg "";
;;
esac
done

log_begin_msg "$NAME: All done (killed $_killCount procs)"; log_end_msg 0

;;

status)
# Count how many processes we need
PROCCOUNT=0
for i in $SERVICES; do
PROCCOUNT=`expr $PROCCOUNT + 1`
done

# Go through server PID files and count how many are running
log_begin_msg "$NAME: Running processed:"
_pidCount=0
for server in $SERVICES; do

isrunning $server
case "$ISRUNNING" in
1)
# This server is running
_pidCount=`expr $_pidCount + 1`
log_progress_msg "$server"
;;
0)
;;
esac
done

log_begin_msg " ($_pidCount of $PROCCOUNT processes are running)"; log_end_msg 0

# Check if running proc count matches requires proc count
log_begin_msg "$NAME is"
if [ $_pidCount -eq $PROCCOUNT ]; then
log_progress_msg "running"; log_end_msg 0
exit 0
else
log_progress_msg "NOT running"; log_end_msg 0
exit 1
fi
;;

restart)
$0 stop
$0 start
;;
*)
echo "Usage: /etc/init.d/$NAME {start|stop|restart|status}" >&2
exit 1
;;
esac

exit 0
</code>

Startup script linux

2010-02-20T07:18:13Z

Tedd:

==/etc/init.d script for Linux==
===Instructions===
Tested on Debian 5.
CHUIDS user to opensim user.
Supports: start, stop, restart, status

To implement:
Type: cat > /etc/init.d/opensim
Paste in script from this page
Press: CTRL+D
Type: chmod +x /etc/init.d/opensim
Script should now be located on server and be executable.

Type: update-rc.d opensim defaults
Script should now be in your startup.

===Script===

<code>
#! /bin/sh
### BEGIN INIT INFO
# Provides: OpenSim
# Required-Start: $local_fs $network
# Required-Stop: $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Tedds OpenSim init.d-script
### END INIT INFO

# Put script in /etc/init.d/
# then execute: update-rc.d opensim defaults

set -e

#
# Directories
#
# Location of OpenSim installation
DIR=/home/opensim/OpenSim/bin/
# Different PID dir?
PIDDIR=$DIR

USER=opensim
SERVICES="OpenSim.Grid.UserServer.exe OpenSim.Server.exe OpenSim.exe"

#
# Kill values (in seconds)
#
# How long between each service being started
DELAY_STARTUP=10
# How long between each service is sent shutdown command
DELAY_KILL=10
# After shutdown has been sent to all we do another loop with "kill", then "kill -9". How long between "kill" and "kill -9".
DELAY_FORCEKILL=10

#
# Info on service handled by this script
#
# Name of service
NAME=opensim
# Description of service
DESC="OpenSim Server"

# Binaries
SCREEN=/usr/bin/screen
MONO=/usr/bin/mono

###########################
##### START OF SCRIPT #####
###########################

export PATH="${PATH:+$PATH:}/usr/sbin:/sbin"

# Load LSB log functions
_lsbFile=""
if [ -e /etc/debian_version ]; then
_lsbFile="/lib/lsb/init-functions"
if [ -f $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
else
# [ -e /etc/init.d/functions ] ; then
_lsbFile="/etc/init.d/functions"
if [ -e $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
fi

# Lets use fancy output
log_use_fancy_output

# Check that target directory exists
if test ! -d "$DIR"; then
log_failure_msg "$NAME" "Target directory \"$DIR\" does not exist. Can not continue."
exit 1
fi

# Create a reverse order for shutdown
SERVICES_REVERSE=""
reverse() { SERVICES_REVERSE="$9 $8 $7 $6 $5 $4 $3 $2 $1"; }
reverse $SERVICES

# Check if a service is running
isrunning() {
ISRUNNING="0"
# Do we have PID-file?
if [ -f "$PIDDIR/$1.pid" ]; then
# Check if proc is running
pid=`cat "$PIDDIR/$1.pid" 2> /dev/null`
if [ "$pid" != "" ]; then
if [ -d /proc/$pid ]; then
# Process is running
ISRUNNING="1"
fi
fi
fi
#ISRUNNING="0"
}

#
# Process commands
#
case "$1" in
start)
# Start all services one by one
for server in $SERVICES; do
log_daemon_msg "Starting $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "Process already started. Please stop first"; log_end_msg 1 ;;
0)
# Process is not running
# Start process and sleep...
exefile="/tmp/exe.OpenSim.$server.sh"

# Need to make external file, had big problems with screen params
echo \#\!/bin/bash > $exefile
echo cd $DIR >> $exefile
echo $MONO $server >> $exefile
chmod +x $exefile

cmd_screen="screen -S $server -d -m $exefile"
start-stop-daemon --start -b -x /bin/su -m --pidfile=/tmp/su.$server.pid --chdir "$DIR" -- - $USER "-c $cmd_screen"

# Delay between services that are started
sleep $DELAY_STARTUP

rm $exefile 2> /dev/null

# Make PID-file
ps afxu | grep "mono $server" | grep -iEv "grep|screen" | awk {'print $2'} > "$PIDDIR/$server.pid"

isrunning $server
case "$ISRUNNING" in
1)
# Process started ok
#log_progress_msg "Success";
log_end_msg 0
;;
0)
# Process didn't start... remove pid-file
rm "$PIDDIR/$server.pid" 2> /dev/null
#log_progress_msg "Failure";
log_end_msg 1
;;
esac
;;
esac

done
;;

stop)
_killCount=0

for server in $SERVICES_REVERSE; do
log_daemon_msg "Stopping $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1)
_killCount=`expr $_killCount + 1`
log_progress_msg "Sending shutdown command:";

# We add some backspaces to the command in case something is on the console already
echo `screen -S $server -X stuff \"

# Wait for it to shut down...
sleep $DELAY_KILL

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "is still running."; log_end_msg 0 ;;
0) log_progress_msg "has been shutdown"; log_end_msg 0 ;;
esac

;;
0)
log_progress_msg "is not running"; log_end_msg 0
;;
esac

done

# Check if any procs are still running
for server in $SERVICES; do
isrunning $server
case "$ISRUNNING" in
1)
log_warning_msg "Stopping $NAME" "$server is still running: Forcing kill"
echo `kill $pid 2> /dev/null`;
sleep $DELAY_FORCEKILL
echo `kill -9 $pid 2> /dev/null`;
sleep 1

# Now check again if it is still running...
isrunning $server
case "$ISRUNNING" in
0) log_progress_msg "Success"; log_end_msg 0 ;;
1) log_progress_msg "Process is still running... Even after \"kill -9 $pid\". WOW..."; log_end_msg 0 ;;
esac
;;
0)
#log_progress_msg "";
;;
esac
done

log_begin_msg "$NAME: All done (killed $_killCount procs)"; log_end_msg 0

;;

status)
# Count how many processes we need
PROCCOUNT=0
for i in $SERVICES; do
PROCCOUNT=`expr $PROCCOUNT + 1`
done

# Go through server PID files and count how many are running
log_begin_msg "$NAME: Running processed:"
_pidCount=0
for server in $SERVICES; do

isrunning $server
case "$ISRUNNING" in
1)
# This server is running
_pidCount=`expr $_pidCount + 1`
log_progress_msg "$server"
;;
0)
;;
esac
done

log_begin_msg " ($_pidCount of $PROCCOUNT processes are running)"; log_end_msg 0

# Check if running proc count matches requires proc count
log_begin_msg "$NAME is"
if [ $_pidCount -eq $PROCCOUNT ]; then
log_progress_msg "running"; log_end_msg 0
exit 0
else
log_progress_msg "NOT running"; log_end_msg 0
exit 1
fi
;;

restart)
$0 stop
$0 start
;;
*)
echo "Usage: /etc/init.d/$NAME {start|stop|restart|status}" >&2
exit 1
;;
esac

exit 0
</code>

Startup script linux

2010-02-20T07:15:44Z

Tedd: Linux init script

==/etc/init.d script for Linux==
===Instructions===
Tested on Debian 5.
CHUIDS user to opensim user.
Supports: start, stop, restart, status

To implement:
Type: cat > /etc/init.d/opensim
Paste in script from this page
Press: CTRL+D
Type: chmod +x /etc/init.d/opensim
Script should now be located on server and be executable.

Type: update-rc.d opensim defaults
Script should now be in your startup.

===Script===

#! /bin/sh
### BEGIN INIT INFO
# Provides: OpenSim
# Required-Start: $local_fs $network
# Required-Stop: $local_fs
# Default-Start: 2 3 4 5
# Default-Stop: 0 1 6
# Short-Description: Tedds OpenSim init.d-script
### END INIT INFO

# Put script in /etc/init.d/
# then execute: update-rc.d opensim defaults

set -e

#
# Directories
#
# Location of OpenSim installation
DIR=/home/opensim/OpenSim/bin/
# Different PID dir?
PIDDIR=$DIR

USER=opensim
SERVICES="OpenSim.Grid.UserServer.exe OpenSim.Server.exe OpenSim.exe"

#
# Kill values (in seconds)
#
# How long between each service being started
DELAY_STARTUP=10
# How long between each service is sent shutdown command
DELAY_KILL=10
# After shutdown has been sent to all we do another loop with "kill", then "kill -9". How long between "kill" and "kill -9".
DELAY_FORCEKILL=10

#
# Info on service handled by this script
#
# Name of service
NAME=opensim
# Description of service
DESC="OpenSim Server"

# Binaries
SCREEN=/usr/bin/screen
MONO=/usr/bin/mono

###########################
##### START OF SCRIPT #####
###########################

export PATH="${PATH:+$PATH:}/usr/sbin:/sbin"

# Load LSB log functions
_lsbFile=""
if [ -e /etc/debian_version ]; then
_lsbFile="/lib/lsb/init-functions"
if [ -f $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
else
# [ -e /etc/init.d/functions ] ; then
_lsbFile="/etc/init.d/functions"
if [ -e $_lsbFile ]; then
. $_lsbFile
else
echo This script requires LSB init-functions file which doesn't exist: $_lsbFile
exit 1
fi
fi

# Lets use fancy output
log_use_fancy_output

# Check that target directory exists
if test ! -d "$DIR"; then
log_failure_msg "$NAME" "Target directory \"$DIR\" does not exist. Can not continue."
exit 1
fi

# Create a reverse order for shutdown
SERVICES_REVERSE=""
reverse() { SERVICES_REVERSE="$9 $8 $7 $6 $5 $4 $3 $2 $1"; }
reverse $SERVICES

# Check if a service is running
isrunning() {
ISRUNNING="0"
# Do we have PID-file?
if [ -f "$PIDDIR/$1.pid" ]; then
# Check if proc is running
pid=`cat "$PIDDIR/$1.pid" 2> /dev/null`
if [ "$pid" != "" ]; then
if [ -d /proc/$pid ]; then
# Process is running
ISRUNNING="1"
fi
fi
fi
#ISRUNNING="0"
}

#
# Process commands
#
case "$1" in
start)
# Start all services one by one
for server in $SERVICES; do
log_daemon_msg "Starting $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "Process already started. Please stop first"; log_end_msg 1 ;;
0)
# Process is not running
# Start process and sleep...
exefile="/tmp/exe.OpenSim.$server.sh"

# Need to make external file, had big problems with screen params
echo \#\!/bin/bash > $exefile
echo cd $DIR >> $exefile
echo $MONO $server >> $exefile
chmod +x $exefile

cmd_screen="screen -S $server -d -m $exefile"
start-stop-daemon --start -b -x /bin/su -m --pidfile=/tmp/su.$server.pid --chdir "$DIR" -- - $USER "-c $cmd_screen"

# Delay between services that are started
sleep $DELAY_STARTUP

rm $exefile 2> /dev/null

# Make PID-file
ps afxu | grep "mono $server" | grep -iEv "grep|screen" | awk {'print $2'} > "$PIDDIR/$server.pid"

isrunning $server
case "$ISRUNNING" in
1)
# Process started ok
#log_progress_msg "Success";
log_end_msg 0
;;
0)
# Process didn't start... remove pid-file
rm "$PIDDIR/$server.pid" 2> /dev/null
#log_progress_msg "Failure";
log_end_msg 1
;;
esac
;;
esac

done
;;

stop)
_killCount=0

for server in $SERVICES_REVERSE; do
log_daemon_msg "Stopping $NAME" "$server"

isrunning $server
case "$ISRUNNING" in
1)
_killCount=`expr $_killCount + 1`
log_progress_msg "Sending shutdown command:";

# We add some backspaces to the command in case something is on the console already
echo `screen -S $server -X stuff \"

# Wait for it to shut down...
sleep $DELAY_KILL

isrunning $server
case "$ISRUNNING" in
1) log_progress_msg "is still running."; log_end_msg 0 ;;
0) log_progress_msg "has been shutdown"; log_end_msg 0 ;;
esac

;;
0)
log_progress_msg "is not running"; log_end_msg 0
;;
esac

done

# Check if any procs are still running
for server in $SERVICES; do
isrunning $server
case "$ISRUNNING" in
1)
log_warning_msg "Stopping $NAME" "$server is still running: Forcing kill"
echo `kill $pid 2> /dev/null`;
sleep $DELAY_FORCEKILL
echo `kill -9 $pid 2> /dev/null`;
sleep 1

# Now check again if it is still running...
isrunning $server
case "$ISRUNNING" in
0) log_progress_msg "Success"; log_end_msg 0 ;;
1) log_progress_msg "Process is still running... Even after \"kill -9 $pid\". WOW..."; log_end_msg 0 ;;
esac
;;
0)
#log_progress_msg "";
;;
esac
done

log_begin_msg "$NAME: All done (killed $_killCount procs)"; log_end_msg 0

;;

status)
# Count how many processes we need
PROCCOUNT=0
for i in $SERVICES; do
PROCCOUNT=`expr $PROCCOUNT + 1`
done

# Go through server PID files and count how many are running
log_begin_msg "$NAME: Running processed:"
_pidCount=0
for server in $SERVICES; do

isrunning $server
case "$ISRUNNING" in
1)
# This server is running
_pidCount=`expr $_pidCount + 1`
log_progress_msg "$server"
;;
0)
;;
esac
done

log_begin_msg " ($_pidCount of $PROCCOUNT processes are running)"; log_end_msg 0

# Check if running proc count matches requires proc count
log_begin_msg "$NAME is"
if [ $_pidCount -eq $PROCCOUNT ]; then
log_progress_msg "running"; log_end_msg 0
exit 0
else
log_progress_msg "NOT running"; log_end_msg 0
exit 1
fi
;;

restart)
$0 stop
$0 start
;;
*)
echo "Usage: /etc/init.d/$NAME {start|stop|restart|status}" >&2
exit 1
;;
esac

exit 0

Build Instructions

2010-01-29T19:51:48Z

Tedd: /* Debian 5 */

{{Template:Quicklinks}}

[[Category:Users]]
This page covers building OpenSim from source code on multiple platforms. Please help us keep this page up to date as the project progresses.

==Download OpenSim ==
Check out the [[Download]] page for instructions on obtaining an OpenSim source release.

==MS Windows==

OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:
* [http://msdn2.microsoft.com/en-us/express/aa700756.aspx Microsoft Visual C# Express Edition] (note: not Visual C++)
* [http://www.mono-project.com/ mono]

Additional note: If you like IDE's you will need C# express 2008 or VS 2008.

Additional note: Microsoft C# Express v9 may install .Net 3.5 with resultant path error.
# To avoid install .Net framework version 2.0

Additional note: It is possible to develop on Windows Vista 64 bits with the following tweaks:
# Select OpenSim project properties from solution and choose platform to be x86. Rebuild solution.
# Select OpenSim.exe properties under solution bin folder and choose windows xp sp 2 compatibility mode + run as administrator.

=== Building ===

* In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create a VS2008 solution file, a nant build file and a '<tt>compile.bat</tt>' file.

* Open the resulting sln file with visual studio and build it there, or
* Run the '<tt>compile.bat</tt>' file. This will build the executable using MSBuild.
* if you prefer to use nant, run nant in the same top-level directory. This will build the executables.

If you don't care about physics (walking on prims, etc), ignore the rest of this section.

=== Running ===

Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.

Double-click on the <tt>OpenSim.exe</tt> executable file in the <tt>bin</tt> directory. This will start up OpenSim in standalone mode.

The debugger in VS2005 C# may be used to step through the code. For those that use a Cygwin shell, you may find that one or more dll's have permissions that cause problems running. Most find that a "<tt>chmod 777 *</tt>" from the <tt>bin</tt> directory solves this.

Physics can be invoked by adding the appropriate line to the [Startup] section of <tt>OpenSim.ini</tt>. For ODE, that would be:

physics = OpenDynamicsEngine

You can also add a command line option to a shortcut, or run from a command prompt with:

-physics=OpenDynamicsEngine

'''''Windows Vista'''''

Some people have reported that to run on Windows Vista, you must first disable Windows Firewall. Under the new "Start" button of Vista, select "Control panel". Then double-click "Windows Firewall". In the window that pops up, on the left column, select "Turn Windows Firewall on or off". You will have to give permission for this to run, then select the option "Off (not recommended)". Click "OK" and exit from the Windows Firewall window.

If you have McAfee SecurityCenter, see the description below.

Once all the security features are disabled, right click on <tt>OpenSim.exe</tt> and select "Run as administrator". This will pop up a window asking permission, select "Allow". Your OpenSim server should run in a DOS-like window and accept connections.

'''''McAfee Security'''''

McAfee Security does not allow applications to listen on ports not explicitly specified. You have two options: 1) disable firewall protection all together, 2) enable <tt>OpenSim.exe</tt> to be able to open ports.

''Disable firewall''

Open McAfee SecurityCenter. Select "Internet & Network". In the lower left corner is a small link to "Configure...". Select this. In the right side of the window, select the bar that says "Firewall protection is enabled". Here you can select "Off".

''Enable <tt>OpenSim.exe</tt> to open ports''

Open McAfee SecurityCenter. Select "Internet & Network". In the lower left corner is a small link to "Configure...". Select this. In the right side of the window, select the bar that says "Firewall protection is enabled". Select the "Advanced..." button. This will pop up a new window.

In the new window, on the left side, select "Program Permissions." In the middle on the right side of the window, select the "Add Allowed Program" button. Use the browser that pops up to find the OpenSim executable and select it.

Finally, select "OK" and exit the McAfee SecurityCenter window.

==Linux/Mac OS X/FreeBSD==

The easiest plaform to get running on the Linux side is Ubuntu 8.10, 32bit. This is what most of the developers running Linux use. If you are looking for the quick path, start there.

=== Ubuntu ===

For Ubuntu users on older distributions (7.10, 8.04, etc.) '''you need''' to upgrade your version of mono to at least 2.4. For anyone who needs to upgrade their Mono, see [[Update Mono on Ubuntu]].

Ubuntu Karmic (9.10) includes mono 2.4.2.3 packages.

To build:

sudo apt-get install nant mono-gmcs libmono-microsoft8.0-cil \
libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

=== openSUSE 10.3/11/11.1 ===

Install an openSUSE 11.1, 11 or 10.3 with its default options, add the online repositories
when finished installing do an online update with all the latest packages.

In yast install these packages, for running Opensim in standalone mode.
(there is a slight diffrence between 10.3 and 11/11.1 but following should be same)
subversion
nant
mono-jscript
- check that mono-core is installed

just in case you do not already have it installed

sudo zypper install mono-data-oracle

A tip for OpenSuSE 11.1 users - you can install packages from the command line using the 'zypper' tool. For example, to install 'nant', use this command:

sudo zypper install nant

If you just want to use SQLite then jump to last section
within this post.

* Optional mysql - for Opensim running in Grid mode:
Install these mysql packages via yast
mysql
mysql-client
mysql-administrator
mysql-gui-tools
mysql-query-browser

(note that selecting mysql in the Yast2 Installer will select the other packages automatically)

Before building create the mysql database.
/etc/init.d/mysql start
mysql -u root -p -h localhost
(when asked for password just hit enter)

mysql> create database opensim;
mysql> use opensim;
mysql> create user 'opensim'@'localhost' identified by 'thePassword';
mysql> grant all on *.* to 'opensim'@'localhost';
mysql> quit

*note that the '''grant all''' command may differ if you're adding the opensim database to an existing mysql installation.

On current builds set the connection string inside bin/OpenSim.ini after coppying the OpenSim.ini.example file.
If you are changing to MySQL from SQLite, the connection string for mysql also exists in the bin/Region/*xml files.
* It is '''important''' to remember this if you start out using the built-in SQLite database engine.

Build after installation of above in bash terminal. I save it in /opt

su -
cd /opt
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

Or, if you have a current (0.6+), you can simply execute:

make

After this you should be able to continue on starting the diffrent Servers, look in the mysql-config section,or
just run your OpenSim as a Standalone. By - eagleFX

=== Mac OS X 10.5/10.4 ===
* OpenSim is now working on PowerPC Macs! Thanks to DrScofield and those who helped him. Current nightly builds for PowerPC are not working, not sure about Intel so use the 0.5 Build. OpenSim works on Intel Macs. I'm testing on PowerBook G4. Tested these step on 10.5, but not 10.4 but should work --[[User:Mokele|Mokele]] 22:36, 14 February 2008 (PST) (Works on iMac G5 with OS 10.4.11, including expanding to local grid mode. --[[User:Magnuz|Magnuz]] 2008-12-15 10:50 (CET))
* Install XCode Developers Tools from DVD/CD Installation Disk or download from http://developer.apple.com/. You have to create an Apple account to access the downloads if you don't have an Apple account.
* Install X11 for 10.4 from the Optional Install from the DVD/CD Installation Disk. X11 for 10.5 is installed by default.
* Install Mono 1.2.5 from http://ftp.novell.com/pub/mono/archive/1.2.5/macos-10-universal/5/MonoFramework-1.2.5_5.macos10.novell.universal.dmg (The more recent releases Mono 1.2.6, 1.9.1 and 2.0.1 do not appear to work with these installation instructions. --[[User:Magnuz|Magnuz]] 2008-12-14 15:56 (CET)) and in Terminal or X11 edit the .profile file and add the following line:
export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/Current/lib/pkgconfig/:${PKG_CONFIG_PATH}"
* Compile OpenSim
svn co http://opensimulator.org/svn/opensim/tags/0.5.0-release opensim
cd opensim
./runprebuild.sh
nant

* Download and Compile libopenjpeg-libsl-2.1.2.0.dylib and libsecondlife.dll
* libopenjpeg-libsl-2.1.2.0.dylib:
svn co http://opensimulator.org/svn/opensim-libs/old/libsl1550 opensim-libs
cd opensim-libs/openjpeg-libsl
make -f Makefile.osx
cp libopenjpeg-libsl-2.1.2.0.dylib ../../bin
* Note: The Makefile that creates the libopenjpeg-libsl-2.1.2.0.so does not compile on PowerPC, but works properly on Intel Macs. Looks like a gcc issue with compile options. (It appears to work on iMac G5 with OS X 10.4.11. --[[User:Magnuz|Magnuz]] 2008-12-14 15:55 (CET))

* libsecondlife.dll: (for PowerPC Only, see details on this step [http://xyzzyxyzzy.net/2008/02/12/installing-opensim-on-powerpcor-of-eggs-and-virtual-worlds installing OpenSim on PowerPC…or: of eggs and virtual worlds])
cd .. (back into opensim-libs)
nant
cp bin/libsecondlife.dll ../bin

* Edit the libsecondlife.dll.config (PowerPC Only). Remove the cpu="x86" tag in the last dllmap line.

Here is what worked for me (OS X 10.5.7, Intel):

* make sure you have X11 installed
* grab the Apple Dev Tools from [http://developer.apple.com/]
* install Mono Framework 2.4 from [http://www.go-mono.com/mono-downloads/download.html]
* Get OpenSim source:
svn co http://opensimulator.org/svn/opensim/tags/0.6.5-post-fixes opensim
* Compile OpenSim:
cd opensim
./runprebuild.sh
nant
--[[User:Kusako|Kusako]] 08:06, 19 June 2009 (UTC)

Here is what worked for me (OS X 10.5.7 and 10.6, Intel) on (8/9/09):

* make sure you have X11 installed
* Very important to grab the latest Apple Dev Tools (3.2.1 on 8/9/09) (from [http://developer.apple.com/] - You will need a developer account, it is free.
* install Mono Framework 2.4 (version 2.4.2.3 on 8/9/09) from [http://www.go-mono.com/mono-downloads/download.html]
* install Mac Ports from [http://www.macports.org/]
* Mac Ports should update its packages on install, but to be safe, type the following at the Terminal:
sudo port -v selfupdate
* Use mac ports to install nant. (This should pull in everything you need. I think this will also try to install mono, but since I already had it installed, that errored on me. Don't worry about it though, it should install everything else you need.) At the Terminal type:
sudo port install nant

* Get OpenSim source. I downloaded 0.6.6 from [http://opensimulator.org/wiki/Download]
* Uncompress the download.
* Compile OpenSim:
cd opensim
./runprebuild.sh
nant

*Then of course the issue with the 0.6.6 release.
This release had some bugs with default automatic configuration on the first startup of OpenSim.exe. bin/Regions/default.xml (region configuration file) is not automatically created in the main directory. Therefore, you must manually create this file. Here is an example.
<pre>
<Root>
<Config sim_UUID="UUID" sim_name="NAME" sim_location_x="1000" sim_location_y="1000"
internal_ip_address="IP_ADDRESS_OF_SERVER" internal_ip_port="9000" allow_alternate_ports="false"
external_host_name="DNS_NAME_OF_SERVER" master_avatar_uuid="00000000-0000-0000-0000-000000000000"
estate_covanant_uuid="00000000-0000-0000-0000-000000000000" master_avatar_first="FIRST_NAME"
master_avatar_last="SECOND_NAME" master_avatar_pass="PASSWORD" />
</Root>
</pre>
You must change UUID, NAME, IP_ADDRESS_OF_SERVER, DNS_NAME_OF_SERVER, FIRST_NAME, SECOND_NAME and PASSWORD to your own values.
(I noticed than IP_ADDRESS_OF_SERVER should be set to real IP not to 127.0.0.1)

'''Summary''':

*Run OpenSim0.6.6Setup.exe and install OpenSim in Windows
*Run OpenSim.exe and enter default values - record them!
*Shutdown simulator (command: shutdown)
*Create default.xml with copy of above
*Change values in default.xml with recoded values
*Be sure default.xml be in main directory (same with OpenSim.ini)
*Run again OpenSim.exe
*Connect with viewer
--[[User:thart|thart]] 12:00, 10 October 2009 (UTC)

=== FreeBSD 6.2 ===
su
cd /usr/ports/devel/subversion/ && make install clean (you may also need to rebuild apr-svn if this step fails)
cd /usr/ports/lang/mono/ && make install clean
cd /usr/ports/devel/nant/ && make install clean
cd /usr/ports/databases/sqlite3/ && make install clean
cd /usr/ports/x11-toolkits/libgdiplus/ && make install clean
cd /opensim/installation/directory/
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

Note: [http://opensimulator.org/wiki/OpenSim:FAQ#System.DllNotFoundException:_..2Flibopenjpeg-libsl-2.1.2.0.so|Follow the instructions on the FAQ to fix the]
"System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so" issue, but use "gmake" instead of "make"

For ODE Physics you must do the following:
cd /usr/ports/graphics/libGL/ && make install clean
cd /usr/ports/graphics/libGLU/ && make install clean
cd /opensim/installation/directory/
svn co http://opensimulator.org/svn/opensim-libs/trunk opensim-libs
cd opensim-libs/unmanaged/OpenDynamicsEngine2/
sh autogen.sh
./configure --enable-shared --enable-release --disable-demos
make
mv ./ode/src/.libs/libode.so /opensim/installation/directory/opensim/bin/

=== RedHat Enterprise Linux 4 ===
sudo vi /etc/yum.repos.d/mono.repo

[mono]
name=Mono for rhel-4-i386 (stable)
baseurl=http://ftp.novell.com/pub/mono/download-stable/rhel-4-i386/
enabled=1
gpgcheck=0

sudo yum install mono-complete monodoc-core nant
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

=== RedHat Enterprise Linux 5 ===

The instructions below also work on other RedHat Linux flavors such as CentOS or maybe Fedora.

1. Put the [http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo Mono.repo] file in the /etc/yum.repo.d/ directory:
$ sudo su -
$ cd /etc/yum.repos.d/
$ wget http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo
Naturally use the most [http://download.opensuse.org/repositories/Mono up-to-date link for your distribution].

2. Install Mono and related tools with yum:
$ yum install mono nant mono-jscript mono-nunit
Make sure to use nunit-console2 to run your tests.

=== Fedora 5 ===
* I needed to build latest mono and nant from sources to build OpenSim successfully, the ones available in yum repository didn't work so I had to uninstall and build and configure the packages.

For detailed instructions go [http://ruakuu.blogspot.com/2008/06/installing-and-configuring-opensim-on.html here]

=== Debian 4 ===

For detailed instructions please see [[Debian 4 Build Instructions]]

=== Debian 5 ===

1. Install Debian in the usual way. In the package list choose just the last option - 'Standard system' Leave all other install options unchecked unless you have other reason to install them.

2. Log in as your root user make sure it works.

3. type: aptitude update (or apt-get update)

4. type: aptitude install nant and answer 'y' to 'Do you want to continue'- This will install nant and all of its dependancies.

5. type: apt-get install git-core and answer 'y' to 'Do you want to continue'.

6. type: aptitude install build-essential swig autoconf gawk mono-common binfmt-support bison libglib2.0-dev gettext and answer 'y' to 'Do you want to continue'

7. type: wget http://ftp.novell.com/pub/mono/sources/mono/mono-2.4.3.tar.bz2 to download mono

8. type: tar xf mono-2.4.3.tar.bz2 to extract the mono source code to a directory (substitute the latest build)

9. type: cd mono-2.4.3 to change int the directory you just created

10. type: ./configure --with-libgdiplus=yes - wait for it to finish

11. type: make - and wait some more as this takes a bit - moreso on older machines

12. type: make install

13. type: cd /

14 type: git clone git://opensimulator.org/git/opensim

15 type: cd opensim

16. type: git checkout -b 0.6.8-post-fixes origin/0.6.8-post-fixes (substitute the latest build)

17. type: git pull

18. type: apt-get -u upgrade and answer 'y' to 'do you want to continue?'. This will update all packages to their latest versions via apt (it will not upgrade opensim or mono as they were compiled seperately)

19. Reboot, just to make sure it all comes up cleanly (type: shutdown -r now)

20. Login, type: cd /

21. type: cd opensim

22. type: ./runprebuild.sh

23 type: nant - wait for this to finish

24. type: cd bin

25. type: cp OpenSim.ini.example OpenSim.ini

26. type: mono OpenSim.exe

27. Answer the onscreen wizard promts and Opensim will start in standalone mode.

To add MySql support type: apt-get install mysql-server and answer 'y' to 'Do you want to Continue'. You will be prompted for a password for the MySQL root user, enter it twice as requested. Edit OpenSim.ini to use MySql as directed elsewhere.

=== CentOS 5.2 32bit ===

For detailed instructions please see [[CentOS 5.2 Build Instructions]]

=== CentOS 5.3 32bit ===

For detailed installation and configuration instructions please see this [http://www.linuxtraining.org.uk/blogger4.html blog]

=== 64bit ===
Please note that only 32bit binaries are provided in the bin/ directory of subversion. If you want to use 64bit, you'll need to rebuild these shared objects. See [[Installing and running on x86-64]]

=== Physics (Open Dynamics Engine ODE) ===
As installed from svn, ODE will work on most 32 bit platforms. If you get an ODE-related crash, and/or a libode.so not found type of error, you will need to build libode from source.

Remove <tt>libode.so</tt> from the <tt>./bin</tt> folder. (Note that subsequent svn updates may replace it again; best fix is to copy your built <tt>libode.so</tt> to <tt>bin</tt>). Do NOT remove <tt>ode.net.dll</tt>! Download the latest source from:

svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine

OpenSim requires a couple of patches on top of ODE which are not yet included upstream. When compiling, make sure to use the following configure options:

--with-trimesh=gimpact
--enable-shared

Make sure the configure script confirms these choices, and always compile with single precision (I believe that's the default). Try <code> make -k </code> if you get errors relating to drawstuff, test*, or openGL. <code> make install </code> should put <tt>libode.so</tt> in the proper place (usually <tt>/usr/local/lib</tt>), and it should be seen by opensim (<tt>ode.net.dll</tt>)

'''''Note:''' if OpenSim fails to launch with <tt>Exception: System.DllNotFoundException: ode</tt>, after compiling ODE, just copy <tt>libode.so</tt> from its usual place (probably <tt>/usr/local/lib/</tt>) to ./bin/, as per [http://metafuturing.net/index.php/OpenSim_Notebook_1 this suggestion]''

==== Setting up ODE for 64 Bits systems: ====

HOWTO on setting up and Install OpenSim on SLES10 - SP1 64Bit

1. I installed Mono 2.01, added this installation source in Yast2
This distro supports installing packages via YaST. Add the following installation source to YaST:
* http://ftp.novell.com/pub/mono/download-stable/SLE_10 [^]
For assistance with using repositories and installing packages with YaST, visit the Yast help page.

"nant" was installed also via this operation.

2. I installed subversion from http://software.opensuse.org/search [^]

SLES/SLED10 ->
subversion-1.5.2-34.2.x86_64.rpm

3. I downloaded and installed the lastest SVN version of opensim as usual (like a 32 bit system):
http://opensimulator.org/wiki/Build_Instructions [^]

4. I downloaded and installed the Open Dynamics Engine (ODE) to replace the 32 bit version of ODE with a 64 bit version.

I did that with the following linux commands:
(it is expected that you have all required Linux building tools installed):

# cd
# svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine [^]
# cd OpenDynamicEngine
# chmod a+x ou/bootstrap
# sh autogen.sh

I installed/updated SLES10 with these rpm's for autogen.sh to run properly. http://software.opensuse.org/search [^]

SLES/SLED10 ->
- autoconf-2.61-168.1.x86_64.rpm
- automake-1.10.1-5.3.x86_64.rpm

# CFLAGS="-m64" ./configure --enable-shared
# make

I installed gtk2-devel via yast2, and all its dependancies, because make keept failing.

# cp ./ode/src/.libs/libode.so /opt/opensim/bin/

note:
in this directory it had made several versions of the "libode.so" because of running the previous commands several times
so i had to copy libode.so.1.0.0 to /opt/opensim/bin/libode.so

# vi ../opensim/bin/OpenSim.ini (change av_capsule_standup_tensor_linux to 1700000)

The 'chmod' command is required to fix permissions that are wrong.
The change in OpenSim.ini is required to avoid that avatars have bend legs and/or their feet are in the ground.

==== Running ====
Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.
<code>
cd bin
mono OpenSim.exe
</code>

Note: if you are running a 32bit Server such as Ubuntu 8.0.4 you need the alternative launcher:

<code>
mono OpenSim.32BitLaunch.exe
</code>

* To invoke ODE, add the option:
-physics=OpenDynamicsEngine
to the <tt>mono OpenSim.exe</tt> line

or add <code> physics = OpenDynamicsEngine </code> to the [Startup] section of <tt>OpenSim.ini</tt>. Same deal for other physics engines, when available.

On mono 1.2.6, some distributions may see
Unhandled Exception: System.NotSupportedException: CodePage 1252 not supported
on startup when using mysql. This can be resolved by installing the package libmono-i18n2.0-cil (see http://bugs.mysql.com/bug.php?id=33938).

== Hardware selection guide ==

An often-asked question is "what kind of hardware do I need to successfully run OpenSim?" Unfortunately, the answer is "it depends". The number of regions hosted on a given machine, number of simultaneous avatars on those regions, number of prims, use of scripts, etc., all affect hardware requirements. So, to help you make a more informed selection, some examples of hardware used are listed in the [[Hardware_Selection_Guide|hardware selection guide]].

[[Category:Users]]
[[Category:Getting Started]]

Build Instructions

2010-01-29T19:51:36Z

Tedd: /* Debian 5 */

{{Template:Quicklinks}}

[[Category:Users]]
This page covers building OpenSim from source code on multiple platforms. Please help us keep this page up to date as the project progresses.

==Download OpenSim ==
Check out the [[Download]] page for instructions on obtaining an OpenSim source release.

==MS Windows==

OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:
* [http://msdn2.microsoft.com/en-us/express/aa700756.aspx Microsoft Visual C# Express Edition] (note: not Visual C++)
* [http://www.mono-project.com/ mono]

Additional note: If you like IDE's you will need C# express 2008 or VS 2008.

Additional note: Microsoft C# Express v9 may install .Net 3.5 with resultant path error.
# To avoid install .Net framework version 2.0

Additional note: It is possible to develop on Windows Vista 64 bits with the following tweaks:
# Select OpenSim project properties from solution and choose platform to be x86. Rebuild solution.
# Select OpenSim.exe properties under solution bin folder and choose windows xp sp 2 compatibility mode + run as administrator.

=== Building ===

* In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create a VS2008 solution file, a nant build file and a '<tt>compile.bat</tt>' file.

* Open the resulting sln file with visual studio and build it there, or
* Run the '<tt>compile.bat</tt>' file. This will build the executable using MSBuild.
* if you prefer to use nant, run nant in the same top-level directory. This will build the executables.

If you don't care about physics (walking on prims, etc), ignore the rest of this section.

=== Running ===

Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.

Double-click on the <tt>OpenSim.exe</tt> executable file in the <tt>bin</tt> directory. This will start up OpenSim in standalone mode.

The debugger in VS2005 C# may be used to step through the code. For those that use a Cygwin shell, you may find that one or more dll's have permissions that cause problems running. Most find that a "<tt>chmod 777 *</tt>" from the <tt>bin</tt> directory solves this.

Physics can be invoked by adding the appropriate line to the [Startup] section of <tt>OpenSim.ini</tt>. For ODE, that would be:

physics = OpenDynamicsEngine

You can also add a command line option to a shortcut, or run from a command prompt with:

-physics=OpenDynamicsEngine

'''''Windows Vista'''''

Some people have reported that to run on Windows Vista, you must first disable Windows Firewall. Under the new "Start" button of Vista, select "Control panel". Then double-click "Windows Firewall". In the window that pops up, on the left column, select "Turn Windows Firewall on or off". You will have to give permission for this to run, then select the option "Off (not recommended)". Click "OK" and exit from the Windows Firewall window.

If you have McAfee SecurityCenter, see the description below.

Once all the security features are disabled, right click on <tt>OpenSim.exe</tt> and select "Run as administrator". This will pop up a window asking permission, select "Allow". Your OpenSim server should run in a DOS-like window and accept connections.

'''''McAfee Security'''''

McAfee Security does not allow applications to listen on ports not explicitly specified. You have two options: 1) disable firewall protection all together, 2) enable <tt>OpenSim.exe</tt> to be able to open ports.

''Disable firewall''

Open McAfee SecurityCenter. Select "Internet & Network". In the lower left corner is a small link to "Configure...". Select this. In the right side of the window, select the bar that says "Firewall protection is enabled". Here you can select "Off".

''Enable <tt>OpenSim.exe</tt> to open ports''

Open McAfee SecurityCenter. Select "Internet & Network". In the lower left corner is a small link to "Configure...". Select this. In the right side of the window, select the bar that says "Firewall protection is enabled". Select the "Advanced..." button. This will pop up a new window.

In the new window, on the left side, select "Program Permissions." In the middle on the right side of the window, select the "Add Allowed Program" button. Use the browser that pops up to find the OpenSim executable and select it.

Finally, select "OK" and exit the McAfee SecurityCenter window.

==Linux/Mac OS X/FreeBSD==

The easiest plaform to get running on the Linux side is Ubuntu 8.10, 32bit. This is what most of the developers running Linux use. If you are looking for the quick path, start there.

=== Ubuntu ===

For Ubuntu users on older distributions (7.10, 8.04, etc.) '''you need''' to upgrade your version of mono to at least 2.4. For anyone who needs to upgrade their Mono, see [[Update Mono on Ubuntu]].

Ubuntu Karmic (9.10) includes mono 2.4.2.3 packages.

To build:

sudo apt-get install nant mono-gmcs libmono-microsoft8.0-cil \
libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

=== openSUSE 10.3/11/11.1 ===

Install an openSUSE 11.1, 11 or 10.3 with its default options, add the online repositories
when finished installing do an online update with all the latest packages.

In yast install these packages, for running Opensim in standalone mode.
(there is a slight diffrence between 10.3 and 11/11.1 but following should be same)
subversion
nant
mono-jscript
- check that mono-core is installed

just in case you do not already have it installed

sudo zypper install mono-data-oracle

A tip for OpenSuSE 11.1 users - you can install packages from the command line using the 'zypper' tool. For example, to install 'nant', use this command:

sudo zypper install nant

If you just want to use SQLite then jump to last section
within this post.

* Optional mysql - for Opensim running in Grid mode:
Install these mysql packages via yast
mysql
mysql-client
mysql-administrator
mysql-gui-tools
mysql-query-browser

(note that selecting mysql in the Yast2 Installer will select the other packages automatically)

Before building create the mysql database.
/etc/init.d/mysql start
mysql -u root -p -h localhost
(when asked for password just hit enter)

mysql> create database opensim;
mysql> use opensim;
mysql> create user 'opensim'@'localhost' identified by 'thePassword';
mysql> grant all on *.* to 'opensim'@'localhost';
mysql> quit

*note that the '''grant all''' command may differ if you're adding the opensim database to an existing mysql installation.

On current builds set the connection string inside bin/OpenSim.ini after coppying the OpenSim.ini.example file.
If you are changing to MySQL from SQLite, the connection string for mysql also exists in the bin/Region/*xml files.
* It is '''important''' to remember this if you start out using the built-in SQLite database engine.

Build after installation of above in bash terminal. I save it in /opt

su -
cd /opt
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

Or, if you have a current (0.6+), you can simply execute:

make

After this you should be able to continue on starting the diffrent Servers, look in the mysql-config section,or
just run your OpenSim as a Standalone. By - eagleFX

=== Mac OS X 10.5/10.4 ===
* OpenSim is now working on PowerPC Macs! Thanks to DrScofield and those who helped him. Current nightly builds for PowerPC are not working, not sure about Intel so use the 0.5 Build. OpenSim works on Intel Macs. I'm testing on PowerBook G4. Tested these step on 10.5, but not 10.4 but should work --[[User:Mokele|Mokele]] 22:36, 14 February 2008 (PST) (Works on iMac G5 with OS 10.4.11, including expanding to local grid mode. --[[User:Magnuz|Magnuz]] 2008-12-15 10:50 (CET))
* Install XCode Developers Tools from DVD/CD Installation Disk or download from http://developer.apple.com/. You have to create an Apple account to access the downloads if you don't have an Apple account.
* Install X11 for 10.4 from the Optional Install from the DVD/CD Installation Disk. X11 for 10.5 is installed by default.
* Install Mono 1.2.5 from http://ftp.novell.com/pub/mono/archive/1.2.5/macos-10-universal/5/MonoFramework-1.2.5_5.macos10.novell.universal.dmg (The more recent releases Mono 1.2.6, 1.9.1 and 2.0.1 do not appear to work with these installation instructions. --[[User:Magnuz|Magnuz]] 2008-12-14 15:56 (CET)) and in Terminal or X11 edit the .profile file and add the following line:
export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/Current/lib/pkgconfig/:${PKG_CONFIG_PATH}"
* Compile OpenSim
svn co http://opensimulator.org/svn/opensim/tags/0.5.0-release opensim
cd opensim
./runprebuild.sh
nant

* Download and Compile libopenjpeg-libsl-2.1.2.0.dylib and libsecondlife.dll
* libopenjpeg-libsl-2.1.2.0.dylib:
svn co http://opensimulator.org/svn/opensim-libs/old/libsl1550 opensim-libs
cd opensim-libs/openjpeg-libsl
make -f Makefile.osx
cp libopenjpeg-libsl-2.1.2.0.dylib ../../bin
* Note: The Makefile that creates the libopenjpeg-libsl-2.1.2.0.so does not compile on PowerPC, but works properly on Intel Macs. Looks like a gcc issue with compile options. (It appears to work on iMac G5 with OS X 10.4.11. --[[User:Magnuz|Magnuz]] 2008-12-14 15:55 (CET))

* libsecondlife.dll: (for PowerPC Only, see details on this step [http://xyzzyxyzzy.net/2008/02/12/installing-opensim-on-powerpcor-of-eggs-and-virtual-worlds installing OpenSim on PowerPC…or: of eggs and virtual worlds])
cd .. (back into opensim-libs)
nant
cp bin/libsecondlife.dll ../bin

* Edit the libsecondlife.dll.config (PowerPC Only). Remove the cpu="x86" tag in the last dllmap line.

Here is what worked for me (OS X 10.5.7, Intel):

* make sure you have X11 installed
* grab the Apple Dev Tools from [http://developer.apple.com/]
* install Mono Framework 2.4 from [http://www.go-mono.com/mono-downloads/download.html]
* Get OpenSim source:
svn co http://opensimulator.org/svn/opensim/tags/0.6.5-post-fixes opensim
* Compile OpenSim:
cd opensim
./runprebuild.sh
nant
--[[User:Kusako|Kusako]] 08:06, 19 June 2009 (UTC)

Here is what worked for me (OS X 10.5.7 and 10.6, Intel) on (8/9/09):

* make sure you have X11 installed
* Very important to grab the latest Apple Dev Tools (3.2.1 on 8/9/09) (from [http://developer.apple.com/] - You will need a developer account, it is free.
* install Mono Framework 2.4 (version 2.4.2.3 on 8/9/09) from [http://www.go-mono.com/mono-downloads/download.html]
* install Mac Ports from [http://www.macports.org/]
* Mac Ports should update its packages on install, but to be safe, type the following at the Terminal:
sudo port -v selfupdate
* Use mac ports to install nant. (This should pull in everything you need. I think this will also try to install mono, but since I already had it installed, that errored on me. Don't worry about it though, it should install everything else you need.) At the Terminal type:
sudo port install nant

* Get OpenSim source. I downloaded 0.6.6 from [http://opensimulator.org/wiki/Download]
* Uncompress the download.
* Compile OpenSim:
cd opensim
./runprebuild.sh
nant

*Then of course the issue with the 0.6.6 release.
This release had some bugs with default automatic configuration on the first startup of OpenSim.exe. bin/Regions/default.xml (region configuration file) is not automatically created in the main directory. Therefore, you must manually create this file. Here is an example.
<pre>
<Root>
<Config sim_UUID="UUID" sim_name="NAME" sim_location_x="1000" sim_location_y="1000"
internal_ip_address="IP_ADDRESS_OF_SERVER" internal_ip_port="9000" allow_alternate_ports="false"
external_host_name="DNS_NAME_OF_SERVER" master_avatar_uuid="00000000-0000-0000-0000-000000000000"
estate_covanant_uuid="00000000-0000-0000-0000-000000000000" master_avatar_first="FIRST_NAME"
master_avatar_last="SECOND_NAME" master_avatar_pass="PASSWORD" />
</Root>
</pre>
You must change UUID, NAME, IP_ADDRESS_OF_SERVER, DNS_NAME_OF_SERVER, FIRST_NAME, SECOND_NAME and PASSWORD to your own values.
(I noticed than IP_ADDRESS_OF_SERVER should be set to real IP not to 127.0.0.1)

'''Summary''':

*Run OpenSim0.6.6Setup.exe and install OpenSim in Windows
*Run OpenSim.exe and enter default values - record them!
*Shutdown simulator (command: shutdown)
*Create default.xml with copy of above
*Change values in default.xml with recoded values
*Be sure default.xml be in main directory (same with OpenSim.ini)
*Run again OpenSim.exe
*Connect with viewer
--[[User:thart|thart]] 12:00, 10 October 2009 (UTC)

=== FreeBSD 6.2 ===
su
cd /usr/ports/devel/subversion/ && make install clean (you may also need to rebuild apr-svn if this step fails)
cd /usr/ports/lang/mono/ && make install clean
cd /usr/ports/devel/nant/ && make install clean
cd /usr/ports/databases/sqlite3/ && make install clean
cd /usr/ports/x11-toolkits/libgdiplus/ && make install clean
cd /opensim/installation/directory/
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

Note: [http://opensimulator.org/wiki/OpenSim:FAQ#System.DllNotFoundException:_..2Flibopenjpeg-libsl-2.1.2.0.so|Follow the instructions on the FAQ to fix the]
"System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so" issue, but use "gmake" instead of "make"

For ODE Physics you must do the following:
cd /usr/ports/graphics/libGL/ && make install clean
cd /usr/ports/graphics/libGLU/ && make install clean
cd /opensim/installation/directory/
svn co http://opensimulator.org/svn/opensim-libs/trunk opensim-libs
cd opensim-libs/unmanaged/OpenDynamicsEngine2/
sh autogen.sh
./configure --enable-shared --enable-release --disable-demos
make
mv ./ode/src/.libs/libode.so /opensim/installation/directory/opensim/bin/

=== RedHat Enterprise Linux 4 ===
sudo vi /etc/yum.repos.d/mono.repo

[mono]
name=Mono for rhel-4-i386 (stable)
baseurl=http://ftp.novell.com/pub/mono/download-stable/rhel-4-i386/
enabled=1
gpgcheck=0

sudo yum install mono-complete monodoc-core nant
[[Download]] opensim
cd opensim
./runprebuild.sh
nant

=== RedHat Enterprise Linux 5 ===

The instructions below also work on other RedHat Linux flavors such as CentOS or maybe Fedora.

1. Put the [http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo Mono.repo] file in the /etc/yum.repo.d/ directory:
$ sudo su -
$ cd /etc/yum.repos.d/
$ wget http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo
Naturally use the most [http://download.opensuse.org/repositories/Mono up-to-date link for your distribution].

2. Install Mono and related tools with yum:
$ yum install mono nant mono-jscript mono-nunit
Make sure to use nunit-console2 to run your tests.

=== Fedora 5 ===
* I needed to build latest mono and nant from sources to build OpenSim successfully, the ones available in yum repository didn't work so I had to uninstall and build and configure the packages.

For detailed instructions go [http://ruakuu.blogspot.com/2008/06/installing-and-configuring-opensim-on.html here]

=== Debian 4 ===

For detailed instructions please see [[Debian 4 Build Instructions]]

=== Debian 5 ===

1. Install Debian in the usual way. In the package list choose just the last option - 'Standard system' Leave all other install options unchecked unless you have other reason to install them.

2. Log in as your root user make sure it works.

3. type: aptiude update (or apt-get update)

4. type: aptitude install nant and answer 'y' to 'Do you want to continue'- This will install nant and all of its dependancies.

5. type: apt-get install git-core and answer 'y' to 'Do you want to continue'.

6. type: aptitude install build-essential swig autoconf gawk mono-common binfmt-support bison libglib2.0-dev gettext and answer 'y' to 'Do you want to continue'

7. type: wget http://ftp.novell.com/pub/mono/sources/mono/mono-2.4.3.tar.bz2 to download mono

8. type: tar xf mono-2.4.3.tar.bz2 to extract the mono source code to a directory (substitute the latest build)

9. type: cd mono-2.4.3 to change int the directory you just created

10. type: ./configure --with-libgdiplus=yes - wait for it to finish

11. type: make - and wait some more as this takes a bit - moreso on older machines

12. type: make install

13. type: cd /

14 type: git clone git://opensimulator.org/git/opensim

15 type: cd opensim

16. type: git checkout -b 0.6.8-post-fixes origin/0.6.8-post-fixes (substitute the latest build)

17. type: git pull

18. type: apt-get -u upgrade and answer 'y' to 'do you want to continue?'. This will update all packages to their latest versions via apt (it will not upgrade opensim or mono as they were compiled seperately)

19. Reboot, just to make sure it all comes up cleanly (type: shutdown -r now)

20. Login, type: cd /

21. type: cd opensim

22. type: ./runprebuild.sh

23 type: nant - wait for this to finish

24. type: cd bin

25. type: cp OpenSim.ini.example OpenSim.ini

26. type: mono OpenSim.exe

27. Answer the onscreen wizard promts and Opensim will start in standalone mode.

To add MySql support type: apt-get install mysql-server and answer 'y' to 'Do you want to Continue'. You will be prompted for a password for the MySQL root user, enter it twice as requested. Edit OpenSim.ini to use MySql as directed elsewhere.

=== CentOS 5.2 32bit ===

For detailed instructions please see [[CentOS 5.2 Build Instructions]]

=== CentOS 5.3 32bit ===

For detailed installation and configuration instructions please see this [http://www.linuxtraining.org.uk/blogger4.html blog]

=== 64bit ===
Please note that only 32bit binaries are provided in the bin/ directory of subversion. If you want to use 64bit, you'll need to rebuild these shared objects. See [[Installing and running on x86-64]]

=== Physics (Open Dynamics Engine ODE) ===
As installed from svn, ODE will work on most 32 bit platforms. If you get an ODE-related crash, and/or a libode.so not found type of error, you will need to build libode from source.

Remove <tt>libode.so</tt> from the <tt>./bin</tt> folder. (Note that subsequent svn updates may replace it again; best fix is to copy your built <tt>libode.so</tt> to <tt>bin</tt>). Do NOT remove <tt>ode.net.dll</tt>! Download the latest source from:

svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine

OpenSim requires a couple of patches on top of ODE which are not yet included upstream. When compiling, make sure to use the following configure options:

--with-trimesh=gimpact
--enable-shared

Make sure the configure script confirms these choices, and always compile with single precision (I believe that's the default). Try <code> make -k </code> if you get errors relating to drawstuff, test*, or openGL. <code> make install </code> should put <tt>libode.so</tt> in the proper place (usually <tt>/usr/local/lib</tt>), and it should be seen by opensim (<tt>ode.net.dll</tt>)

'''''Note:''' if OpenSim fails to launch with <tt>Exception: System.DllNotFoundException: ode</tt>, after compiling ODE, just copy <tt>libode.so</tt> from its usual place (probably <tt>/usr/local/lib/</tt>) to ./bin/, as per [http://metafuturing.net/index.php/OpenSim_Notebook_1 this suggestion]''

==== Setting up ODE for 64 Bits systems: ====

HOWTO on setting up and Install OpenSim on SLES10 - SP1 64Bit

1. I installed Mono 2.01, added this installation source in Yast2
This distro supports installing packages via YaST. Add the following installation source to YaST:
* http://ftp.novell.com/pub/mono/download-stable/SLE_10 [^]
For assistance with using repositories and installing packages with YaST, visit the Yast help page.

"nant" was installed also via this operation.

2. I installed subversion from http://software.opensuse.org/search [^]

SLES/SLED10 ->
subversion-1.5.2-34.2.x86_64.rpm

3. I downloaded and installed the lastest SVN version of opensim as usual (like a 32 bit system):
http://opensimulator.org/wiki/Build_Instructions [^]

4. I downloaded and installed the Open Dynamics Engine (ODE) to replace the 32 bit version of ODE with a 64 bit version.

I did that with the following linux commands:
(it is expected that you have all required Linux building tools installed):

# cd
# svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine [^]
# cd OpenDynamicEngine
# chmod a+x ou/bootstrap
# sh autogen.sh

I installed/updated SLES10 with these rpm's for autogen.sh to run properly. http://software.opensuse.org/search [^]

SLES/SLED10 ->
- autoconf-2.61-168.1.x86_64.rpm
- automake-1.10.1-5.3.x86_64.rpm

# CFLAGS="-m64" ./configure --enable-shared
# make

I installed gtk2-devel via yast2, and all its dependancies, because make keept failing.

# cp ./ode/src/.libs/libode.so /opt/opensim/bin/

note:
in this directory it had made several versions of the "libode.so" because of running the previous commands several times
so i had to copy libode.so.1.0.0 to /opt/opensim/bin/libode.so

# vi ../opensim/bin/OpenSim.ini (change av_capsule_standup_tensor_linux to 1700000)

The 'chmod' command is required to fix permissions that are wrong.
The change in OpenSim.ini is required to avoid that avatars have bend legs and/or their feet are in the ground.

==== Running ====
Recent versions of OpenSim come without an <tt>OpenSim.ini</tt> file. Copy the <tt>OpenSim.ini.example</tt> file to <tt>OpenSim.ini</tt> before making any changes.
<code>
cd bin
mono OpenSim.exe
</code>

Note: if you are running a 32bit Server such as Ubuntu 8.0.4 you need the alternative launcher:

<code>
mono OpenSim.32BitLaunch.exe
</code>

* To invoke ODE, add the option:
-physics=OpenDynamicsEngine
to the <tt>mono OpenSim.exe</tt> line

or add <code> physics = OpenDynamicsEngine </code> to the [Startup] section of <tt>OpenSim.ini</tt>. Same deal for other physics engines, when available.

On mono 1.2.6, some distributions may see
Unhandled Exception: System.NotSupportedException: CodePage 1252 not supported
on startup when using mysql. This can be resolved by installing the package libmono-i18n2.0-cil (see http://bugs.mysql.com/bug.php?id=33938).

== Hardware selection guide ==

An often-asked question is "what kind of hardware do I need to successfully run OpenSim?" Unfortunately, the answer is "it depends". The number of regions hosted on a given machine, number of simultaneous avatars on those regions, number of prims, use of scripts, etc., all affect hardware requirements. So, to help you make a more informed selection, some examples of hardware used are listed in the [[Hardware_Selection_Guide|hardware selection guide]].

[[Category:Users]]
[[Category:Getting Started]]

Jp2 batch converter

2008-05-13T11:17:43Z

Tedd: /* Usage */

==Description==
The jp2 files used by the Secondlife client, are actually j2k files. These can be encoded by image_to_j2k from openjpeg. The script identifies the image-resolution, and converts the image to a valid SL-resolution/aspect ratio. Subsequently it checks for jpg-files, and converts them to valid openjpeg input files if necessary. Valid openjpeg files are then converted to j2k fileformat, by image_to_j2k. At last the j2k file is renamed to jp2, and can be used as an secondlife texture. Use genassets.pl to generate an asset-set out of these files.

==Code==
<source lang="perl">
#!/usr/bin/perl -s -U
# jp2batch.pl
# OpenSim jp2 texture preparation script
# Converts jpg/jpeg/bmp/tga files to valid jp2(jk2) files for SL
# Author: Phrearch
# Credits: Tedd1

$dirs=0;
$files=0;

sub ScanDirectory{
my ($workdir) = @_;
local (@names);
$dirs++;
opendir(DIR, $workdir) or die "Unable to open $workdir:$!\n";
@names = readdir(DIR) or die "Unable to read $workdir:$!\n";
closedir(DIR);
foreach my $tmpName (@names){
my $name = $workdir."/".$tmpName;
#\. or \.. in directory
if ($tmpName =~ /^\.\.?$/){
next;
}
#directory
if (-d $name){
print "Entering directory $name\n";
&ScanDirectory($name);
next;
}
#jpg or jpeg
if ($name =~ /^(.*)\.(jpe?g|bmp|tga|tif|raw)$/){
$rawname = $1;
$ext = lc($2);
$files++;
print "\nProcessing $name...";
&Convert($rawname,$ext);
}
}
}

sub Convert{
my ($rawname, $ext) = @_;
my @imageid = split(/ /,`identify $rawname.$ext`);
my @imageXY = split('x',@imageid[2]);
my $imageX = pop(@imageXY);
my $imageY = pop(@imageXY);
my $optX;
my $optY;
my $ar;
my $optar;

#landscape or square, search for optimal X
if ($imageX >= $imageY){
$ar = sprintf("%.4f",$imageY / $imageX);
$optar = &supportedAR($ar);
$optX = &supportedXY($imageX);
$optY = $optX * $optar;
#both aspectratio and resolution are correct
unless(($imageX==$optRes) && ($ar==$optar)) {
print "\nResizing ($imageX\xx$imageY => $optY\xx$optX)...";
system(`convert -resize ${optX}x${optY}! $rawname.$ext $rawname.$ext &>/dev/null`);
print "Done";
}
}

#portrait, search for optimal Y
else {
$ar = sprintf("%.4f",$imageX / $imageY);
$optar = &supportedAR($ar);
$optY = &supportedXY($imageY);
$optX = $optY * $optar;
#Needs conversion
unless(($imageY==$optRes) && ($ar==$optar)) {
print "\nResizing ($imageX\xx$imageY => $optX\xx$optY)...";
system("convert -resize ${optX}x${optY}! $rawname.$ext $rawname.$ext &>/dev/null");
print "Done";
}
}
if (($ext eq "jpg") || ($ext eq "jpeg")){
print "\nConverting jpg to valid openjpeg format...";
system("convert -format tga $rawname.$ext $rawname.tga &>/dev/null");
system("rm $rawname.$ext &>/dev/null");
print "Done";
$ext="tga";
}
print "\nCreating jp2 file...";
system("image_to_j2k -i $rawname.$ext -o $rawname.j2k -r 20,10,1 &>/dev/null");
system("mv $rawname.j2k $rawname.jp2 &>/dev/null");
system("rm $rawname.$ext &>/dev/null");
print "Done\n";
}

sub supportedAR{
my ($ar) = @_;
my @arReference=(1.0,0.5,0.25,0.125,0.0625);
my $arOptimal;
my $arDivTemp=1.0;
my $arDiv;
#Get optimal aspect ratio
foreach (@arReference){
$arDiv=abs($ar-$_);
if($arDiv < $arDivTemp) {
$arDivTemp=$arDiv;
$arOptimal=$_;
}
}
return $arOptimal;
}

sub supportedXY{
my ($res) = @_;
my @resReference=(64.0,128.0,256.0,512.0,1024.0);
my $resOptimal;
my $resDivTemp=4096.0;
my $resDiv;
#Get optimal axis resolution
foreach (@resReference){
$resDiv=abs($res-$_);
if($resDiv < $resDivTemp) {
$resDivTemp=$resDiv;
$resOptimal=$_;
}
}
return $resOptimal;
}

if ( @ARGV > 0 ){
print "Processing ".@ARGV[0]."...\n";
&ScanDirectory(".");
print "\nDirectories scanned:$dirs\nFiles processed:$files\n" ;
}
else {
print "Provide a directory to process...\n";
}
</source>

==Usage==
* Install OpenJPEG svn (if you have trouble compiling, you could try the binaries on their site)
svn co http://www.openjpeg.org/svn/trunk
cd trunk
mkdir bin
cd bin
cmake .. -DBUILD_EXAMPLES:BOOL=ON
make
make install
PATH=/usr/local/bin:$PATH
* Make sure that the binaries image_to_j2k and j2k_to_image can be executed from anywhere
Add /usr/local/bin to /etc/profile for a permanent path.

* Put the code in a file named jp2batch.pl, and copy it to the /opt/opensim/scripts directory. The script uses a directory as parameter:
perl jp2batch.pl "/some directory/with/images"

Contributions Policy

2008-03-07T09:01:42Z

Tedd: /* The code is not the documentation */

__NOTOC__

=Important=
Any contributions must comply with the following OpenSim contribution policy

In order to accept your contribution you need to read and adhere to the OpenSim Code Conventions and also follow the licensing conditions.

==OpenSim Core Values==

So, you're thinking of contributing? Great! In order to make your ride as smooth as possible, here's listing some of this projects guiding principles:

====This is an early alpha experimental project====
This means that we value simple and naive solutions over efficiency - we will optimize but first we need to get the basics right.
It also means a very optimistic use of the word 'stable'.

====This is a 3D application platform, ''not a Second Life wannabe world simulator''====
This means that we value decoupling, modularity and indirection over clock
cycles and feature completeness.

====We are all in this for our own separate reasons, some to have fun, some to make money====
This means that any given patch, fix or feature is very much up to whether somebody thinks it fun, worthwile or would pay good money for it.

====This is a young project====
Being through four major architectural changes in <s>six</s> twelve months means we still
have lots of tangly and bushy remnants of old ways of doing stuff.

====This is a noob-friendly project====
Yes, believe it or not, we're aiming at continously trying to make the code as simple, structured and readable for newcomers as time and experience will let us.

====The code is the documentation====
Even though we're trying to document the things that are reasonably set, instead of documentation and commenting we try to make the code as simple, strightforward and readable as possible.

====Documentation is good, comments are good====
There is a dispute about above point. Some of us are trying to comment code correctly so that it is obvious to newcomers how things are connected (large and small), where to make changes, what the change will affect and how to extend OpenSim.

====We are a multi-platform project====
This means we will go to lengths to avoid bringing in new technologies that would provide thresholds for installing and using the code on different environments. The default configuration should always be build- and runnable on checkout, provided you are on a c# .net/mono environment with either vs build or nant. Other technologies than those can be provided, but will not be guaranteed not to break at any given time.

Codewise, we're trying to move towards looser coupling and better code reuse - and to separate the code into a 'framework' layer, a 'service' layer and an 'application' layer; the framework layer defines all base classes and interfaces, the service layer provide networked and persistent implementations of those, and the application layer provides configuration logic and executables.

== OpenSim Licensing Conditions ==
To make sure that we can accept your contribution and continue to distribute the OpenSim materials under the most free license possible, any contributions to the OpenSim project need to follow the following licensing conditions:

* Your contribution is either wholly your own, or if it contains third party materials, they are licensed in a manner compatible with the OpenSim project. If you rely on third party contributions, acknowledge them and include a copy of the license conditions for those components if they differ from the OpenSim project license. We cannot accept virally licensed code unless there is a specific F/OSS exemption for BSD-licensed projects.

* You accept whole liability for any contributions you make for inclusion of third party intellectual property, in the jurisdiction of both yourself, and where the servers are located (United States). If you are unsure about the licensing conditions for a piece of source, do not include it and work around it. If you have a problem here, ask the rest of the developers as they may be able to help.

* You have not witnessed, seen or been party to the development of the official Linden Lab Server Software. If you have been involved in the official server development your contributions may affect the licensing of the main codebase and we cannot accept the contributions without a waiver from Linden Lab disclaiming any interest in your contributions.

* You have not studied or copied sourcecode from the GPL Second Life viewer to submit your contribution

* You submit your contribution to the repository under the BSD license below.

===OpenSim BSD License===

<pre>
Copyright (c) Contributors, http://opensimulator.org/
See CONTRIBUTORS.TXT for a full list of copyright holders.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
* Neither the name of the OpenSim Project nor the
names of its contributors may be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
</pre>

[[Category:Main]]
[[Category:Users]]
[[Category:Development]]

Scripting Languages

2008-02-02T04:55:02Z

Tedd:

= Scripting Languages =

OpenSim currently supports 3 scripting languages, and more are under way. 
Scripts are restored automatically when OpenSim starts. 

== LSL ==
LSLv2 is the well know Second Life scripting language. It is basically a C#/Java-like language.
Allthough many commands are still being developed, the majority of ll-functions has been implemented and it is possible to make usable scripts.
If you want to ensure that the compiler treats your script as LSL you should have "//lsl" as the first 5 letters in script.
Example code:
default
{
state_entry()
{
llSay(0, "This is an incredibly useless program.");
}
}

== C# ==
C# is a .Net language. 
Allthough it is C# the behaviour is much like LSL in the sense that you still use ll-functions like llSay(), and still use the same events as in LSL. 
The first 4 characters in your script must be "//cs" for the compiler to treat it as C#. 
 
Example code:
//cs
public void default_event_state_entry()
{
llSay(0, "This is an incredibly useless program.");
}

== VB.Net ==
''Note! Mono does not have compiler for VB.Net, so VB.Net scripts may not work on Mono. :)''
VB.Net is a .Net language. 
Allthough it is VB.Net the behaviour is much like LSL in the sense that you still use ll-functions like llSay(), and still use the same events as in LSL. 
The first 4 characters in your script must be "//vb" for the compiler to treat it as VB.Net. 

Example code:
//vb
Public Sub default_event_state_entry()
llSay(0, "This is an incredibly useless program.")
End Sub

Scripting Languages

2008-02-02T04:17:52Z

Tedd:

= Scripting Languages =

OpenSim currently supports 3 scripting languages, and more are under way. 
Scripts are restored automatically when OpenSim starts. 

== LSL ==
LSLv2 is the well know Second Life scripting language. It is basically a C#/Java-like language.
Allthough many commands are still being developed, the majority of ll-functions has been implemented and it is possible to make usable scripts.
If you want to ensure that the compiler treats your script as LSL you should have "//lsl" as the first 5 letters in script.
Example code:
default
{
state_entry()
{
llSay(0, "This is an incredibly useless program.");
}
}

== C# ==
C# is a .Net language. 
Allthough it is C# the behaviour is much like LSL in the sense that you still use ll-functions like llSay(), and still use the same events as in LSL. 
The first 4 characters in your script must be "//cs" for the compiler to treat it as C#. 
 
Example code:
//cs
public void default_event_state_entry()
{
llSay(0, "This is an incredibly useless program.");
}

== VB.Net ==
VB.Net is a .Net language. 
Allthough it is VB.Net the behaviour is much like LSL in the sense that you still use ll-functions like llSay(), and still use the same events as in LSL. 
The first 4 characters in your script must be "//vb" for the compiler to treat it as VB.Net. 

Example code:
//vb
Public Sub default_event_state_entry()
llSay(0, "This is an incredibly useless program.")
End Sub

Scripting Languages

2008-02-02T03:51:48Z

Tedd: New page: = Scripting Languages = OpenSim currently supports 3 scripting languages, and more are under way. Scripts are restored automatically when OpenSim starts. == LSL == LSLv2 is t...

= Scripting Languages =

OpenSim currently supports 3 scripting languages, and more are under way. 
Scripts are restored automatically when OpenSim starts. 

== LSL ==
LSLv2 is the well know Second Life scripting language. It is basically a C#/Java-like language.
Allthough many commands are still being developed, the majority of ll-functions has been implemented and it is possible to make usable scripts.
If you want to ensure that the compiler treats your script as LSL you should have "//lsl" as the first 5 letters in script.

== C# ==
C# is a .Net language. 
Allthough it is C# the behaviour is much like LSL in the sense that you still use ll-functions like llSay(), and still use the same events as in LSL. 
The first 4 characters in your script must be "//cs" for the compiler to treat it as C#. 
 
Example code:
//cs
public void default_event_state_entry()
{
llSay(0, "This is an incredibly useless program." );
}

== VB.Net ==
VB.Net is a .Net language. 
Allthough it is VB.Net the behaviour is much like LSL in the sense that you still use ll-functions like llSay(), and still use the same events as in LSL. 
The first 4 characters in your script must be "//vb" for the compiler to treat it as VB.Net. 

Example code:
//vb
Public Sub default_event_state_entry()
llSay(0, "This is an incredibly useless program.")
End Sub

Scripting

2008-02-02T03:44:31Z

Tedd:

[[Category:Users]]
== OpenSim Scripting ==

===Users===
* [[LSL_osFunctions|OSL Proposals]] - Suggestions for custom OSL-functions
* [[LSL_osFunctions_implemented|implemented OSL-functions]] - A list of OSL-functions that are available
* [[LSL_Status|implemented LSL-functions]] - A list of LSL-functions that are available
* [[OpenSim:Scripting|Script usage]] - Tutorial how to use scripts in-world
* [[OpenSim:Scripting_Languages|Scripting Languages]] - What languages are supported and how to use them

===Developers===
* [[OpenSim: Scripting]] - Overview
* [[LSL_OSSL_Standards|OSSL Standards]] - A whitepaper concerning naming-standards for the OpenSim scripting language
* [[OpenSim.Region.ScriptEngine.Common]] - How to create your own script engine
* [[OpenSim.Region.ScriptEngine.DotNetEngine|DotNet-Engine]] - Describes some of the esoteric parts of the DotNet-Engine
* [[Build_Bot|Bot-Design(.Net)]] - A whitepaper about a buildbot-design in Opensim

Back to [[Main_Page]]

[[Category:Getting Started]]

Scripting

2008-02-02T03:44:06Z

Tedd: Added link to page for languages

[[Category:Users]]
== OpenSim Scripting ==

===Users===
* [[LSL_osFunctions|OSL Proposals]] - Suggestions for custom OSL-functions
* [[LSL_osFunctions_implemented|implemented OSL-functions]] - A list of OSL-functions that are available
* [[LSL_Status|implemented LSL-functions]] - A list of LSL-functions that are available
* [[OpenSim:Scripting|Script usage]] - Tutorial how to use scripts in-world
* [[OpenSim:Scripting|Languages]] - What languages are supported and how to use them

===Developers===
* [[OpenSim: Scripting]] - Overview
* [[LSL_OSSL_Standards|OSSL Standards]] - A whitepaper concerning naming-standards for the OpenSim scripting language
* [[OpenSim.Region.ScriptEngine.Common]] - How to create your own script engine
* [[OpenSim.Region.ScriptEngine.DotNetEngine|DotNet-Engine]] - Describes some of the esoteric parts of the DotNet-Engine
* [[Build_Bot|Bot-Design(.Net)]] - A whitepaper about a buildbot-design in Opensim

Back to [[Main_Page]]

[[Category:Getting Started]]

OpenSim.Region.ScriptEngine.Common

2008-01-21T11:40:34Z

Tedd:

=OpenSim.Region.ScriptEngine.Common=

==How to implement your own script engine==
Creating a new script engine for OpenSim is simple (haha). 
What I mean by simple is that if you already have a VM (Virtual Machine) or script engine of some sort then integrating it as a OpenSim ScriptEngine plugin is simple. 
 

===What do I get for free?===
1. Loading/unloading of scripts are queued and executed in sequence. Only one load/unload at the time. 
 
2. What script belongs to what object is automatically taken care of. You just need to provide the scripts classes - nothing else. 
 
3. OpenSim events are translated and given to you as LSL events. Your script functions are executed automatically, no need to hook up to events or anything. 
If you want to implement your own event handlers, feel free to do so. Look in "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.EventManager.cs" how its done. Your own events can run together with LSL events without any problem. 
 
4. Whenever an event is executed, the execution is queued. Only one event per script is ever executed simultaneous. But multithreading is used to run multiple scripts in parallel. 
 
5. Errors during script execution is automatically handled and relayed to users in-world. 
 
6. You get all LSL commands in an easy to use object, no need to keep track of scene or objects to execute functions. Running an LSL command from your script engine is as easy as running it from inside any LSL-script. 
 
7. Long LSL-commands that returns with an event is also handled. 

===Getting started===
1. Create a new project named "OpenSim.Region.MySuperScriptEngine" (replace "MySuperScriptEngine" with the name of your scriptengine). 
2. Create a new class (file) named "ScriptEngine". It must be named exactly ScriptEngine for OpenSim to use it. ScriptEngine must inherit from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine". 
3. You need to override a couple of functions. Most probably you don't want to do any special work here, so look below for a sample default file. 
4. Create a new class (file) named "ScriptManager" that inherits from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager". 
5. Your ScriptManager class needs to override two functions. One to start a script and one to stop a script. 

===ScriptEngine class===
The main purpose of ScriptEngine class is to be able to intercept scene, for example starting with a "fake" scene instead of OpenSim's scene. You probably don't want this, so just go for the standard initialization. 
A standard class would look like this: 
using System;
using Nini.Config;
using OpenSim.Framework.Console;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.ScriptEngine.MySuperScriptEngine
{
[Serializable]
public class ScriptEngine : OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine
{
public override void Initialise(Scene scene, IConfigSource config)
{
InitializeEngine(scene, MainLog.Instance, true, GetScriptManager());
}
public override OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager _GetScriptManager()
{
return new ScriptManager(this);
}
}
}

===ScriptManager class===
A script is refecenced by object id "localID" (the object/prim it is inside) and script id "itemID" (the particular (unique) instance of that script). These parameters along with a string "Script" containing the script text (source code) are passed to your (overriden) start script function in your ScriptManager class. 
 
Keeping track of active scripts is done automatically, so your job is simply to create a new script and hand it over. After that your work is done until the script is asked to stop, then you have to do a few simple tasks to remove it again. 
Here is a sample on a minimal script startup:
public override void _StartScript(uint localID, LLUUID itemID, string Script)
{
SceneObjectPart m_host = World.GetSceneObjectPart(localID);
try
{
IScript CompiledScript = MySpecialCompiler.DoCompile(Script); // Compile and return an IScript object that is the actual script
CompiledScript.Source = ScriptSource; // Store source for recompile on script reset events
SetScript(localID, itemID, CompiledScript); // All is ok. Add script to OpenSim's script manager. From here on its on autopilot.
// Create a private instance of LSL commands (note that m_scriptEngine, m_host are from baseclass, so you don't need to change them)
LSL_BuiltIn_Commands LSLB = new LSL_BuiltIn_Commands(m_scriptEngine, m_host, localID, itemID);
CompiledScript.Start(LSLB); // Start the script - giving it LSL commands
// Fire the first start-event, this is the event run on LSL scripts when they first start
m_scriptEngine.m_EventQueueManager.AddToScriptQueue(localID, itemID, "state_entry", EventQueueManager.llDetectNull, new object[] { });
}
catch (Exception e)
{
// To see how you can send the compile error in-world, have a look at OpenSim.Region.ScriptEngine.DotNetEngine.ScriptManager
}
}

And your minimal script shutdown would be:
public override void _StopScript(uint localID, LLUUID itemID)
{
m_scriptEngine.m_LSLLongCmdHandler.RemoveScript(localID, itemID); // Stop long command on script like timers, http requests, etc.
IScript LSLBC = GetScript(localID, itemID); // Get the script we are stopping
if (LSLBC == null) // Nothing to do? Exit.
return;
try
{
LSLBC.Exec.StopScript(); // Tell script to stop
RemoveScript(localID, itemID); // Remove script from internal memory structure
}
catch (Exception e)
{
// You probably want to log this to console or something
}
}

===IScript interface===
So you have implemented the two classes described above. Now how does this connect to your JavaScript or Perl or YourCustomSuperLanguage script engine or VM? 
 
You have to create a class. This class must inherit "OpenSim.Region.ScriptEngine.Common.IScript". Inside IScript your class will have two important things: 
 
1. During script start (in ScriptManager), you call yourscript.Start() and give it a LSL command module. So insite your script class where you override this Start() function you need to remember this LSL command module. 
How you bind this LSL command module to your custom engine is totally up to you. The LSL command module contains all LSL functions, and any function you use there will affect the correct object/region/whatever. You don't need to do more than ''myLSLCommandModule.llSay(0, "Hello world!");'' to make it work. 
 
2. Any time a LSL event is generated either by an in-world event or by for example a timer, a function in your script class needs to be executed. For this you have the "Exec" override. I suggest you have a look at "OpenSim.Region.ScriptEngine.Common.Executor" to see how this work. Basically you receive a string containing function name and the parameters for that event. 
If you use the default Executor you need to initialize it by giving it a reference to yourself (the IScript script class). Then you need to have functions in your class matching LSL functions when it comes to both name and parameters. Example: 
public touch_start(int number_of_touches) {
// whatever code for this event... probably calling your own VM's function with the same name? ;)
}

===AppDomain security===
If you are writing a .Net based script engine and want AppDomain security and loading/unloading then:
// Load script:
IScript CompiledScript = m_scriptEngine.m_AppDomainManager.LoadScript(filename);
and
// Unload script:
m_scriptEngine.m_AppDomainManager.StopScript(LSLBC.Exec.GetAppDomain());

OpenSim.Region.ScriptEngine.Common

2008-01-21T09:34:10Z

Tedd: Cosmetics

=OpenSim.Region.ScriptEngine.Common=

==How to implement your own script engine==
Creating a new script engine for OpenSim is simple (haha). 
What I mean by simple is that if you already have a VM (Virtual Machine) or script engine of some sort then integrating it as a OpenSim ScriptEngine plugin is simple. 
 

===What do I get for free?===
1. Loading/unloading of scripts are queued and executed in sequence. Only one load/unload at the time. 
 
2. What script belongs to what object is automatically taken care of. You just need to provide the scripts classes - nothing else. 
 
3. OpenSim events are translated and given to you as LSL events. Your script functions are executed automatically, no need to hook up to events or anything. 
If you want to implement your own event handlers, feel free to do so. Look in "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.EventManager.cs" how its done. Your own events can run together with LSL events without any problem. 
 
4. Whenever an event is executed, the execution is queued. Only one event per script is ever executed simultaneous. But multithreading is used to run multiple scripts in parallel. 
 
5. Errors during script execution is automatically handled and relayed to users in-world. 
 
6. You get all LSL commands in an easy to use object, no need to keep track of scene or objects to execute functions. Running an LSL command from your script engine is as easy as running it from inside any LSL-script. 
 
7. Long LSL-commands that returns with an event is also handled. 

===Getting started===
1. Create a new project named "OpenSim.Region.MySuperScriptEngine" (replace "MySuperScriptEngine" with the name of your scriptengine). 
2. Create a new class (file) named "ScriptEngine". It must be named exactly ScriptEngine for OpenSim to use it. ScriptEngine must inherit from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine". 
3. You need to override a couple of functions. Most probably you don't want to do any special work here, so look below for a sample default file.
4. Create a new class (file) named "ScriptManager" that inherits from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager". 
5. Your ScriptManager class needs to override two functions. One to start a script and one to stop a script. 

===ScriptEngine class===
The main purpose of ScriptEngine class is to be able to intercept scene, for example starting with a "fake" scene instead of OpenSim's scene. You probably don't want this, so just go for the standard initialization. 
A standard class would look like this: 
using System;
using Nini.Config;
using OpenSim.Framework.Console;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.ScriptEngine.MySuperScriptEngine
{
[Serializable]
public class ScriptEngine : OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine
{
public override void Initialise(Scene scene, IConfigSource config)
{
InitializeEngine(scene, MainLog.Instance, true, GetScriptManager());
}
public override OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager _GetScriptManager()
{
return new ScriptManager(this);
}
}
}

===ScriptManager class===
A script is refecenced by object id "localID" (the object/prim it is inside) and script id "itemID" (the particular (unique) instance of that script). These parameters along with a string "Script" containing the script text (source code) are passed to your (overriden) start script function in your ScriptManager class. 
 
Keeping track of active scripts is done automatically, so your job is simply to create a new script and hand it over. After that your work is done until the script is asked to stop, then you have to do a few simple tasks to remove it again. 
Here is a sample on a minimal script startup:
public override void _StartScript(uint localID, LLUUID itemID, string Script)
{
SceneObjectPart m_host = World.GetSceneObjectPart(localID);
try
{
IScript CompiledScript = MySpecialCompiler.DoCompile(Script); // Compile and return an IScript object that is the actual script
CompiledScript.Source = ScriptSource; // Store source for recompile on script reset events
SetScript(localID, itemID, CompiledScript); // All is ok. Add script to OpenSim's script manager. From here on its on autopilot.
// Create a private instance of LSL commands (note that m_scriptEngine, m_host are from baseclass, so you don't need to change them)
LSL_BuiltIn_Commands LSLB = new LSL_BuiltIn_Commands(m_scriptEngine, m_host, localID, itemID);
CompiledScript.Start(LSLB); // Start the script - giving it LSL commands
// Fire the first start-event, this is the event run on LSL scripts when they first start
m_scriptEngine.m_EventQueueManager.AddToScriptQueue(localID, itemID, "state_entry", EventQueueManager.llDetectNull, new object[] { });
}
catch (Exception e)
{
// To see how you can send the compile error in-world, have a look at OpenSim.Region.ScriptEngine.DotNetEngine.ScriptManager
}
}

And your minimal script shutdown would be:
public override void _StopScript(uint localID, LLUUID itemID)
{
m_scriptEngine.m_LSLLongCmdHandler.RemoveScript(localID, itemID); // Stop long command on script like timers, http requests, etc.
IScript LSLBC = GetScript(localID, itemID); // Get the script we are stopping
if (LSLBC == null) // Nothing to do? Exit.
return;
try
{
LSLBC.Exec.StopScript(); // Tell script to stop
RemoveScript(localID, itemID); // Remove script from internal memory structure
}
catch (Exception e)
{
// You probably want to log this to console or something
}
}

===IScript interface===
So you have implemented the two classes described above. Now how does this connect to your JavaScript or Perl or YourCustomSuperLanguage script engine or VM? 
 
You have to create a class. This class must inherit "OpenSim.Region.ScriptEngine.Common.IScript". Inside IScript your class will have two important things: 
 
1. During script start (in ScriptManager), you call yourscript.Start() and give it a LSL command module. So insite your script class where you override this Start() function you need to remember this LSL command module. 
How you bind this LSL command module to your custom engine is totally up to you. The LSL command module contains all LSL functions, and any function you use there will affect the correct object/region/whatever. You don't need to do more than ''myLSLCommandModule.llSay(0, "Hello world!");'' to make it work. 
 
2. Any time a LSL event is generated either by an in-world event or by for example a timer, a function in your script class needs to be executed. For this you have the "Exec" override. I suggest you have a look at "OpenSim.Region.ScriptEngine.Common.Executor" to see how this work. Basically you receive a string containing function name and the parameters for that event. 
If you use the default Executor you need to initialize it by giving it a reference to yourself (the IScript script class). Then you need to have functions in your class matching LSL functions when it comes to both name and parameters. Example: 
public touch_start(int number_of_touches) {
// whatever code for this event... probably calling your own VM's function with the same name? ;)
}

===AppDomain security===
If you are writing a .Net based script engine and want AppDomain security and loading/unloading then:
// Load script:
IScript CompiledScript = m_scriptEngine.m_AppDomainManager.LoadScript(filename);
and
// Unload script:
m_scriptEngine.m_AppDomainManager.StopScript(LSLBC.Exec.GetAppDomain());

Scripting

2008-01-20T19:25:11Z

Tedd: Added: create your own script engine

== OpenSim Scripting ==

===Users===
* [[LSL_osFunctions|OSL Proposals]] - Suggestions for custom OSL-functions
* [[LSL_osFunctions_implemented|implemented OSL-functions]] - A list of OSL-functions that are available
* [[LSL_Status|implemented LSL-functions]] - A list of LSL-functions that are available
* [[OpenSim:Scripting|Script usage]] - Tutorial how to use scripts in-world

===Developers===
* [[LSL_OSSL_Standards|OSSL Standards]] - A whitepaper concerning naming-standards for the OpenSim scripting language
* [[OpenSim.Region.ScriptEngine.Common]] - How to create your own script engine
* [[OpenSim.Region.ScriptEngine.DotNetEngine|DotNet-Engine]] - Describes some of the esoteric parts of the DotNet-Engine
* [[Build_Bot|Bot-Design(.Net)]] - A whitepaper about a buildbot-design in Opensim

Back to [[Main_Page]]

[[Category:Getting Started]]

OpenSim.Region.ScriptEngine.Common

2008-01-20T19:23:49Z

Tedd: Added AppDomain description

= OpenSim.Region.ScriptEngine.Common =

== How to implement your own script engine ==
Creating a new script engine for OpenSim is simple (haha). 
What I mean by simple is that if you already have a VM (Virtual Machine) or script engine of some sort then integrating it as a OpenSim ScriptEngine plugin is simple. 
 

== So what do I get for free? ==
1. Loading/unloading of scripts are queued and executed in sequence. Only one load/unload at the time. 
 
2. What script belongs to what object is automatically taken care of. You just need to provide the scripts classes - nothing else. 
 
3. OpenSim events are translated and given to you as LSL events. Your script functions are executed automatically, no need to hook up to events or anything. 
If you want to implement your own event handlers, feel free to do so. Look in "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.EventManager.cs" how its done. Your own events can run together with LSL events without any problem. 
 
4. Whenever an event is executed, the execution is queued. Only one event per script is ever executed simultaneous. But multithreading is used to run multiple scripts in parallel. 
 
5. Errors during script execution is automatically handled and relayed to users in-world. 
 
6. You get all LSL commands in an easy to use object, no need to keep track of scene or objects to execute functions. Running an LSL command from your script engine is as easy as running it from inside any LSL-script. 
 
7. Long LSL-commands that returns with an event is also handled. 

 
===How do I get started?===
1. Create a new project named "OpenSim.Region.MySuperScriptEngine" (replace "MySuperScriptEngine" with the name of your scriptengine). 
2. Create a new class (file) named "ScriptEngine". It must be named exactly ScriptEngine for OpenSim to use it. ScriptEngine must inherit from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine". 
3. You need to override a couple of functions. Most probably you don't want to do any special work here, so look below for a sample default file.
4. Create a new class (file) named "ScriptManager" that inherits from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager". 
5. Your ScriptManager class needs to override two functions. One to start a script and one to stop a script. 
 

=== ScriptEngine class ===
The main purpose of ScriptEngine class is to be able to intercept scene, for example starting with a "fake" scene instead of OpenSim's scene. You probably don't want this, so just go for the standard initialization. 
A standard class would look like this: 
using System;
using Nini.Config;
using OpenSim.Framework.Console;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.ScriptEngine.MySuperScriptEngine
{
[Serializable]
public class ScriptEngine : OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine
{
public override void Initialise(Scene scene, IConfigSource config)
{
InitializeEngine(scene, MainLog.Instance, true, GetScriptManager());
}
public override OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager _GetScriptManager()
{
return new ScriptManager(this);
}
}
}

=== ScriptManager class ===
A script is refecenced by object id "localID" (the object/prim it is inside) and script id "itemID" (the particular (unique) instance of that script). These parameters along with a string "Script" containing the script text (source code) are passed to your (overriden) start script function in your ScriptManager class. 
 
Keeping track of active scripts is done automatically, so your job is simply to create a new script and hand it over. After that your work is done until the script is asked to stop, then you have to do a few simple tasks to remove it again. 
Here is a sample on a minimal script startup:
public override void _StartScript(uint localID, LLUUID itemID, string Script)
{
SceneObjectPart m_host = World.GetSceneObjectPart(localID);
try
{
IScript CompiledScript = MySpecialCompiler.DoCompile(Script); // Compile and return an IScript object that is the actual script
CompiledScript.Source = ScriptSource; // Store source for recompile on script reset events
SetScript(localID, itemID, CompiledScript); // All is ok. Add script to OpenSim's script manager. From here on its on autopilot.
// Create a private instance of LSL commands (note that m_scriptEngine, m_host are from baseclass, so you don't need to change them)
LSL_BuiltIn_Commands LSLB = new LSL_BuiltIn_Commands(m_scriptEngine, m_host, localID, itemID);
CompiledScript.Start(LSLB); // Start the script - giving it LSL commands
// Fire the first start-event, this is the event run on LSL scripts when they first start
m_scriptEngine.m_EventQueueManager.AddToScriptQueue(localID, itemID, "state_entry", EventQueueManager.llDetectNull, new object[] { });
}
catch (Exception e)
{
// To see how you can send the compile error in-world, have a look at OpenSim.Region.ScriptEngine.DotNetEngine.ScriptManager
}
}

And your minimal script shutdown would be:
public override void _StopScript(uint localID, LLUUID itemID)
{
m_scriptEngine.m_LSLLongCmdHandler.RemoveScript(localID, itemID); // Stop long command on script like timers, http requests, etc.
IScript LSLBC = GetScript(localID, itemID); // Get the script we are stopping
if (LSLBC == null) // Nothing to do? Exit.
return;
try
{
LSLBC.Exec.StopScript(); // Tell script to stop
RemoveScript(localID, itemID); // Remove script from internal memory structure
}
catch (Exception e)
{
// You probably want to log this to console or something
}
}

===IScript interface===
So you have implemented the two classes described above. Now how does this connect to your JavaScript or Perl or YourCustomSuperLanguage script engine or VM? 
 
You have to create a class. This class must inherit "OpenSim.Region.ScriptEngine.Common.IScript". Inside IScript your class will have two important things: 
 
1. During script start (in ScriptManager), you call yourscript.Start() and give it a LSL command module. So insite your script class where you override this Start() function you need to remember this LSL command module. 
How you bind this LSL command module to your custom engine is totally up to you. The LSL command module contains all LSL functions, and any function you use there will affect the correct object/region/whatever. You don't need to do more than ''myLSLCommandModule.llSay(0, "Hello world!");'' to make it work. 
 
2. Any time a LSL event is generated either by an in-world event or by for example a timer, a function in your script class needs to be executed. For this you have the "Exec" override. I suggest you have a look at "OpenSim.Region.ScriptEngine.Common.Executor" to see how this work. Basically you receive a string containing function name and the parameters for that event. 
If you use the default Executor you need to initialize it by giving it a reference to yourself (the IScript script class). Then you need to have functions in your class matching LSL functions when it comes to both name and parameters. Example: 
public touch_start(int number_of_touches) {
// whatever code for this event... probably calling your own VM's function with the same name? ;)
}

===AppDomain security===
If you are writing a .Net based script engine and want AppDomain security and loading/unloading then:
// Load script:
IScript CompiledScript = m_scriptEngine.m_AppDomainManager.LoadScript(filename);
and
// Unload script:
m_scriptEngine.m_AppDomainManager.StopScript(LSLBC.Exec.GetAppDomain());

OpenSim.Region.ScriptEngine.Common

2008-01-20T19:20:11Z

Tedd:

= OpenSim.Region.ScriptEngine.Common =

== How to implement your own script engine ==
Creating a new script engine for OpenSim is simple (haha). 
What I mean by simple is that if you already have a VM (Virtual Machine) or script engine of some sort then integrating it as a OpenSim ScriptEngine plugin is simple. 
 

== So what do I get for free? ==
1. Loading/unloading of scripts are queued and executed in sequence. Only one load/unload at the time. 
 
2. What script belongs to what object is automatically taken care of. You just need to provide the scripts classes - nothing else. 
 
3. OpenSim events are translated and given to you as LSL events. Your script functions are executed automatically, no need to hook up to events or anything. 
If you want to implement your own event handlers, feel free to do so. Look in "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.EventManager.cs" how its done. Your own events can run together with LSL events without any problem. 
 
4. Whenever an event is executed, the execution is queued. Only one event per script is ever executed simultaneous. But multithreading is used to run multiple scripts in parallel. 
 
5. Errors during script execution is automatically handled and relayed to users in-world. 
 
6. You get all LSL commands in an easy to use object, no need to keep track of scene or objects to execute functions. Running an LSL command from your script engine is as easy as running it from inside any LSL-script. 
 
7. Long LSL-commands that returns with an event is also handled. 

 
===How do I get started?===
1. Create a new project named "OpenSim.Region.MySuperScriptEngine" (replace "MySuperScriptEngine" with the name of your scriptengine). 
2. Create a new class (file) named "ScriptEngine". It must be named exactly ScriptEngine for OpenSim to use it. ScriptEngine must inherit from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine". 
3. You need to override a couple of functions. Most probably you don't want to do any special work here, so look below for a sample default file.
4. Create a new class (file) named "ScriptManager" that inherits from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager". 
5. Your ScriptManager class needs to override two functions. One to start a script and one to stop a script. 
 

=== ScriptEngine class ===
The main purpose of ScriptEngine class is to be able to intercept scene, for example starting with a "fake" scene instead of OpenSim's scene. You probably don't want this, so just go for the standard initialization. 
A standard class would look like this: 
using System;
using Nini.Config;
using OpenSim.Framework.Console;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.ScriptEngine.MySuperScriptEngine
{
[Serializable]
public class ScriptEngine : OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine
{
public override void Initialise(Scene scene, IConfigSource config)
{
InitializeEngine(scene, MainLog.Instance, true, GetScriptManager());
}
public override OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager _GetScriptManager()
{
return new ScriptManager(this);
}
}
}

=== ScriptManager class ===
A script is refecenced by object id "localID" (the object/prim it is inside) and script id "itemID" (the particular (unique) instance of that script). These parameters along with a string "Script" containing the script text (source code) are passed to your (overriden) start script function in your ScriptManager class. 
 
Keeping track of active scripts is done automatically, so your job is simply to create a new script and hand it over. After that your work is done until the script is asked to stop, then you have to do a few simple tasks to remove it again. 
Here is a sample on a minimal script startup:
public override void _StartScript(uint localID, LLUUID itemID, string Script)
{
SceneObjectPart m_host = World.GetSceneObjectPart(localID);
try
{
IScript CompiledScript = MySpecialCompiler.DoCompile(Script); // Compile and return an IScript object that is the actual script
CompiledScript.Source = ScriptSource; // Store source for recompile on script reset events
SetScript(localID, itemID, CompiledScript); // All is ok. Add script to OpenSim's script manager. From here on its on autopilot.
// Create a private instance of LSL commands (note that m_scriptEngine, m_host are from baseclass, so you don't need to change them)
LSL_BuiltIn_Commands LSLB = new LSL_BuiltIn_Commands(m_scriptEngine, m_host, localID, itemID);
CompiledScript.Start(LSLB); // Start the script - giving it LSL commands
// Fire the first start-event, this is the event run on LSL scripts when they first start
m_scriptEngine.m_EventQueueManager.AddToScriptQueue(localID, itemID, "state_entry", EventQueueManager.llDetectNull, new object[] { });
}
catch (Exception e)
{
// To see how you can send the compile error in-world, have a look at OpenSim.Region.ScriptEngine.DotNetEngine.ScriptManager
}
}

And your minimal script shutdown would be:
public override void _StopScript(uint localID, LLUUID itemID)
{
m_scriptEngine.m_LSLLongCmdHandler.RemoveScript(localID, itemID); // Stop long command on script like timers, http requests, etc.
IScript LSLBC = GetScript(localID, itemID); // Get the script we are stopping
if (LSLBC == null) // Nothing to do? Exit.
return;
try
{
LSLBC.Exec.StopScript(); // Tell script to stop
RemoveScript(localID, itemID); // Remove script from internal memory structure
}
catch (Exception e)
{
// You probably want to log this to console or something
}
}

===IScript interface===
So you have implemented the two classes described above. Now how does this connect to your JavaScript or Perl or YourCustomSuperLanguage script engine or VM? 
 
You have to create a class. This class must inherit "OpenSim.Region.ScriptEngine.Common.IScript". Inside IScript your class will have two important things: 
 
1. During script start (in ScriptManager), you call yourscript.Start() and give it a LSL command module. So insite your script class where you override this Start() function you need to remember this LSL command module. 
How you bind this LSL command module to your custom engine is totally up to you. The LSL command module contains all LSL functions, and any function you use there will affect the correct object/region/whatever. You don't need to do more than ''myLSLCommandModule.llSay(0, "Hello world!");'' to make it work. 
 
2. Any time a LSL event is generated either by an in-world event or by for example a timer, a function in your script class needs to be executed. For this you have the "Exec" override. I suggest you have a look at "OpenSim.Region.ScriptEngine.Common.Executor" to see how this work. Basically you receive a string containing function name and the parameters for that event. 
If you use the default Executor you need to initialize it by giving it a reference to yourself (the IScript script class). Then you need to have functions in your class matching LSL functions when it comes to both name and parameters. Example: 
public touch_start(int number_of_touches) {
// whatever code for this event... probably calling your own VM's function with the same name? ;)
}

OpenSim.Region.ScriptEngine.Common

2008-01-20T19:19:39Z

Tedd:

= OpenSim.Region.ScriptEngine.Common =

== How to implement your own script engine ==
Creating a new script engine for OpenSim is simple (haha). 
What I mean by simple is that if you already have a VM (Virtual Machine) or script engine of some sort then integrating it as a OpenSim ScriptEngine plugin is simple. 
 
===How do I get started?===
1. Create a new project named "OpenSim.Region.MySuperScriptEngine" (replace "MySuperScriptEngine" with the name of your scriptengine). 
2. Create a new class (file) named "ScriptEngine". It must be named exactly ScriptEngine for OpenSim to use it. ScriptEngine must inherit from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine". 
3. You need to override a couple of functions. Most probably you don't want to do any special work here, so look below for a sample default file.
4. Create a new class (file) named "ScriptManager" that inherits from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager". 
5. Your ScriptManager class needs to override two functions. One to start a script and one to stop a script. 
 

=== ScriptEngine class ===
The main purpose of ScriptEngine class is to be able to intercept scene, for example starting with a "fake" scene instead of OpenSim's scene. You probably don't want this, so just go for the standard initialization. 
A standard class would look like this: 
using System;
using Nini.Config;
using OpenSim.Framework.Console;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.ScriptEngine.MySuperScriptEngine
{
[Serializable]
public class ScriptEngine : OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine
{
public override void Initialise(Scene scene, IConfigSource config)
{
InitializeEngine(scene, MainLog.Instance, true, GetScriptManager());
}
public override OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager _GetScriptManager()
{
return new ScriptManager(this);
}
}
}

=== ScriptManager class ===
A script is refecenced by object id "localID" (the object/prim it is inside) and script id "itemID" (the particular (unique) instance of that script). These parameters along with a string "Script" containing the script text (source code) are passed to your (overriden) start script function in your ScriptManager class. 
 
Keeping track of active scripts is done automatically, so your job is simply to create a new script and hand it over. After that your work is done until the script is asked to stop, then you have to do a few simple tasks to remove it again. 
Here is a sample on a minimal script startup:
public override void _StartScript(uint localID, LLUUID itemID, string Script)
{
SceneObjectPart m_host = World.GetSceneObjectPart(localID);
try
{
IScript CompiledScript = MySpecialCompiler.DoCompile(Script); // Compile and return an IScript object that is the actual script
CompiledScript.Source = ScriptSource; // Store source for recompile on script reset events
SetScript(localID, itemID, CompiledScript); // All is ok. Add script to OpenSim's script manager. From here on its on autopilot.
// Create a private instance of LSL commands (note that m_scriptEngine, m_host are from baseclass, so you don't need to change them)
LSL_BuiltIn_Commands LSLB = new LSL_BuiltIn_Commands(m_scriptEngine, m_host, localID, itemID);
CompiledScript.Start(LSLB); // Start the script - giving it LSL commands
// Fire the first start-event, this is the event run on LSL scripts when they first start
m_scriptEngine.m_EventQueueManager.AddToScriptQueue(localID, itemID, "state_entry", EventQueueManager.llDetectNull, new object[] { });
}
catch (Exception e)
{
// To see how you can send the compile error in-world, have a look at OpenSim.Region.ScriptEngine.DotNetEngine.ScriptManager
}
}

And your minimal script shutdown would be:
public override void _StopScript(uint localID, LLUUID itemID)
{
m_scriptEngine.m_LSLLongCmdHandler.RemoveScript(localID, itemID); // Stop long command on script like timers, http requests, etc.
IScript LSLBC = GetScript(localID, itemID); // Get the script we are stopping
if (LSLBC == null) // Nothing to do? Exit.
return;
try
{
LSLBC.Exec.StopScript(); // Tell script to stop
RemoveScript(localID, itemID); // Remove script from internal memory structure
}
catch (Exception e)
{
// You probably want to log this to console or something
}
}

===IScript interface===
So you have implemented the two classes described above. Now how does this connect to your JavaScript or Perl or YourCustomSuperLanguage script engine or VM? 
 
You have to create a class. This class must inherit "OpenSim.Region.ScriptEngine.Common.IScript". Inside IScript your class will have two important things: 
 
1. During script start (in ScriptManager), you call yourscript.Start() and give it a LSL command module. So insite your script class where you override this Start() function you need to remember this LSL command module. 
How you bind this LSL command module to your custom engine is totally up to you. The LSL command module contains all LSL functions, and any function you use there will affect the correct object/region/whatever. You don't need to do more than ''myLSLCommandModule.llSay(0, "Hello world!");'' to make it work. 
 
2. Any time a LSL event is generated either by an in-world event or by for example a timer, a function in your script class needs to be executed. For this you have the "Exec" override. I suggest you have a look at "OpenSim.Region.ScriptEngine.Common.Executor" to see how this work. Basically you receive a string containing function name and the parameters for that event. 
If you use the default Executor you need to initialize it by giving it a reference to yourself (the IScript script class). Then you need to have functions in your class matching LSL functions when it comes to both name and parameters. Example: 
public touch_start(int number_of_touches) {
// whatever code for this event... probably calling your own VM's function with the same name? ;)
}

== So what do I get for free? ==
1. Loading/unloading of scripts are queued and executed in sequence. Only one load/unload at the time. 
 
2. What script belongs to what object is automatically taken care of. You just need to provide the scripts classes - nothing else. 
 
3. OpenSim events are translated and given to you as LSL events. Your script functions are executed automatically, no need to hook up to events or anything. 
If you want to implement your own event handlers, feel free to do so. Look in "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.EventManager.cs" how its done. Your own events can run together with LSL events without any problem. 
 
4. Whenever an event is executed, the execution is queued. Only one event per script is ever executed simultaneous. But multithreading is used to run multiple scripts in parallel. 
 
5. Errors during script execution is automatically handled and relayed to users in-world. 
 
6. You get all LSL commands in an easy to use object, no need to keep track of scene or objects to execute functions. Running an LSL command from your script engine is as easy as running it from inside any LSL-script. 
 
7. Long LSL-commands that returns with an event is also handled.

OpenSim.Region.ScriptEngine.Common

2008-01-20T19:18:19Z

Tedd:

= OpenSim.Region.ScriptEngine.Common =

== How to implement your own script engine ==
Creating a new script engine for OpenSim is simple (haha). 
What I mean by simple is that if you already have a VM (Virtual Machine) or script engine of some sort then integrating it as a OpenSim ScriptEngine plugin is simple. 
 
===How do I get started?===
1. Create a new project named "OpenSim.Region.MySuperScriptEngine" (replace "MySuperScriptEngine" with the name of your scriptengine). 
2. Create a new class (file) named "ScriptEngine". It must be named exactly ScriptEngine for OpenSim to use it. ScriptEngine must inherit from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine". 
3. You need to override a couple of functions. Most probably you don't want to do any special work here, so look below for a sample default file.
4. Create a new class (file) named "ScriptManager" that inherits from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager". 
5. Your ScriptManager class needs to override two functions. One to start a script and one to stop a script. 
 

=== ScriptEngine class ===
The main purpose of ScriptEngine class is to be able to intercept scene, for example starting with a "fake" scene instead of OpenSim's scene. You probably don't want this, so just go for the standard initialization. 
A standard class would look like this: 
using System;
using Nini.Config;
using OpenSim.Framework.Console;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.ScriptEngine.MySuperScriptEngine
{
[Serializable]
public class ScriptEngine : OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine
{
public override void Initialise(Scene scene, IConfigSource config)
{
InitializeEngine(scene, MainLog.Instance, true, GetScriptManager());
}
public override OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager _GetScriptManager()
{
return new ScriptManager(this);
}
}
}

=== ScriptManager class ===
A script is refecenced by object id "localID" (the object/prim it is inside) and script id "itemID" (the particular (unique) instance of that script). These parameters along with a string "Script" containing the script text (source code) are passed to your (overriden) start script function in your ScriptManager class. 
 
Keeping track of active scripts is done automatically, so your job is simply to create a new script and hand it over. After that your work is done until the script is asked to stop, then you have to do a few simple tasks to remove it again. 
Here is a sample on a minimal script startup:
public override void _StartScript(uint localID, LLUUID itemID, string Script)
{
SceneObjectPart m_host = World.GetSceneObjectPart(localID);
try
{
IScript CompiledScript = MySpecialCompiler.DoCompile(Script); // Compile and return an IScript object that is the actual script
CompiledScript.Source = ScriptSource; // Store source for recompile on script reset events
SetScript(localID, itemID, CompiledScript); // All is ok. Add script to OpenSim's script manager. From here on its on autopilot.
// Create a private instance of LSL commands (note that m_scriptEngine, m_host are from baseclass, so you don't need to change them)
LSL_BuiltIn_Commands LSLB = new LSL_BuiltIn_Commands(m_scriptEngine, m_host, localID, itemID);
CompiledScript.Start(LSLB); // Start the script - giving it LSL commands
// Fire the first start-event, this is the event run on LSL scripts when they first start
m_scriptEngine.m_EventQueueManager.AddToScriptQueue(localID, itemID, "state_entry", EventQueueManager.llDetectNull, new object[] { });
}
catch (Exception e)
{
// To see how you can send the compile error in-world, have a look at OpenSim.Region.ScriptEngine.DotNetEngine.ScriptManager
}
}

And your minimal script shutdown would be:
public override void _StopScript(uint localID, LLUUID itemID)
{
m_scriptEngine.m_LSLLongCmdHandler.RemoveScript(localID, itemID); // Stop long command on script like timers, http requests, etc.
IScript LSLBC = GetScript(localID, itemID); // Get the script we are stopping
if (LSLBC == null) // Nothing to do? Exit.
return;
try
{
LSLBC.Exec.StopScript(); // Tell script to stop
RemoveScript(localID, itemID); // Remove script from internal memory structure
}
catch (Exception e)
{
// You probably want to log this to console or something
}
}

===IScript interface===
So you have implemented the two classes described above. Now how does this connect to your JavaScript or Perl or YourCustomSuperLanguage script engine or VM? 
 
You have to create a class. This class must inherit "OpenSim.Region.ScriptEngine.Common.IScript". Inside IScript your class will have two major things: 
 
1. During script start (in ScriptManager), you call yourscript.Start() and give it a LSL command module. So insite your script class where you override this Start() function you need to remember this LSL command module. 
How you bind this LSL command module to your custom engine is totally up to you. The LSL command module contains all LSL functions, and any function you use there will affect the correct object/region/whatever. You don't need to do more than ''myLSLCommandModule.llSay(0, "Hello world!");'' to make it work. 
 
2. Any time a LSL event is generated either by an in-world event or by for example a timer, a function in your script class needs to be executed. For this you have the "Exec" override. I suggest you have a look at "OpenSim.Region.ScriptEngine.Common.Executor" to see how this work. Basically you receive a string containing function name and the parameters for that event. 
If you use the default Executor you need to initialize it by giving it a reference to yourself (the IScript script class). Then you need to have functions in your class matching LSL functions when it comes to both name and parameters. Example: 
public touch_start(int number_of_touches) {
// whatever code for this event... probably calling your own VM's function with the same name? ;)
}

== So what do I get for free? ==
1. Loading/unloading of scripts are queued and executed in sequence. Only one load/unload at the time. 
 
2. What script belongs to what object is automatically taken care of. You just need to provide the scripts classes - nothing else. 
 
3. OpenSim events are translated and given to you as LSL events. Your script functions are executed automatically, no need to hook up to events or anything. 
If you want to implement your own event handlers, feel free to do so. Look in "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.EventManager.cs" how its done. Your own events can run together with LSL events without any problem. 
 
4. Whenever an event is executed, the execution is queued. Only one event per script is ever executed simultaneous. But multithreading is used to run multiple scripts in parallel. 
 
5. Errors during script execution is automatically handled and relayed to users in-world. 
 
6. You get all LSL commands in an easy to use object, no need to keep track of scene or objects to execute functions. Running an LSL command from your script engine is as easy as running it from inside any LSL-script. 
 
7. Long LSL-commands that returns with an event is also handled.

OpenSim.Region.ScriptEngine.Common

2008-01-20T19:09:39Z

Tedd:

= OpenSim.Region.ScriptEngine.Common =

== How to implement your own script engine ==
Creating a new script engine for OpenSim is simple (haha). 
What I mean by simple is that if you already have a VM (Virtual Machine) or script engine of some sort then integrating it as a OpenSim ScriptEngine plugin is simple. 
 
===How do I get started?===
1. Create a new project named "OpenSim.Region.MySuperScriptEngine" (replace "MySuperScriptEngine" with the name of your scriptengine). 
2. Create a new class (file) named "ScriptEngine". It must be named exactly ScriptEngine for OpenSim to use it. ScriptEngine must inherit from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine". 
3. You need to override a couple of functions. Most probably you don't want to do any special work here, so look below for a sample default file.
4. Create a new class (file) named "ScriptManager" that inherits from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager". 
5. Your ScriptManager class needs to override two functions. One to start a script and one to stop a script. 
 

=== ScriptEngine class ===
The main purpose of ScriptEngine class is to be able to intercept scene, for example starting with a "fake" scene instead of OpenSim's scene. You probably don't want this, so just go for the standard initialization. 
A standard class would look like this: 
using System;
using Nini.Config;
using OpenSim.Framework.Console;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.ScriptEngine.MySuperScriptEngine
{
[Serializable]
public class ScriptEngine : OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine
{
public override void Initialise(Scene scene, IConfigSource config)
{
InitializeEngine(scene, MainLog.Instance, true, GetScriptManager());
}
public override OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager _GetScriptManager()
{
return new ScriptManager(this);
}
}
}

=== ScriptManager class ===
A script is refecenced by object id "localID" (the object/prim it is inside) and script id "itemID" (the particular (unique) instance of that script). These parameters along with a string "Script" containing the script text (source code) are passed to your (overriden) start script function in your ScriptManager class. 
 
Keeping track of active scripts is done automatically, so your job is simply to create a new script and hand it over. After that your work is done until the script is asked to stop, then you have to do a few simple tasks to remove it again. 
Here is a sample on a minimal script startup:
public override void _StartScript(uint localID, LLUUID itemID, string Script)
{
SceneObjectPart m_host = World.GetSceneObjectPart(localID);
try
{
IScript CompiledScript = MySpecialCompiler.DoCompile(Script); // Compile and return an IScript object that is the actual script
CompiledScript.Source = ScriptSource; // Store source for recompile on script reset events
SetScript(localID, itemID, CompiledScript); // All is ok. Add script to OpenSim's script manager. From here on its on autopilot.
// Create a private instance of LSL commands (note that m_scriptEngine, m_host are from baseclass, so you don't need to change them)
LSL_BuiltIn_Commands LSLB = new LSL_BuiltIn_Commands(m_scriptEngine, m_host, localID, itemID);
CompiledScript.Start(LSLB); // Start the script - giving it LSL commands
// Fire the first start-event, this is the event run on LSL scripts when they first start
m_scriptEngine.m_EventQueueManager.AddToScriptQueue(localID, itemID, "state_entry", EventQueueManager.llDetectNull, new object[] { });
}
catch (Exception e)
{
// To see how you can send the compile error in-world, have a look at OpenSim.Region.ScriptEngine.DotNetEngine.ScriptManager
}
}

And your minimal script shutdown would be:
public override void _StopScript(uint localID, LLUUID itemID)
{
m_scriptEngine.m_LSLLongCmdHandler.RemoveScript(localID, itemID); // Stop long command on script like timers, http requests, etc.
IScript LSLBC = GetScript(localID, itemID); // Get the script we are stopping
if (LSLBC == null) // Nothing to do? Exit.
return;
try
{
LSLBC.Exec.StopScript(); // Tell script to stop
RemoveScript(localID, itemID); // Remove script from internal memory structure
}
catch (Exception e)
{
// You probably want to log this to console or something
}
}

===IScript interface===
So you have implemented the two classes described above. Now how does this connect to your JavaScript or Perl or YourCustomSuperLanguage script engine or VM? 
 
You have to create a class. This class must inherit "OpenSim.Region.ScriptEngine.Common.IScript". Inside IScript your class will have two major things: 
 
1. During script start (in ScriptManager), you call yourscript.Start() and give it a LSL command module. So insite your script class where you override this Start() function you need to remember this LSL command module. 
How you bind this LSL command module to your custom engine is totally up to you. The LSL command module contains all LSL functions, and any function you use there will affect the correct object/region/whatever. You don't need to do more than ''myLSLCommandModule.llSay(0, "Hello world!");'' to make it work. 
 
2. Any time a LSL event is generated either by an in-world event or by for example a timer, a function in your script class needs to be executed. For this you have the "Exec" override. I suggest you have a look at "OpenSim.Region.ScriptEngine.Common.Executor" to see how this work. Basically you receive a string containing function name and the parameters for that event. 
If you use the default Executor you need to initialize it by giving it a reference to yourself (the IScript script class). Then you need to have functions in your class matching LSL functions when it comes to both name and parameters. Example: 
public touch_start(int number_of_touches) {
// whatever code for this event... probably calling your own VM's function with the same name? ;)
}

OpenSim.Region.ScriptEngine.Common

2008-01-20T19:07:30Z

Tedd:

= OpenSim.Region.ScriptEngine.Common =

== How to implement your own script engine ==
Creating a new script engine for OpenSim is simple (haha). 
What I mean by simple is that if you already have a VM (Virtual Machine) or script engine of some sort then integrating it as a OpenSim ScriptEngine plugin is simple. 
 
===How do I get started?===
1. Create a new project named "OpenSim.Region.MySuperScriptEngine" (replace "MySuperScriptEngine" with the name of your scriptengine). 
2. Create a new class (file) named "ScriptEngine". It must be named exactly ScriptEngine for OpenSim to use it. ScriptEngine must inherit from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine". 
3. You need to override a couple of functions. Most probably you don't want to do any special work here, so look below for a sample default file.
4. Create a new class (file) named "ScriptManager" that inherits from "OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager". 
5. Your ScriptManager class needs to override two functions. One to start a script and one to stop a script. 
 

=== ScriptEngine class ===
The main purpose of ScriptEngine class is to be able to intercept scene, for example starting with a "fake" scene instead of OpenSim's scene. You probably don't want this, so just go for the standard initialization. 
A standard class would look like this: 
using System;
using Nini.Config;
using OpenSim.Framework.Console;
using OpenSim.Region.Environment.Scenes;
namespace OpenSim.Region.ScriptEngine.MySuperScriptEngine
{
[Serializable]
public class ScriptEngine : OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptEngine
{
public override void Initialise(Scene scene, IConfigSource config)
{
InitializeEngine(scene, MainLog.Instance, true, GetScriptManager());
}
public override OpenSim.Region.ScriptEngine.Common.ScriptEngineBase.ScriptManager _GetScriptManager()
{
return new ScriptManager(this);
}
}
}

=== ScriptManager class ===
A script is refecenced by object id "localID" (the object/prim it is inside) and script id "itemID" (the particular (unique) instance of that script). These parameters along with a string "Script" containing the script text (source code) are passed to your (overriden) start script function in your ScriptManager class. 
 
Keeping track of active scripts is done automatically, so your job is simply to create a new script and hand it over. After that your work is done until the script is asked to stop, then you have to do a few simple tasks to remove it again. 
Here is a sample on a minimal script startup:
public override void _StartScript(uint localID, LLUUID itemID, string Script)
{
SceneObjectPart m_host = World.GetSceneObjectPart(localID);
try
{
IScript CompiledScript = MySpecialCompiler.DoCompile(Script); // Compile and return an IScript object that is the actual script
CompiledScript.Source = ScriptSource; // Store source for recompile on script reset events
SetScript(localID, itemID, CompiledScript); // All is ok. Add script to OpenSim's script manager. From here on its on autopilot.
// Create a private instance of LSL commands (note that m_scriptEngine, m_host are from baseclass, so you don't need to change them)
LSL_BuiltIn_Commands LSLB = new LSL_BuiltIn_Commands(m_scriptEngine, m_host, localID, itemID);
CompiledScript.Start(LSLB); // Start the script - giving it LSL commands
// Fire the first start-event, this is the event run on LSL scripts when they first start
m_scriptEngine.m_EventQueueManager.AddToScriptQueue(localID, itemID, "state_entry", EventQueueManager.llDetectNull, new object[] { });
}
catch (Exception e)
{
// To see how you can send the compile error in-world, have a look at OpenSim.Region.ScriptEngine.DotNetEngine.ScriptManager
}
}

And your minimal script shutdown would be:
public override void _StopScript(uint localID, LLUUID itemID)
{
m_scriptEngine.m_LSLLongCmdHandler.RemoveScript(localID, itemID); // Stop long command on script like timers, http requests, etc.
IScript LSLBC = GetScript(localID, itemID); // Get the script we are stopping
if (LSLBC == null) // Nothing to do? Exit.
return;
try
{
LSLBC.Exec.StopScript(); // Tell script to stop
RemoveScript(localID, itemID); // Remove script from internal memory structure
}
catch (Exception e)
{
// You probably want to log this to console or something
}
}

===IScript interface===
So you have implemented the two classes described above. Now how does this connect to your JavaScript or Perl or YourCustomSuperLanguage script engine or VM? 
You have to create a class. This class must inherit "OpenSim.Region.ScriptEngine.Common.IScript". Inside IScript your class will have two major things: 
1. During script start (in ScriptManager), you call yourscript.Start() and give it a LSL command module. So insite your script class where you override this Start() function you need to remember this LSL command module. 
How you bind this LSL command module to your custom engine is totally up to you. The LSL command module contains all LSL functions, and any function you use there will affect the correct object/region/whatever. You don't need to do more than ''myLSLCommandModule.llSay(0, "Hello world!");'' to make it work. 
2. Any time a LSL event is generated either by an in-world event or by for example a timer, a function in your script class needs to be executed. For this you have the "Exec" override. I suggest you have a look at "OpenSim.Region.ScriptEngine.Common.Executor" to see how this work. Basically you receive a string containing function name and the parameters for that event. 
If you use the default Executor you need to initialize it by giving it a reference to yourself (the IScript script class). Then you need to have functions in your class matching LSL functions when it comes to both name and parameters. Example: 
public touch_start

OpenSim.Region.ScriptEngine.Common

2008-01-20T18:55:34Z

Tedd:

OpenSim.Region.ScriptEngine.Common

2008-01-20T18:54:45Z

Tedd: Explanation on how to implement your own ScriptEngine

Configuration

2008-01-01T15:59:12Z

Tedd: /* Shutdown Servers */

It is recommended that you first get OpenSim running in standalone mode, before you attempt to connect it to a grid, either your own grid or a public grid.

A simulator actually consists of four services, known as UGAS which stand for User, Grid, Asset & Simulator. They are started in that order.

A simulator running in its default standalone mode has all the services self-contained, but they are very modest. This means any first/last/password works. It also means inventory is all local with no region or grid-wide connections.

A simulator running as a local grid runs all four services on the same computer. Multiple sims can be run, across-region crossing including teleporting and a set of inventory items that are within this local grid.

A simulator running as part of a public grid runs only OpenSim.exe and the other three services are running on a server common to many regions. This also means that understanding the needed UUID, X,Y location, server handshake passwords, master avatar first/last/password and a couple of other settings. These are not difficult, but do require a little care in setting up.

=Command Line arguments passed to OpenSim.exe=

OpenSim.exe responds to various command line arguments. These include "-inifile", "-configfile", "-gridmode", "-physics", "-config" & "-noverbose".

When starting OpenSim in either Windows or Linux, one can add "-physics=OpenDynamicsEngine" to run the OpenDynamicsEngine instead of basicphysics.

Most users in standalone mode will not add any command line arguments. For local grid or public grid, the "-gridmode=true" is usually the only argument used. The rest are for more advanced configuration.

=OpenSim configuration file=
The simulator configuration is managed using a file called [[OpenSim.ini]]. This file is used regardless of whether the sim is running in standalone or grid mode. Detailed information on the options available for setttings in this file can be found [[OpenSim.ini|here]].
=Standalone mode=

When you start OpenSim in standalone mode, it will ask you several question at the console. The first set of prompts that start with "NETWORK SERVERS INFO", you can just hit return to accept the defaults if you will be running in standalone mode.

The prompts that start with "DEFAULT REGION CONFIG" are where you need to start paying attention. Some are self-explanatory. Here are explanations for the others:

* Grid Location. OpenSim regions can be placed anywhere on a 65536 by 65536 grid. In standalone mode, it is safe to leave these X and Y locations at their defaults.

* Filename for local storage. Safe to leave at default.

* Internal IP address; This should always be 0.0.0.0

* Internal IP port for incoming UDP client connection. You can make this any port you want, but it is safe to leave at the default 9000.

* External host name. If you will only be attaching to your sim from a SecondLife client on the same machine, you can leave this at the default 127.0.0.1. If you will be wanting to connect to it from a client on another machine, this should be the IP address or hostname of the machine you are running this sim on.

To connect to your new sim, start up secondlife with the following command line switches:

-loginuri http://127.0.0.1:9000/

This assumes you are running the secondlife client on the same box. If you are running it on a separate box, substitute the IP address of your sim machine.

To create a user:
type "create user <first> <last> <password> <x_loc> <y_loc>" in the server console

=Grid mode=

You want to run your own grid. Great! Assuming that you already got your sim running in standalone mode, here is what you need to do:

1. Current builds of OpenSim grid mode are using mysql to store the grid information. You must have this installed and configured if you want to run your own grid. See [[mysql-config]] for more information.

2. The servers should be started in a certain order. UGAS: UserServer, GridServer, AssetServer, InventoryServer, Sim. These are all found in the bin directory. In windows, you can just double-click on the executables to start them. In linux, you will probably have to start them with mono. The executable names are:

OpenSim.Grid.UserServer.exe
OpenSim.Grid.GridServer.exe
OpenSim.Grid.AssetServer.exe
OpenSim.Grid.InventoryServer.exe
OpenSim.exe

3. Start the UserServer. If you will be running the GridServer on the same box, hit enter to accept the defaults, until it gives you the prompt

OpenUser#

This is the main prompt for the user server. If you will be running the GridServer on another box, change the Default Grid Server URI as appropriate.

4. Start the GridServer. Again, you can hit return at all the prompts if you are running them all on the same machine. If not, change the URIs for the Asset Server and User server to point to where you are running them. You will finally get to the console prompt for the GridServer which looks like this:

OpenGrid#

5. Start the AssetServer. The console prompt for this server will be:

OpenAsset#

6. Start the InventoryServer. The console prompt for this server will be:

INVENTORY#

7. If you are running all of these servers on the same box, which would be the normal configuration. You should be ready to start up your sim. Since the OpenSim.exe starts up by default in standalone mode, you will need to give it a command line switch to tell it to use gridmode instead:

OpenSim.exe -gridmode=true

or

mono OpenSim.exe -gridmode=true

With any luck, everything will come up without too many errors.

8. Go to the UserServer console, and type 'create user' to create a new avatar. It will prompt you for the name and password, and the X and Y of the sim that should be his home location. Use 1000 and 1000, or wherever you told your sim to live when you brought it up in standalone mode.

At the console of any of these servers, you should be able to type 'help' to get a list of commands.

You should now be able to connect to your new grid with your secondlife client. You need to tell your client to point at the UserServer rather than directly at the sim, though:

secondlife -loginuri http://127.0.0.1:8002/

8002 is the default port for the UserServer, and that IP address should be changed to the server you are running the UserServer on, if they are not all on the same box.

Happy OpenSimming!

''Note: if you are using Windows Vista, remeber to start servers as Admin. If not it will prompt you an error in console like "Error - Access denied"
''
=== Technical Addendum ===
For running multiple regions on the same box, you simply make multiple copies of the 'default.xml' file inside the <tt>bin/Regions/</tt> directory. You can do this using the script <tt>make.php</tt> in <tt>share/regions</tt>, or you can generate the files by hand.

If you want to create the files by hand, first copy the default.xml file in the <tt>bin/Regions</tt> directory, and name them anything you want (I name mine x.y.xml, where x znd y are the grid coords.)

Open each xml file and edit the uuid (each must be unique, a generator can be found at [http://www.famkruithof.net/uuid/uuidgen uuidgen webpage]), region name, x & y positions, datastore (if you are using the prim thing) and internal ip port. EACH OF THESE MUST BE UNIQUE!

Once you have 2 or more xml files in the regions folder, running a ''single copy'' of <tt>OpenSim.exe</tt> will boot all of your sims! If you come across any errors, there is most likely an error in the xml files.

=Attaching your sim to someone else's grid=

To set up the simulation server (i.e., <tt>OpenSim.exe</tt>) to connect to an external grid, you should edit the <tt>OpenSim.ini</tt> file in the <tt>bin</tt> directory. In that file, there is a <tt>[Network]</tt> section with URLs for the grid, user, and asset servers, as well as send and receive keys (for a basic level of security). The addresses and send/receive keys will vary depending on the grid you are connecting to, and the grid operator should tell you what values to use.

The other file you may have to change is in your <tt>bin/Regions</tt> directory. This is where your individual region config files are. If you only have one region, it will by default be called <tt>default.xml</tt>.

This can be edited with any text editor. The grid owner may tell you what X and Y location you can place your sim at (you can't have multiple sims at the smae location on the grid). If so, the fields you will need to change in this file are <tt>sim_location_x</tt> and <tt>sim_location_y</tt>. And the <tt>external_host_name</tt> should be set to the hostname or IP address of your simulation server (i.e., the machine that is running <tt>OpenSim.exe</tt>).

A list of public grids that you can attach your sim to is at [[OpenSim: Grids]]

=Automate Grid Startup=

==Windows==
Create a file called StartGrid.BAT:
start OpenSim.Grid.UserServer.exe
sleep 3
start OpenSim.Grid.GridServer.exe
sleep 3
start OpenSim.Grid.AssetServer.exe
sleep 3
start OpenSim.Grid.InventoryServer.exe
sleep 3
start OpenSim.exe -gridmode=true

PS! Check that you have sleep command installed, I'm unsure if all Windows versions have that. 
This knowledgebase article describes how to add a batch file to startup of Windows (before logon). 
[http://support.microsoft.com/kb/q243486/ http://support.microsoft.com/kb/q243486/] 
Note that you have to start all applications and answer the configuration questions once before adding it to any startup. 
 
If you start the server before logon then there will be no window to close if you want to shut down the server, so you can create a "StopGrid.BAT" with:
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /F /FI "IMAGENAME eq OpenSim.*"

''(Do they have to be shut down in any particular order?)''

==Linux/Mac OS X==

===Use Screen Command===
Use the screen command to automate startup

==== Setup screen command and setup shell file====
screen install:

Linux
apt-get install screen
Mac OS X: Download either MacPorts, http://www.macports.org/, or Fink, http://www.finkproject.org/ to download *nix packages
MacPorts
sudo port install screen
Fink
Need command line for Fink.

Create file runsim.sh
#!/bin/sh
cd opensim/bin
sleep 3
screen -S UserServer -d -m mono OpenSim.Grid.UserServer.exe
sleep 3
screen -S GridServer -d -m mono OpenSim.Grid.GridServer.exe
sleep 3
screen -S AssetServer -d -m mono OpenSim.Grid.AssetServer.exe
sleep 3
screen -S InventoryServer -d -m mono OpenSim.Grid.InventoryServer.exe
sleep 3
screen -S OpenSim -d -m mono OpenSim.exe -gridmode=true

====Startup and access servers====
./runsim.sh

If you have permission issues
chmod 755 runsim.sh

To see a list of the servers in screen:
screen -ls or screen -list

Output will look like the following:
There are screens on:
8419.OpenSim (Detached)
8403.InventoryServer (Detached)
8378.AssetServer (Detached)
8360.GridServer (Detached)
8347.UserServer (Detached)

To access server
screen -r 8419.OpenSim
screen -r 8403.InventoryServer
etc.

To exit screen, leaving server running, and to return to shell
ctrl-a d

====Shutdown Servers====
Either manually access each sceen
screen -r 8419.OpenSim
shutdown

Or use
killall mono
Or
for i in `ps afxu | grep -i "mono.*OpenSim" | grep -v grep | awk {'print $2'}`; do kill $i; done

Need to see if there is a way to use a shell script using screen to shutdown servers

FAQ

2008-01-01T15:45:34Z

Tedd: /* Exceptions on the Console */

A list of frequently asked questions. Please add anything you think is reasonable here.

= What is OpenSim? =

OpenSim is a platform for operating a virtual world, and supports multiple independent regions connecting to a single centralized grid. This is somewhat similar to the web, where anyone can run their own web server, tied together through the internet. It can also be used to create a private grid, analogous to a private intranet.

=== What is a region? ===

A region is what you see when you log into OpenSim. It is the physical place (well, virtually physical) where avatars move and interact. It is a square patch of land which may contain an island, mountains, a plain, buildings, etc., or just an ocean.

=== What is the grid? ===

The grid is the level that organizes the regions and their positions in the world, and handles things that need to exist across regions, such as a user's inventory. You can think of it as similar to the world map.

=== What does ... mean? ===

See [[OpenSim:TechRef]] for definitions of some terms commonly used in OpenSim.

= Building OpenSim =

=== I can't find any build files or solution files ===

* If you're on Windows, run <tt>runprebuild.bat</tt> - on Linux/Mac/FreeBSD, run <tt>runprebuild.sh</tt>

=== VS2005 won't open the .sln file ===

* Try running VS2005 C#. You are probably running VS2005 C++. This is a C# project.

= Running OpenSim =

=== Running OpenSim.exe from a Cygwin shell has access denied for some dll's ===

* Do a '<tt>cd bin</tt>' followed by '<tt>chmod a+x *</tt>' to make all dll files executable.

=== I cannot start my sim ===

* See [[OpenSim: Running]].

= Configuring OpenSim =

First, read [[OpenSim: Configuration]].

=== Where can I get a new UUID for my sim config? ===

Use '<tt>uuidgen</tt>' or generate one on the [http://www.famkruithof.net/uuid/uuidgen uuidgen webpage].

=== Can I run multiple regions with OpenSim? ===

Yes. To do this add another xml file to <tt>bin/Regions</tt>. You need to create a new 'sim_UUID' (see above) and change the 'sim_name', 'internal_ip_port', 'sim_location_x' and 'sim_location_y' (and anything else you wish to change). The script <tt>share/regions/make.php</tt> may be useful for generating region files automatically. Once the new region files have been added to <tt>bin/Regions</tt>, restart OpenSim.

Note that <tt>sim_location_x</tt> and <tt>sim_location_y</tt> should be in adjacent regions, so you will be able to run back and forth between regions.

* See [[OpenSim: Configuration]].

=== How do I enable prim storage? ===

* In the <tt>OpenSim.ini</tt> file, change the <tt>storage_plugin</tt> entry to
storage_plugin = OpenSim.DataStore.MonoSqlite.dll
or
storage_plugin = OpenSim.Framework.Data.MySQL.dll

You will also need to provide connection details in a <tt>storage_connection_string</tt> attribute - see the <tt>OpenSim.ini.example</tt> file in the bin directory of the OpenSim package for more information.

=== There are a bunch of textures in the library, but they are all 0x0? What's wrong? ===
To enable these extra textures for your use, you must delete your <tt>regionassets.yap</tt> file, and restart your sim. WARNING: IF YOU DO THIS, YOU WILL LOSE ANY ASSETS (textures, scripts, animations, etc) THAT YOU HAVE UPLOADED!

=== What databases can be used with OpenSim? ===
For running in standalone mode, OpenSim provides database plugins for both sqlite and MySQL. There is also an MSSQL plugin, though this has not been thoroughly tested. Sqlite requires no user configuration to set up while MySQL requires some minimal user configuration (see [[mysql-config]]).

Running in grid mode is usually done using the MySQL database. Sqlite and MSSQL may work but have not been thoroughly tested.

=== Can I export all my prims, for safe keeping? ===

Yes. From the console type
save_xml yourbackupfile

You can later load those prims with
load_xml yourbackupfile

This is also a good way to dump and clone prims from one OpenSim server to another.

= Something Has Gone Wrong! =

=== I get a timeout during region handshake ===

* Do you have the correct IP in your Regions\* config files?
* Do you have multiple interfaces on the server running OpenSim? OpenSim will not bind outgoing UDP packets to a specific IP, its default IP to reach you will be what the Region answers UDP with. If you have configured the region for another IP you will get a timeout during connect.

=== I cannot connect to my OpenSim ===

* See [[OpenSim: Connecting]].

=== I can connect but cannot move ===

If the client connects but the avatar can only spin in place and not move, then the sim is not correctly configured. It completed the initial login function, but packets are not being exchanged between the client and the sim, probably due to a network configuration error on the sim.

* See [[OpenSim: Configuration]].

=== From time to time my Avatar seems to get stuck ===
Right now there is a bottle neck when syncing prims off to the database. This will cause small (5 - 10 second) apparent hangs of the Avatar, but it will recover fine once the data is synced. It is a known issue based on legacy architecture of some of the data storage code. We hope this will be removed soon.

=== I have problems with viewing the worldmap ===

* This may happen when running OpenSim on a Linux server, both in grid or standalone mode.
* Symptoms: when opening the worldmap window in the SL-viewer, the sims are not displayed grahically in the worldmap, the server console shows some error related to openjpeg, the current session freezes...
* Reason: your svn source trunk does not have the correct (or whatever...) <tt>libopenjpeg-libsl</tt> library.
* Solution: get the newest code from libsecondlife (<tt>svn co svn://opensecondlife.org/libsl/trunk</tt>), '<tt>make</tt>' manually in the subdir <tt>openjpeg-libsl</tt>, and copy the resulting <tt>libopenjpeg-libsl-2.1.2.0.so</tt> into your OpenSim <tt>bin</tt> subdir, overwriting the existing one.
* Recompile & restart OpenSim.

= Exceptions on the Console =
This is a list of Exceptions that you may see on the console, what they mean, and if they are a problem.

=== System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so ===
Failed generating terrain map: System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so
at (wrapper managed-to-native) OpenJPEGNet.OpenJPEG:LibslAllocDecoded OpenJPEGNet.OpenJPEG/LibslImage&)
at OpenJPEGNet.OpenJPEG.Encode (System.Byte[] decoded, Int32 width, Int32 height, Int32 components, Boolean lossless) [0x00000]
at OpenJPEGNet.OpenJPEG.EncodeFromImage (System.Drawing.Bitmap bitmap, Boolean lossless) [0x00000]
at OpenSim.Region.Terrain.TerrainEngine.ExportJpegImage (System.String gradientmap) [0x00000]

You are on Linux, and the native lib libopenjpeg-libsl-2.1.2.0.so is not compatible with your system for one of the following reasons:
* You have an old processor (libopenjpeg has been compiled with optimizations)
* You are running in 64bit mode (none of the native libs are built for 64bit)

You can rebuild your own libopenjpeg from source, or run in a compatible environment.
You can do this by:
svn co svn://opensecondlife.org/libsl/trunk libsl
cd libsl/openjpeg-libsl/
make

then copy libopenjpeg-libsl-2.1.2.0.so into OpenSim bin-folder.

= OpenSim in the Wild =

=== Are there test servers running OpenSim I can connect to? ===

Yes. Check out http://www.deepgrid.com, http://osgrid.org

There are also often many private servers up for testing. Hang out on the IRC channel (Freenode #opensim), and troll for URI's.

=== Can I teleport from the Linden Lab Second Life grid to my Sim? ===

No, OpenSim islands cannot connect to the Linden Lab grid.

= Terrain Tidbits =
=== What programs can I use to create terrains for OpenSim? ===
If you are after simple terrain files (jpg, gif, etc), you can use Photoshop or any number of freeware programs, like [http://www.gimp.org/ Gimp]. If you want more complex terrains, you will need programs that output to standard 3d raw format (aka r32 or r64). [http://www.bundysoft.com/L3DT/ L3DT] and [http://www.planetside.co.uk/terragen/ Terragen] are two of the top commercial programs for this. (anyone know of a freeware one?), or you could, with some practice, use [http://www.blender.org/ Blender]. The free version of L3DT can make terrains up to 2048x2048 in size, or 8x8 regions.

=== Where do I put the files for my terrains? ===
This one is actually pretty simple, but first the 'hard' answer: anywhere in the PATH will work. Lost? yeah, I was too, so... just drop the file into the <tt>bin</tt> directory (right where your <tt>OpenSim.exe</tt> file is).

=== How do I change the terrain for a group of sims? ===
First, the file must be in f32 (or f64?) format. This is easy to do with L3DT's export feature. (Use the RAW format and set the options to <tt>Y flipped = true</tt> and at the bottom, change it to read 'float' instead of 'ushort'). It also needs to be a file that will cover each sim in a 256x256 layer (so, for 2x2 regions, you need a 512x512 file).

Then, once you have it saved, on the <tt>OpenSim.exe</tt> console, type in:

terrain load-tile f32 <filename> <image X> <image y> <bottomleftsim X> <bottomleftsim y>

For example, I run a square of 4 sims in a 2x2 pattern. I started my sim placement at 0, 0 and ended at 1, 1. my line reads:

terrain load-tile f32 simalpha.raw 512 512 0 0

Next, before you log in, you may want to go to type in:

terrain multiply 0.4

This should scale it down from the nearly 300 meters altitude I ran into to something a little more reasonable for the minimap.

=== How do I load a terrain file on startup? ===
Edit the file <tt>startup_commands.txt</tt> in the bin directory and add the above commands "<tt>terrain load-tile ...</tt>" and "<tt>terrain multiply ...</tt>" one per line.

Terrain Tidbits brought to you by Tilde, with a few questions in IRC :) - [[User:Tildeampersand|Tilde]] 10:32, 15 August 2007 (PDT)

=== How do I import into OpenSim the terrain shape of my Second Life sim? ===

Use the command

terrain load

Watch [http://archimedix.wordpress.com/2007/11/26/opensim/ this video] for a step-by-step tutorial.

= In World Questions =

=== Does in world scripting work yet? ===

Not fully implemented, but there is a lot of work going on here. Please see [[LSL Status]] for the latest info.

=== Why do I walk through objects? ===

Basicphysics doesn't support collisions between objects (just between you and the ground). There is active work on other physics engines for OpenSim, but these are quite experimental at this point, so not considered supported.

=== Can I customize my avatar? ===

Yes. In order to do this:
* Click the Inventory Button
* Create -> New Clothes -> Shirt, Pants, etc
* Create -> New Body Parts -> Hair, Shape, etc
* Edit those from your inventory
* Wear them

Your avatar doesn't always face a nice direction for doing this, so you'll need to use the camera operations to see your face for some of the modifications. This is a known issue, will be fixed in the future.

Also, you'll need to rewear you parts once you first join the environment. Right now default appearance is always "Ruth".

= Grid Mode =
Note: Grid Mode isn't officially supported yet. As such, you are pretty much on your own if you are trying to get OpenSim up and running in Grid Mode.

=== I start the sim and it doesn't connect to any grid ===

When OpenSim is first started, it needs configuration.

* See [[OpenSim: Configuration]].

=== I start the OpenSim.Grid.UserServer.exe and it gives an error ===

If this error is access denied for <tt>username@localhost</tt>, the mysql database is not set up.

It will print some text and wait for input - either an enter to accept a default value, or another value you can supply.

* See [[OpenSim: Configuration]].

=== I want to run my own Local Grid but one or more servers fail to start ===

* Be sure that you're able to start <tt>OpenSim.exe</tt> alone, in Standalone mode, and to be able to login.
* Start the servers in the correct UGAS order and answer the questions as recommended (see [[OpenSim: Configuration]]).
* Set all the external URI's to the correct IP: 127.0.0.1 if running on your local machine, or aaa.bbb.ccc.ddd if running on a remote server.
* Check again all the <tt>*.xml</tt> configuration files for any wrong settings or typing errors...!
* Don't forget to connect with your SL-viewer to port 8002 (Grid User-Server) instead of 9000 (Standalone OpenSim-Server).
* Delete all <tt>*.xml</tt> and <tt>*.yap</tt> files in the <tt>bin</tt> directory if you want to run a full reconfiguration again.

=== After the shiny new grid is running, what is next? ===
* Make sure one can stop/restart UGA &S (sims). Check out any ordering issues of stop/restart UGA w/o stop/restart sim(s).
* Make sure one can add/delete both a region and a user from the database.
* Make sure it runs overnight and check it each morning by logging into 1 or 2 key sims.
* '<tt>tail -f userserver.log</tt>' and watch/understand the login process.
* Make sure when you logoff your system, you can log back on and get control of the UGAS consoles.

= How to ask for help =

=== Before asking for help... ===

* Search the wiki and web before asking for help.
* Check your configuration files for any obvious defects.
* Check that you're starting up the processes correctly.
* See [[OpenSim: Install]].
* See [[OpenSim: Configuration]].
* See [[OpenSim: Running]].
* See [[OpenSim: Connecting]].

=== Asking in IRC ===

IRC channels are <tt>#opensim</tt> and <tt>#opensim-dev</tt> on Freenode. Approach them in that order :) Please be courteous and remember that the developers and anyone else assisting you are volunteers there.

* Don't ask to ask, just ask.
* Phrase your question in the form of a question.
* Be specific.
* Explain the problem.
* Describe how to reproduce the problem.
* If you need to paste configuration files or error messages, please paste to [http://pastebin.ca/ pastebin] then send the link in the IRC channel.

=== After you get help ===

* If no-one can help you, please submit a bug.
* If someone does help you, please document the problem and fix on the wiki on this page.

Development Team

2007-10-11T15:55:58Z

Tedd: /* OpenSim Core Developers */

== OpenSim Core Developers ==

(please add in as much info as you like for your name)

<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>IRC Nick </th>
<th>Name</th>
<th>SL Avatar</th>
<th>Time Zone (UTC)</th>
<th>Org</th>
<th>Areas of Interest</th>
</tr>
<tr>
<td>[[User:MW|MW]]</td>
<td>Michael Wright</td>
<td>Wright Juran</td>
<td>+0</td>
<td> </td>
<td>everything</td>
</tr>
<tr>
<td>[[User:AdamZaius|AdamZaius]]</td>
<td>Adam Frisby</td>
<td>Adam Zaius</td>
<td>+8</td>
<td>DeepThink Pty Ltd</td>
<td>Terrain, Performance</td>
</tr>
<tr>
<td>[[User:MingChen|MingChen]]</td>
<td> </td>
<td> </td>
<td>-6</td>
<td>DeepThink Pty Ltd</td>
<td> </td>
</tr>
<tr>
<td>[[User:lbsa71|lbsa71]]</td>
<td>Stefan Andersson</td>
<td>PierreJoseph Proudhon</td>
<td>+1</td>
<td>Tribal Media AB</td>
<td> 3D and Web Integration</td>
</tr>
<tr>
<td>[[User:SeanDague|sdague]]</td>
<td>Sean Dague</td>
<td>Neas Bade</td>
<td>-5</td>
<td>IBM</td>
<td>Database, Linux</td>
</tr>
<tr>
<td>[[User:babblefrog|babblefrog]]</td>
<td>Brian McBee</td>
<td>Dogen Coldstream</td>
<td>-8</td>
<td>Disorganized</td>
<td> </td>
</tr>
<tr>
<td>[[User:Tedd|Tedd]]</td>
<td>Tedd Hansen</td>
<td>Tedd Maa</td>
<td>+1</td>
<td>Tedd Hansen</td>
<td>Programming/Scripting/Architecture</td>
</tr>
<tr>
<td>[[User:danx0r|danx0r]]</td>
<td>Dan Miller</td>
<td>Albert Pascal</td>
<td>-8</td>
<td>squiggle.com</td>
<td>PHEEZIKS; everything</td>
</tr>
<tr>
<td>[[User:dalien|dalien]]</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>ZeroPoint</td>
<td> </td>
<td>Guilderoy Dench</td>
<td>-5</td>
<td> </td>
<td>Programming/Database</td>
</tr>
<tr>
<td>Tleiades</td>
<td> </td>
<td>Tleiades Hax</td>
<td>+2</td>
<td> </td>
<td>Grid servers/Database</td>
</tr>
<tr>
<td>cfk</td>
<td>Charles Krinke</td>
<td>Charlesk Bing</td>
<td>-8</td>
<td> </td>
<td>Reliability/Grid servers/ll-functions</td>
</tr>
</table>

== Additional Developers/Testers/Contributors ==

<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>IRC Nick </th>
<th>Name</th>
<th>SL Avatar</th>
<th>Time Zone (UTC)</th>
<th>Org</th>
<th>Areas of Interest</th>
</tr>
<tr>
<td>Gareth</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>BigFootAg</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>[[User:Darok|Darok]]</td>
<td> </td>
<td>Darok Kaminski</td>
<td>+1</td>
<td> </td>
<td>Physics engines (especially BulletX)</td>
</tr>
<tr>
<td>Ldvoipeng</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>idoru</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>[[User:Magi|Magi]]</td>
<td>Andy Agnew</td>
<td>Magi Merlin</td>
<td>+10</td>
<td>Spun Pty Ltd</td>
<td>3D Web Integration, Database stuff and playing with the odds and ends box.</td>
</tr>
<tr>
<td>john_</td>
<td>John Moyer</td>
<td>VAJohn GeekSquad or Matthew Kendal</td>
<td>-5</td>
<td>Best Buy/Geek Squad</td>
<td> </td>
</tr>
<tr>
<td>[[User:ClarkZone|ClarkZone]]</td>
<td>Troy Admin(@ClarkZone)</td>
<td>Troy Childs(Secondlife)\Troy Admin (ClarkZone)</td>
<td>-5</td>
<td>Http://clarkzone.dyndns.org</td>
<td>Tester and Grid Host</td>
</tr>
<tr>
<td>[[User:aiaustin|aiaustin]]</td>
<td>Ai Austin</td>
<td>Ai Austin (Second Life) Ai Beta (DeepGrid)</td>
<td>+0</td>
<td>AIAI, University of Edinburgh http://www.aiai.ed.ac.uk/~ai/</td>
<td>Windows Vista tests</td>
</tr>
<tr>
<td>[[User:balthazar|balthazar]]</td>
<td>Trevor Brooks</td>
<td>Balthazar Sin</td>
<td>-5</td>
<td>None</td>
<td>Terrains, testing and some small coding tasks</td>
</tr>
<tr>
<td>[[User:jimbo2120|jimbo2120]]</td>
<td>Michael Osias</td>
<td>Illuminous Beltran</td>
<td>-5</td>
<td>IBM</td>
<td>Grid, AI, Skynet, coding and testing</td>
</tr>
<tr>
<td>[[User:chi11ken|chi11ken]]</td>
<td>Jeff Ames</td>
<td>Chillken Proto</td>
<td>+9</td>
<td> </td>
<td> </td>
</tr>
</table>

Development Team

2007-10-11T15:54:48Z

Tedd: /* OpenSim Core Developers */

== OpenSim Core Developers ==

(please add in as much info as you like for your name)

<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>IRC Nick </th>
<th>Name</th>
<th>SL Avatar</th>
<th>Time Zone (UTC)</th>
<th>Org</th>
<th>Areas of Interest</th>
</tr>
<tr>
<td>[[User:MW|MW]]</td>
<td>Michael Wright</td>
<td>Wright Juran</td>
<td>+0</td>
<td> </td>
<td>everything</td>
</tr>
<tr>
<td>[[User:AdamZaius|AdamZaius]]</td>
<td>Adam Frisby</td>
<td>Adam Zaius</td>
<td>+8</td>
<td>DeepThink Pty Ltd</td>
<td>Terrain, Performance</td>
</tr>
<tr>
<td>[[User:MingChen|MingChen]]</td>
<td> </td>
<td> </td>
<td>-6</td>
<td>DeepThink Pty Ltd</td>
<td> </td>
</tr>
<tr>
<td>[[User:lbsa71|lbsa71]]</td>
<td>Stefan Andersson</td>
<td>PierreJoseph Proudhon</td>
<td>+1</td>
<td>Tribal Media AB</td>
<td> 3D and Web Integration</td>
</tr>
<tr>
<td>[[User:SeanDague|sdague]]</td>
<td>Sean Dague</td>
<td>Neas Bade</td>
<td>-5</td>
<td>IBM</td>
<td>Database, Linux</td>
</tr>
<tr>
<td>[[User:babblefrog|babblefrog]]</td>
<td>Brian McBee</td>
<td>Dogen Coldstream</td>
<td>-8</td>
<td>Disorganized</td>
<td> </td>
</tr>
<tr>
<td>[[User:Tedd|Tedd]]</td>
<td>Tedd Hansen</td>
<td>Tedd Maa</td>
<td>-9</td>
<td>Tedd Hansen</td>
<td>Programming/Scripting/Architecture</td>
</tr>
<tr>
<td>[[User:danx0r|danx0r]]</td>
<td>Dan Miller</td>
<td>Albert Pascal</td>
<td>-8</td>
<td>squiggle.com</td>
<td>PHEEZIKS; everything</td>
</tr>
<tr>
<td>[[User:dalien|dalien]]</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>ZeroPoint</td>
<td> </td>
<td>Guilderoy Dench</td>
<td>-5</td>
<td> </td>
<td>Programming/Database</td>
</tr>
<tr>
<td>Tleiades</td>
<td> </td>
<td>Tleiades Hax</td>
<td>+2</td>
<td> </td>
<td>Grid servers/Database</td>
</tr>
<tr>
<td>cfk</td>
<td>Charles Krinke</td>
<td>Charlesk Bing</td>
<td>-8</td>
<td> </td>
<td>Reliability/Grid servers/ll-functions</td>
</tr>
</table>

== Additional Developers/Testers/Contributors ==

<table border="1" cellpadding="2" cellspacing="0">
<tr>
<th>IRC Nick </th>
<th>Name</th>
<th>SL Avatar</th>
<th>Time Zone (UTC)</th>
<th>Org</th>
<th>Areas of Interest</th>
</tr>
<tr>
<td>Gareth</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>BigFootAg</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>[[User:Darok|Darok]]</td>
<td> </td>
<td>Darok Kaminski</td>
<td>+1</td>
<td> </td>
<td>Physics engines (especially BulletX)</td>
</tr>
<tr>
<td>Ldvoipeng</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>idoru</td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
<td> </td>
</tr>
<tr>
<td>[[User:Magi|Magi]]</td>
<td>Andy Agnew</td>
<td>Magi Merlin</td>
<td>+10</td>
<td>Spun Pty Ltd</td>
<td>3D Web Integration, Database stuff and playing with the odds and ends box.</td>
</tr>
<tr>
<td>john_</td>
<td>John Moyer</td>
<td>VAJohn GeekSquad or Matthew Kendal</td>
<td>-5</td>
<td>Best Buy/Geek Squad</td>
<td> </td>
</tr>
<tr>
<td>[[User:ClarkZone|ClarkZone]]</td>
<td>Troy Admin(@ClarkZone)</td>
<td>Troy Childs(Secondlife)\Troy Admin (ClarkZone)</td>
<td>-5</td>
<td>Http://clarkzone.dyndns.org</td>
<td>Tester and Grid Host</td>
</tr>
<tr>
<td>[[User:aiaustin|aiaustin]]</td>
<td>Ai Austin</td>
<td>Ai Austin (Second Life) Ai Beta (DeepGrid)</td>
<td>+0</td>
<td>AIAI, University of Edinburgh http://www.aiai.ed.ac.uk/~ai/</td>
<td>Windows Vista tests</td>
</tr>
<tr>
<td>[[User:balthazar|balthazar]]</td>
<td>Trevor Brooks</td>
<td>Balthazar Sin</td>
<td>-5</td>
<td>None</td>
<td>Terrains, testing and some small coding tasks</td>
</tr>
<tr>
<td>[[User:jimbo2120|jimbo2120]]</td>
<td>Michael Osias</td>
<td>Illuminous Beltran</td>
<td>-5</td>
<td>IBM</td>
<td>Grid, AI, Skynet, coding and testing</td>
</tr>
<tr>
<td>[[User:chi11ken|chi11ken]]</td>
<td>Jeff Ames</td>
<td>Chillken Proto</td>
<td>+9</td>
<td> </td>
<td> </td>
</tr>
</table>

Configuration

2007-09-11T11:54:03Z

Tedd: /* Tips */

It is recommended that you first get OpenSim running in standalone mode, before you attempt to connect it to a grid, either your own grid or a public grid.

A simulator actually consists of four services, known as UGAS which stand for User, Grid, Asset & Simulator. They are started in that order.

A simulator running in its default standalone mode has all the services self-contained, but they are very modest. This means any first/last/password works. It also means inventory is all local with no region or grid-wide connections.

A simulator running as a local grid runs all four services on the same computer. Multiple sims can be run, across-region crossing including teleporting and a set of inventory items that are within this local grid.

A simulator running as part of a public grid runs only OpenSim.exe and the other three services are running on a server common to many regions. This also means that understanding the needed UUID, X,Y location, server handshake passwords, master avatar first/last/password and a couple of other settings. These are not difficult, but do require a little care in setting up.

=Command Line arguments passed to OpenSim.exe=

OpenSim.exe responds to various command line arguments. These include "-inifile", "-configfile", "-gridmode", "-physics", "-config" & "-noverbose".

When starting OpenSim in either Windows or Linux, one can add "-physics=OpenDynamicsEngine" to run the OpenDynamicsEngine instead of basicphysics.

Most users in standalone mode will not add any command line arguments. For local grid or public grid, the "-gridmode=true" is usually the only argument used. The rest are for more advanced configuration.

=Standalone mode=

When you start OpenSim in standalone mode, it will ask you several question at the console. The first set of prompts that start with "NETWORK SERVERS INFO", you can just hit return to accept the defaults if you will be running in standalone mode.

The prompts that start with "DEFAULT REGION CONFIG" are where you need to start paying attention. Some are self-explanatory. Here are explanations for the others:

* Grid Location. OpenSim regions can be placed anywhere on a 65536 by 65536 grid. In standalone mode, it is safe to leave these X and Y locations at their defaults.

* Filename for local storage. Safe to leave at default.

* Internal IP address; This should always be 0.0.0.0

* Internal IP port for incoming UDP client connection. You can make this any port you want, but it is safe to leave at the default 9000.

* External host name. If you will only be attaching to your sim from a SecondLife client on the same machine, you can leave this at the default 127.0.0.1. If you will be wanting to connect to it from a client on another machine, this should be the IP address or hostname of the machine you are running this sim on.

To connect to your new sim, start up secondlife with the following command line switches:

-loginuri http://127.0.0.1:9000/

This assumes you are running the secondlife client on the same box. If you are running it on a separate box, substitute the IP address of your sim machine.

=Grid mode=

You want to run your own grid. Great! Assuming that you already got your sim running in standalone mode, here is what you need to do:

1. Current builds of OpenSim grid mode are using mysql to store the grid information. You must have this installed and configured if you want to run your own grid. See [[mysql-config]] for more information.

2. The servers should be started in a certain order. UGAS: UserServer, GridServer, AssetServer, Sim. These are all found in the bin directory. In windows, you can just double-click on the executables to start them. In linux, you will probably have to start them with mono. The executable names are:

OpenSim.Grid.UserServer.exe
OpenSim.Grid.GridServer.exe
OpenSim.Grid.AssetServer.exe
OpenSim.exe

3. Start the UserServer. If you will be running the GridServer on the same box, hit enter to accept the defaults, until it gives you the prompt

OpenUser#

This is the main prompt for the user server. If you will be running the GridServer on another box, change the Default Grid Server URI as appropriate.

4. Start the GridServer. Again, you can hit return at all the prompts if you are running them all on the same machine. If not, change the URIs for the Asset Server and User server to point to where you are running them. You will finally get to the console prompt for the GridServer which looks like this:

OpenGrid#

5. Start the AssetServer. This is not used at the current time, so you don't need to start it. The console prompt for this server will be:

OpenAsset#

6. If you are running all of these servers on the same box, which would be the normal configuration. You should be ready to start up your sim. Since the OpenSim.exe starts up by default in standalone mode, you will need to give it a command line switch to tell it to use gridmode instead:

OpenSim.exe -gridmode=true

or

mono OpenSim.exe -gridmode=true

With any luck, everything will come up without too many arrors.

7. Go to the UserServer console, and type 'create user' to create a new avatar. It will prompt you for the name and password, and the X and Y of the sim that should be his home location. Use 1000 and 1000, or wherever you told your sim to live when you brought it up in standalone mode.

At the console of any of these servers, you should be able to type 'help' to get a list of commands.

You should now be able to connect to your new grid with your secondlife client. You need to tell your client to point at the UserServer rather than direclty at the sim, though:

secondlife -loginuri http://127.0.0.1:8002/

8002 is the default port for the UserServer, and that IP address should be changed to the server you are running the UserServer on, if they are not all on the same box.

Happy OpenSimming!

=== Technical Addendum ===
For running multiple regions on the same box, you simply make multiple copies of the 'default.xml' file inside the /bin/regions/ directory. Name them anything you want (I name mine x.y.xml, where x znd y are the grid coords)

Open each xml file and edit the uuid (each must be unique, a generator is listed in this wiki, remove the dashes), region name, x & y positions, datastore (if you are using the prim thing) and internal ip port. EACH OF THESE MUST BE UNIQUE!

Once you have 2 or more xml files in the regions folder, you can run a SINGLE COPY of opensim.exe and it will boot all of your sims! If you come across any errors, there is, most likely, an error in the xml files.

=Attaching your sim to someone else's grid=

** [[OpenSim: SampleConfigs]] (Yin, Bao & Yang config files as samples)

In your bin directory, you will find a file called

network_servers_information.xml

This file has the configuration for telling your sim how to attach to a grid. You can edit this file with any text editor.

The grid owner should provide you with the following information to configure this file so that you can attach to their grid:

* GridServerURL

* GridSendKey

* GridRecvKey

* UserServerURL

* UserSendKey

* UserRecvKey

* AssetServerURL

The keys are used to make sure that you can both know that you are connecting to the correct box at the other end. This offers a level of security.

The other file you may have to change is in your bin/Regions directory. This is where your individual region config files are. If you only have one region, it will by default be called:

default.xml

This can be edited with any text editor. The grid owner may tell you what X and Y location you can place your sim at (you can't have multiple sims at the smae location on the grid). If so, the fields you will need to change in this file are sim_location_x, and sim_location_y.

A list of public grids that you can attach your sim to are at [[OpenSim:_Grids]]

=Tips=
In Windows, to automate startup, you can create a file called StartGrid.BAT:
start OpenSim.Grid.UserServer.exe
sleep 3
start OpenSim.Grid.GridServer.exe
sleep 3
start OpenSim.Grid.AssetServer.exe
sleep 3
start OpenSim.exe -gridmode=true

PS! Check that you have sleep command installed, I'm unsure if all Windows-versions has that. 
This knowledgebase article describes how to add a batch file to startup of Windows (before logon). 
[http://support.microsoft.com/kb/q243486/ http://support.microsoft.com/kb/q243486/] 
Note that you have to start all applications and answer the configuration questions once before adding it to any startup. 
 
If you start the server before logon then there will be no window to close if you want to shut down the server, so you can create a "StopGrid.BAT" with:
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /F /FI "IMAGENAME eq OpenSim.*"

''Do they have to be shut down in any particular order?''

Configuration

2007-09-11T11:52:08Z

Tedd:

It is recommended that you first get OpenSim running in standalone mode, before you attempt to connect it to a grid, either your own grid or a public grid.

A simulator actually consists of four services, known as UGAS which stand for User, Grid, Asset & Simulator. They are started in that order.

A simulator running in its default standalone mode has all the services self-contained, but they are very modest. This means any first/last/password works. It also means inventory is all local with no region or grid-wide connections.

A simulator running as a local grid runs all four services on the same computer. Multiple sims can be run, across-region crossing including teleporting and a set of inventory items that are within this local grid.

A simulator running as part of a public grid runs only OpenSim.exe and the other three services are running on a server common to many regions. This also means that understanding the needed UUID, X,Y location, server handshake passwords, master avatar first/last/password and a couple of other settings. These are not difficult, but do require a little care in setting up.

=Command Line arguments passed to OpenSim.exe=

OpenSim.exe responds to various command line arguments. These include "-inifile", "-configfile", "-gridmode", "-physics", "-config" & "-noverbose".

When starting OpenSim in either Windows or Linux, one can add "-physics=OpenDynamicsEngine" to run the OpenDynamicsEngine instead of basicphysics.

Most users in standalone mode will not add any command line arguments. For local grid or public grid, the "-gridmode=true" is usually the only argument used. The rest are for more advanced configuration.

=Standalone mode=

When you start OpenSim in standalone mode, it will ask you several question at the console. The first set of prompts that start with "NETWORK SERVERS INFO", you can just hit return to accept the defaults if you will be running in standalone mode.

The prompts that start with "DEFAULT REGION CONFIG" are where you need to start paying attention. Some are self-explanatory. Here are explanations for the others:

* Grid Location. OpenSim regions can be placed anywhere on a 65536 by 65536 grid. In standalone mode, it is safe to leave these X and Y locations at their defaults.

* Filename for local storage. Safe to leave at default.

* Internal IP address; This should always be 0.0.0.0

* Internal IP port for incoming UDP client connection. You can make this any port you want, but it is safe to leave at the default 9000.

* External host name. If you will only be attaching to your sim from a SecondLife client on the same machine, you can leave this at the default 127.0.0.1. If you will be wanting to connect to it from a client on another machine, this should be the IP address or hostname of the machine you are running this sim on.

To connect to your new sim, start up secondlife with the following command line switches:

-loginuri http://127.0.0.1:9000/

This assumes you are running the secondlife client on the same box. If you are running it on a separate box, substitute the IP address of your sim machine.

=Grid mode=

You want to run your own grid. Great! Assuming that you already got your sim running in standalone mode, here is what you need to do:

1. Current builds of OpenSim grid mode are using mysql to store the grid information. You must have this installed and configured if you want to run your own grid. See [[mysql-config]] for more information.

2. The servers should be started in a certain order. UGAS: UserServer, GridServer, AssetServer, Sim. These are all found in the bin directory. In windows, you can just double-click on the executables to start them. In linux, you will probably have to start them with mono. The executable names are:

OpenSim.Grid.UserServer.exe
OpenSim.Grid.GridServer.exe
OpenSim.Grid.AssetServer.exe
OpenSim.exe

3. Start the UserServer. If you will be running the GridServer on the same box, hit enter to accept the defaults, until it gives you the prompt

OpenUser#

This is the main prompt for the user server. If you will be running the GridServer on another box, change the Default Grid Server URI as appropriate.

4. Start the GridServer. Again, you can hit return at all the prompts if you are running them all on the same machine. If not, change the URIs for the Asset Server and User server to point to where you are running them. You will finally get to the console prompt for the GridServer which looks like this:

OpenGrid#

5. Start the AssetServer. This is not used at the current time, so you don't need to start it. The console prompt for this server will be:

OpenAsset#

6. If you are running all of these servers on the same box, which would be the normal configuration. You should be ready to start up your sim. Since the OpenSim.exe starts up by default in standalone mode, you will need to give it a command line switch to tell it to use gridmode instead:

OpenSim.exe -gridmode=true

or

mono OpenSim.exe -gridmode=true

With any luck, everything will come up without too many arrors.

7. Go to the UserServer console, and type 'create user' to create a new avatar. It will prompt you for the name and password, and the X and Y of the sim that should be his home location. Use 1000 and 1000, or wherever you told your sim to live when you brought it up in standalone mode.

At the console of any of these servers, you should be able to type 'help' to get a list of commands.

You should now be able to connect to your new grid with your secondlife client. You need to tell your client to point at the UserServer rather than direclty at the sim, though:

secondlife -loginuri http://127.0.0.1:8002/

8002 is the default port for the UserServer, and that IP address should be changed to the server you are running the UserServer on, if they are not all on the same box.

Happy OpenSimming!

=== Technical Addendum ===
For running multiple regions on the same box, you simply make multiple copies of the 'default.xml' file inside the /bin/regions/ directory. Name them anything you want (I name mine x.y.xml, where x znd y are the grid coords)

Open each xml file and edit the uuid (each must be unique, a generator is listed in this wiki, remove the dashes), region name, x & y positions, datastore (if you are using the prim thing) and internal ip port. EACH OF THESE MUST BE UNIQUE!

Once you have 2 or more xml files in the regions folder, you can run a SINGLE COPY of opensim.exe and it will boot all of your sims! If you come across any errors, there is, most likely, an error in the xml files.

=Attaching your sim to someone else's grid=

** [[OpenSim: SampleConfigs]] (Yin, Bao & Yang config files as samples)

In your bin directory, you will find a file called

network_servers_information.xml

This file has the configuration for telling your sim how to attach to a grid. You can edit this file with any text editor.

The grid owner should provide you with the following information to configure this file so that you can attach to their grid:

* GridServerURL

* GridSendKey

* GridRecvKey

* UserServerURL

* UserSendKey

* UserRecvKey

* AssetServerURL

The keys are used to make sure that you can both know that you are connecting to the correct box at the other end. This offers a level of security.

The other file you may have to change is in your bin/Regions directory. This is where your individual region config files are. If you only have one region, it will by default be called:

default.xml

This can be edited with any text editor. The grid owner may tell you what X and Y location you can place your sim at (you can't have multiple sims at the smae location on the grid). If so, the fields you will need to change in this file are sim_location_x, and sim_location_y.

A list of public grids that you can attach your sim to are at [[OpenSim:_Grids]]

=Tips=
In Windows, to automate startup, you can create a file called StartGrid.BAT:
start OpenSim.Grid.UserServer.exe
sleep 3
start OpenSim.Grid.GridServer.exe
sleep 3
start OpenSim.Grid.AssetServer.exe
sleep 3
start OpenSim.exe -gridmode=true

PS! Check that you have sleep command installed, I'm unsure if all Windows-versions has that. 
This technet article describes how to add a batch file to startup of Windows (before logon). 
[http://support.microsoft.com/kb/q243486/ http://support.microsoft.com/kb/q243486/] 
Note that you have to start all applications and answer the configuration questions once before adding it to any startup. 
 
If you start the server before logon then there will be no window to close if you want to shut down the server, so you can create a "StopGrid.BAT" with:
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /FI "IMAGENAME eq OpenSim.*"
sleep 3
taskkill /F /FI "IMAGENAME eq OpenSim.*"

''Do they have to be shut down in any particular order?''

FAQ

2007-08-30T18:12:58Z

Tedd: /* Something Has Gone Wrong! */

A list of frequently asked questions. Please add anything you think is reasonable here.
= Building OpenSim =

=== I can't find any build files or solution files ===

* If you're on windows, run prebuild.bat - on linux prebuild.sh

=== VS2005 wont open the .sln file ===

* Try running the VS2005 C#. You are probably running VS2005 C++. This is a C# project.

= Running OpenSim =

=== Running OpenSim.exe from a Cygwin shell has access denied for some dll's ===

* Do a 'cd bin' followed by 'chmod a+x *' to make all dll files executable.

=== I cannot start my sim ===

* See [[OpenSim: Running]].

= Configuring OpenSim =

First, read [[OpenSim: Configuration]].

=== Where can I get a new UUID for my sim config? ===

Use 'uuidgen' or generate one on the [http://www.famkruithof.net/uuid/uuidgen uuidgen webpage].

=== Can I run multiple regions with OpenSim? ===

Yes. To do this add another xml file to bin/Regions. You need to create a new 'sim_UUID' (see above) and change the 'sim_name', 'internal_ip_port', 'sim_location_x' and 'sim_location_y' (and anything else you wish to change). Restart OpenSim.

sim_location_x and sim_location_y should be in adjacent regions, then you will be able to run back and forth between regions.

* See [[OpenSim: Configuration]].

=== How do I enable prim storage? ===

* In the OpenSim.ini file, change the storage_plugin so it points to OpenSim.DataStore.MonoSqlite.dll (storage_plugin = OpenSim.DataStore.MonoSqlite.dll).

Note: you can specify the same database for all region.xml files, as information in the database is stored with the region.

Currently, sqlite is the only database provider that works for prim storage, this will change in the future.

=== There are a bunch of textures in the library, but they are all 0x0? What's wrong? ===
To enable these extra textures for your use, you must delete your regionassets.yap file, and restart your sim. WARNING: IF YOU DO THIS, YOU WILL LOSE ANY ASSETS (textures, scripts, animations, etc) THAT YOU HAVE UPLOADED!

=== What databases are supported in OpenSim? ===
Right now the only database supported is sqlite. This is being done first to ensure all our persistent data is SQL friendly for storage, and because sqlite requires no user interaction to setup. The architexture for OpenSim specifically allows for different data store backends, and others will be created in the near future.

=== Can I export all my prims, for safe keeping? ===

Yes. From the console type
save_xml yourbackupfile

You can later load those prims with
load_xml yourbackupfile

This is also a good way to dump and clone prims from one OpenSim server to another.

= Something Has Gone Wrong! =

=== I get a timeout during region handshake ===

* Do you have the correct IP in your Regions\* config file?
* Do you have multiple interfaces on the server running OpenSim? OpenSim will not bind outgoing UDP packets to a specific IP, its default IP to reach you will be what the Region answers UDP with. If you have configured the region for another IP you will get a timeout during connect.

=== I cannot connect to my OpenSim ===

* See [[OpenSim: Connecting]].

=== I connect but cannot move ===

If the client connects but the avatar can only spin in place and not move, then the sim is not correctly configured. It completed the initial login function, but packets are not being exchanged between the client and the sim, probably due to a network configuration error on the sim.

* See [[OpenSim: Configuration]].

=== From time to time my Avatar seems to get stuck ===
Right now there is a bottle neck when syncing prims off to the database. This will cause small (5 - 10 second) apparent hangs of the Avatar, but it will recover fine once the data is synced. It is a known issue based on legacy architecture of some of the data storage code. We hope this will be removed soon.

=== I have problems with viewing the worldmap ===

* This may happen when running OpenSim on a Linux server, both in grid or standalone mode.
* Symptoms: when opening the worldmap window in the SL-viewer, the sims are not displayed grahically in the worldmap, the server console shows some error related to openjpeg, the current session freezes...
* Reason: your svn source trunk has not the correct (or whatever...) libopenjpeg-libsl library.
* Solution: get the newest code from libsecondlife (svn co svn://opensecondlife.org/libsl/trunk), 'make' manually in the subdir openjpeg-libsl, and copy the resulting libopenjpeg-libsl-2.1.2.0.so into your OpenSim .../bin subdir, overwriting the existing one.
* Recompile & restart OpenSim.

= Exceptions on the Console =
This is a list of Exceptions that you may see on the console, what they mean, and if they are a problem.

=== System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so ===
Failed generating terrain map: System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so
at (wrapper managed-to-native) OpenJPEGNet.OpenJPEG:LibslAllocDecoded OpenJPEGNet.OpenJPEG/LibslImage&)
at OpenJPEGNet.OpenJPEG.Encode (System.Byte[] decoded, Int32 width, Int32 height, Int32 components, Boolean lossless) [0x00000]
at OpenJPEGNet.OpenJPEG.EncodeFromImage (System.Drawing.Bitmap bitmap, Boolean lossless) [0x00000]
at OpenSim.Region.Terrain.TerrainEngine.ExportJpegImage (System.String gradientmap) [0x00000]

You are on Linux, and the native lib libopenjpeg-libsl-2.1.2.0.so is not compatible with your system for one of the following reasons:
* You have an old processor (libopenjpeg has been compiled with optimizations)
* You are running in 64bit mode (none of the native libs are built for 64bit)

You can rebuild your own libopenjpeg from source, or run in a compatible environment.

= OpenSim in the Wild =

=== Are there test servers running OpenSim I can connect to? ===

Yes. Check out http://deepgid.org, http://osgrid.org

=== Can I teleport from the Linden Lab Second Life grid to my Sim? ===

No, OpenSim islands cannot connect to the Linden Lab grid.

= Terrain Tidbits =
=== What programs can I use to create terrains for OpenSim? ===
If you are after simple terrain files (jpg, gif, etc), you can use Photoshop or any number of freeware programs, like Gimp. If you want more complex terrains, you will need programs that output to standard 3d raw format (aka r32 or r64). L3DT and Terragen are two of the top commercial programs for this. (anyone know of a freeware one?), or you could, with some practice, use Blender. The free version of L3DT can make terrains up to 2048x2048 in size, or 8x8 regions.

=== Where do I put the files for my terrains? ===
This one is actually pretty simple, but first the 'hard' answer: anywhere in the PATH will work. Lost? yeah, I was too, so... just drop the file into the /bin directory (right where your opensim.exe file is).

=== How do I change the terrain for a group of sims? ===
First, the file must be in f32 (or f64?) format. This is done easliy with L3DT's export feature. (use the RAW format and set the oprions to Y flipped = true and at the bottom, change it to read 'float' instead of 'ushort'). It also needs to be a file that will cover each sim in a 256x256 layer (so, for 2x2 regions, you need a 512x512 file).

Then, once you have it saved, on the OpenSim.exe console, type in:

terrain load-tile f32 <filename> <image X> <image y> <bottomleftsim X> <bottomleftsim y>

For example, I run a square of 4 sims in a 2x2 pattern. I started my sim placement at 0, 0 and ended at 1, 1. my line reads:

terrain load-tile f32 simalpha.raw 512 512 0 0

Next, before you log in, you may want to go to type in:

terrain multiply 0.4

This should scale it down from the nearly 300 meters altitude I ran into to something a little more reasonable for the minimap.

Terrain Tidbits brought to you by Tilde, with a few questions in IRC :) - [[User:Tildeampersand|Tilde]] 10:32, 15 August 2007 (PDT)

= In World Questions =

=== Does in world scripting work yet? ===

Not yet, but there is a lot of work going on here. Please see [[LlFunction_implementation_status]] for the latest info.

=== Why do I walk through objects? ===

Basicphysics doesn't support collisions between objects (just between you and the ground). There is active work on other physics engines for OpenSim, but these are quite experimental at this point, so not considered supported.

=== Can I edit my avatar? ===

Yes, but you need to create a Shape, Hair, Shirt, and Pants first via the Inventory button. There are no defaults created for each user at this point.

= Grid Mode =
Note: Grid Mode isn't officially supported yet. As such, you are pretty much on your own if you are trying to get OpenSim up and running in Grid Mode.

=== I start the sim and it doesn't connect to any grid ===

When OpenSim is first started, it needs configuration.

* See [[OpenSim: Configuration]].

=== I start the OpenSim.Grid.UserServer.exe and it gives an error ===

If this error is access denied for username@localhost, the mysql database is not set up.

It will print some text and wait for input - either an enter to accept a default value, or another value you can supply.

* See [[OpenSim: Configuration]].

=== I want to run my own Local Grid but one or more servers fail to start ===

* Be sure that you're able to start OpenSim.exe alone, in Standalone mode, and to be able to login.
* Start the servers in the correct UGAS order and answer the questions as recommended (see [[OpenSim: Configuration]]).
* Set all the external URI's to the correct IP: 127.0.0.1 if running on your local machine, or aaa.bbb.ccc.ddd if running on a remote server.
* Check again all the *.xml configuration files for any wrong settings or typing errors...!
* Don't forget to connect with your SL-viewer to port 8002 (Grid User-Server) instead of 9000 (Standalone OpenSim-Server).
* Delete all *.xml and *.yap files in the bin directory if you want to run a full reconfiguration again.

= How to ask for help =

=== Before asking for help... ===

* Search the wiki and web before asking for help.
* Check your configuration files for any obvious defects.
* Check that you're starting up the processes correctly.
* See [[OpenSim: Install]].
* See [[OpenSim: Configuration]].
* See [[OpenSim: Running]].
* See [[OpenSim: Connecting]].

=== Asking in IRC ===

IRC channels are #opensim-help, #opensim and #opensim-dev on EFNet. Approach them in that order :) Please be courteous and remember that the developers and anyone else assisting you are volunteers there.

* Don't ask to ask, just ask.
* Phrase your question in the form of a question.
* Be specific.
* Explain the problem.
* Describe how to reproduce the problem.
* If you need to paste configuration files or error messages, please paste to [http://pastebin.ca/ pastebin] then send the link in the IRC channel.

=== After you get help ===

* If no-one can help you, please submit a bug.
* If someone does help you, please document the problem and fix on the wiki on this page.

OpenSim: FAQ

2007-08-30T18:12:58Z

Tedd: /* Something Has Gone Wrong! */

Main Page

2007-08-29T19:33:31Z

Tedd:

= OpenSim =
[[Image:opensim_avatar.png]]

Hello,

This is the top level page for the OpenSim wiki. The links below are to various pages useful in obtaining, compiling and running OpenSim on both Windows & Linux.

* [[OpenSim]]
** [[OpenSim: FAQ]] (A set of Frequently Asked Questions)
** [[OpenSim: Install]] (How to install the simulator software)
** [[OpenSim: Configuration]] (How to configure the simulator for various modes)
** [[OpenSim: Network settings]] (How to setup the network for the simulator)
** [[OpenSim: Running]] (How to run standalone, local grid & public grid modes)
** [[OpenSim: Testing]] (What is tested)
** [[OpenSim: TechRef]] (A technical description of the simulator operation)
** [[OpenSim: Grids]] (Known Public grids currently available)
** [[Opensim: 0.4 Release Target Discussion]]
** [[Opensim: 0.5 Release Target Discussion]]
** [[OpenSim: Development Team]]
** [[OpenSim: Class Diagrams]]
** [[OpenSim: Scripting]] (How to use scripts and what limitations apply)

* Development Documentation
** [[PhysicsEngines]] (Options for physics engines in OpenSim)
** [[MonoSqlite]] (How the database model currently works)
** [[llFunction implementation status]] (What LSL commands has been implemented)
** [[OpenSim.Region.ScriptEngine]] (How the ScriptEngine looks internally)
 
== Who are the developers ==
OpenSim is an [http://en.wikipedia.org/wiki/Open_source open source] project. This means that it is developed by anyone who wants to participate. This could be you! 
 
== Making first contact ==
We welcome testers and developers alike. 
If you ''need help'' or ''want to help'' the best way to get in touch is IRC (chat network). There is a lot of activity there every day. 
 
* IRC on EFNet, channel #OpenSim. Download an IRC client like [http://www.xchat.org/ X-Chat] and go to EFNet (server irc.efnet.net), channel #OpenSim. If you already have an IRC client installed you can just follow [irc://irc.efnet.org/OpenSim this link].
* The official website for OpenSim can be found at [http://www.opensimulator.org/ www.opensimulator.org]
* The mailing lists are in the process of moving to another server. The archives are available for [http://openmv.org/pipermail/opensim-dev/ OpenSim-Dev] and [http://openmv.org/pipermail/opensim-commits/ OpenSim-Commits].
* You can browse the source code for opensim at [http://openmetaverse.org/svn/index.cgi/opensim/ OpenSim SVN browser] (currently broken - use svn directly - <tt>svn co svn://opensecondlife.org/opensim/trunk opensim.new/trunk</tt>)
* You can report bugs at the [http://bug.opensecondlife.org/ Mantis opensim bug tracker]

Main Page

2007-08-29T19:27:32Z

Tedd:

= OpenSim =
[[Image:opensim_avatar.png]]

Hello,

This is the top level page for the OpenSim wiki. The links below are to various pages useful in obtaining, compiling and running OpenSim on both Windows & Linux.

----

* [[OpenSim]]
** [[OpenSim: FAQ]] (A set of Frequently Asked Questions)
** [[OpenSim: Install]] (How to install the simulator software)
** [[OpenSim: Configuration]] (How to configure the simulator for various modes)
** [[OpenSim: Network settings]] (How to setup the network for the simulator)
** [[OpenSim: Running]] (How to run standalone, local grid & public grid modes)
** [[OpenSim: Testing]] (What is tested)
** [[OpenSim: TechRef]] (A technical description of the simulator operation)
** [[OpenSim: Grids]] (Known Public grids currently available)
** [[Opensim: 0.4 Release Target Discussion]]
** [[Opensim: 0.5 Release Target Discussion]]
** [[OpenSim: Development Team]]
** [[OpenSim: Class Diagrams]]
** [[OpenSim: Scripting]] (How to use scripting and what limitations apply)

* Development Documentation
** [[PhysicsEngines]] (Options for physics engines in OpenSim)
** [[MonoSqlite]] (How the database model currently works)
** [[llFunction implementation status]] (What LSL commands has been implemented)
** [[OpenSim.Region.ScriptEngine]] (How the ScriptEngine looks internally)
 
== Who are the developers ==
OpenSim is an [http://en.wikipedia.org/wiki/Open_source open source] project. This means that it is developed by anyone who wants to participate. This could be you! 
 
== Making first contact ==
We welcome testers and developers alike. 
If you ''need help'' or ''want to help'' the best way to get in touch is IRC (chat network). There is a lot of activity there every day. 
 
* IRC on EFNet, channel #OpenSim. Download an IRC client like [http://www.xchat.org/ X-Chat] and go to EFNet (server irc.efnet.net), channel #OpenSim. If you already have an IRC client installed you can just follow [irc://irc.efnet.org/OpenSim this link].
* The official website for OpenSim can be found at [http://www.opensimulator.org/ www.opensimulator.org]
* The mailing lists are in the process of moving to another server. The archives are available for [http://openmv.org/pipermail/opensim-dev/ OpenSim-Dev] and [http://openmv.org/pipermail/opensim-commits/ OpenSim-Commits].
* You can browse the source code for opensim at [http://openmetaverse.org/svn/index.cgi/opensim/ OpenSim SVN browser] (currently broken - use svn directly - <tt>svn co svn://opensecondlife.org/opensim/trunk opensim.new/trunk</tt>)
* You can report bugs at the [http://bug.opensecondlife.org/ Mantis opensim bug tracker]

Main Page

2007-08-29T19:26:38Z

Tedd:

[[Image:opensim_avatar.png]]

Hello,

This is the top level page for the OpenSim wiki. The links below are to various pages useful in obtaining, compiling and running OpenSim on both Windows & Linux.

----

* [[OpenSim]]
** [[OpenSim: FAQ]] (A set of Frequently Asked Questions)
** [[OpenSim: Install]] (How to install the simulator software)
** [[OpenSim: Configuration]] (How to configure the simulator for various modes)
** [[OpenSim: Network settings]] (How to setup the network for the simulator)
** [[OpenSim: Running]] (How to run standalone, local grid & public grid modes)
** [[OpenSim: Testing]] (What is tested)
** [[OpenSim: TechRef]] (A technical description of the simulator operation)
** [[OpenSim: Grids]] (Known Public grids currently available)
** [[Opensim: 0.4 Release Target Discussion]]
** [[Opensim: 0.5 Release Target Discussion]]
** [[OpenSim: Development Team]]
** [[OpenSim: Class Diagrams]]
** [[OpenSim: Scripting]] (How to use scripting and what limitations apply)

* Development Documentation
** [[PhysicsEngines]] (Options for physics engines in OpenSim)
** [[MonoSqlite]] (How the database model currently works)
** [[llFunction implementation status]] (What LSL commands has been implemented)
** [[OpenSim.Region.ScriptEngine]] (How the ScriptEngine looks internally)
 
== Who are the developers ==
OpenSim is an [http://en.wikipedia.org/wiki/Open_source open source] project. This means that it is developed by anyone who wants to participate. This could be you! 
 
== Making first contact ==
We welcome testers and developers alike. 
If you ''need help'' or ''want to help'' the best way to get in touch is IRC (chat network). There is a lot of activity there every day. 
 
* IRC on EFNet, channel #OpenSim. Download an IRC client like [http://www.xchat.org/ X-Chat] and go to EFNet (server irc.efnet.net), channel #OpenSim. If you already have an IRC client installed you can just follow [irc://irc.efnet.org/OpenSim this link].
* The official website for OpenSim can be found at [http://www.opensimulator.org/ www.opensimulator.org]
* The mailing lists are in the process of moving to another server. The archives are available for [http://openmv.org/pipermail/opensim-dev/ OpenSim-Dev] and [http://openmv.org/pipermail/opensim-commits/ OpenSim-Commits].
* You can browse the source code for opensim at [http://openmetaverse.org/svn/index.cgi/opensim/ OpenSim SVN browser] (currently broken - use svn directly - <tt>svn co svn://opensecondlife.org/opensim/trunk opensim.new/trunk</tt>)
* You can report bugs at the [http://bug.opensecondlife.org/ Mantis opensim bug tracker]

Main Page

2007-08-29T19:26:03Z

Tedd:

[[Image:opensim_avatar.png]]

Hello,

This is the top level page for the OpenSim wiki. The links below are to various pages useful in obtaining, compiling and running OpenSim on both Windows & Linux.

----

* [[OpenSim]]
** [[OpenSim: FAQ]] (A set of Frequently Asked Questions)
** [[OpenSim: Install]] (How to install the simulator software)
** [[OpenSim: Configuration]] (How to configure the simulator for various modes)
** [[OpenSim: Network settings]] (How to setup the network for the simulator)
** [[OpenSim: Running]] (How to run standalone, local grid & public grid modes)
** [[OpenSim: Testing]] (What is tested)
** [[OpenSim: TechRef]] (A technical description of the simulator operation)
** [[OpenSim: Grids]] (Known Public grids currently available)
** [[Opensim: 0.4 Release Target Discussion]]
** [[Opensim: 0.5 Release Target Discussion]]
** [[OpenSim: Development Team]]
** [[OpenSim: Class Diagrams]]
** [[OpenSim: Scripting]]

* Development Documentation
** [[PhysicsEngines]] (Options for physics engines in OpenSim)
** [[MonoSqlite]] (How the database model currently works)
** [[llFunction implementation status]] (What LSL commands has been implemented)
** [[OpenSim.Region.ScriptEngine]] (How the ScriptEngine looks internally)
 
== Who are the developers ==
OpenSim is an [http://en.wikipedia.org/wiki/Open_source open source] project. This means that it is developed by anyone who wants to participate. This could be you! 
 
== Making first contact ==
We welcome testers and developers alike. 
If you ''need help'' or ''want to help'' the best way to get in touch is IRC (chat network). There is a lot of activity there every day. 
 
* IRC on EFNet, channel #OpenSim. Download an IRC client like [http://www.xchat.org/ X-Chat] and go to EFNet (server irc.efnet.net), channel #OpenSim. If you already have an IRC client installed you can just follow [irc://irc.efnet.org/OpenSim this link].
* The official website for OpenSim can be found at [http://www.opensimulator.org/ www.opensimulator.org]
* The mailing lists are in the process of moving to another server. The archives are available for [http://openmv.org/pipermail/opensim-dev/ OpenSim-Dev] and [http://openmv.org/pipermail/opensim-commits/ OpenSim-Commits].
* You can browse the source code for opensim at [http://openmetaverse.org/svn/index.cgi/opensim/ OpenSim SVN browser] (currently broken - use svn directly - <tt>svn co svn://opensecondlife.org/opensim/trunk opensim.new/trunk</tt>)
* You can report bugs at the [http://bug.opensecondlife.org/ Mantis opensim bug tracker]

Main Page

2007-08-29T19:25:31Z

Tedd:

[[Image:opensim_avatar.png]]

Hello,

This is the top level page for the OpenSim wiki. The links below are to various pages useful in obtaining, compiling and running OpenSim on both Windows & Linux.

----

* [[OpenSim]]
** [[OpenSim: FAQ]] (A set of Frequently Asked Questions)
** [[OpenSim: Install]] (How to install the simulator software)
** [[OpenSim: Configuration]] (How to configure the simulator for various modes)
** [[OpenSim: Network settings]] (How to setup the network for the simulator)
** [[OpenSim: Running]] (How to run standalone, local grid & public grid modes)
** [[OpenSim: Testing]] (What is tested)
** [[OpenSim: TechRef]] (A technical description of the simulator operation)
** [[OpenSim: Grids]] (Known Public grids currently available)
** [[Opensim: 0.4_Release_Target_Discussion]]
** [[OpenSim: Development Team]]
** [[OpenSim: Class Diagrams]]
** [[OpenSim: Scripting]]

* Development Documentation
** [[PhysicsEngines]] (Options for physics engines in OpenSim)
** [[MonoSqlite]] (How the database model currently works)
** [[llFunction implementation status]] (What LSL commands has been implemented)
** [[OpenSim.Region.ScriptEngine]] (How the ScriptEngine looks internally)
 
== Who are the developers ==
OpenSim is an [http://en.wikipedia.org/wiki/Open_source open source] project. This means that it is developed by anyone who wants to participate. This could be you! 
 
== Making first contact ==
We welcome testers and developers alike. 
If you ''need help'' or ''want to help'' the best way to get in touch is IRC (chat network). There is a lot of activity there every day. 
 
* IRC on EFNet, channel #OpenSim. Download an IRC client like [http://www.xchat.org/ X-Chat] and go to EFNet (server irc.efnet.net), channel #OpenSim. If you already have an IRC client installed you can just follow [irc://irc.efnet.org/OpenSim this link].
* The official website for OpenSim can be found at [http://www.opensimulator.org/ www.opensimulator.org]
* The mailing lists are in the process of moving to another server. The archives are available for [http://openmv.org/pipermail/opensim-dev/ OpenSim-Dev] and [http://openmv.org/pipermail/opensim-commits/ OpenSim-Commits].
* You can browse the source code for opensim at [http://openmetaverse.org/svn/index.cgi/opensim/ OpenSim SVN browser] (currently broken - use svn directly - <tt>svn co svn://opensecondlife.org/opensim/trunk opensim.new/trunk</tt>)
* You can report bugs at the [http://bug.opensecondlife.org/ Mantis opensim bug tracker]

Main Page

2007-08-29T19:24:49Z

Tedd:

[[Image:opensim_avatar.png]]

Hello,

This is the top level page for the OpenSim wiki. The links below are to various pages useful in obtaining, compiling and running OpenSim on both Windows & Linux.

----

* [[OpenSim]]
** [[OpenSim: FAQ]] (A set of Frequently Asked Questions)
** [[OpenSim: Install]] (How to install the simulator software)
** [[OpenSim: Configuration]] (How to configure the simulator for various modes)
** [[OpenSim: Network settings]] (How to setup the network for the simulator)
** [[OpenSim: Running]] (How to run standalone, local grid & public grid modes)
** [[OpenSim: Testing]] (What is tested)
** [[OpenSim: TechRef]] (A technical description of the simulator operation)
** [[OpenSim: Grids]] (Known Public grids currently available)
** [[Opensim: 0.4_Release_Target_Discussion]]
** [[OpenSim: Development Team]]
** [[OpenSim: Class Diagrams]]
** [[OpenSim: Scripting]]

* Development Documentation
** [[PhysicsEngines]] (Options for physics engines in OpenSim)
** [[MonoSqlite]] (How the database model currently works)
** [[llFunction implementation status]] (What LSL commands has been implemented)
** [[OpenSim.Region.ScriptEngine]] (How the ScriptEngine works)

== Who are the developers ==
OpenSim is an [http://en.wikipedia.org/wiki/Open_source open source] project. This means that it is developed by anyone who wants to participate. This could be you! 
 
== Making first contact ==
We welcome testers and developers alike. 
If you ''need help'' or ''want to help'' the best way to get in touch is IRC (chat network). There is a lot of activity there every day. 
 
* IRC on EFNet, channel #OpenSim. Download an IRC client like [http://www.xchat.org/ X-Chat] and go to EFNet (server irc.efnet.net), channel #OpenSim. If you already have an IRC client installed you can just follow [irc://irc.efnet.org/OpenSim this link].
* The official website for OpenSim can be found at [http://www.opensimulator.org/ www.opensimulator.org]
* The mailing lists are in the process of moving to another server. The archives are available for [http://openmv.org/pipermail/opensim-dev/ OpenSim-Dev] and [http://openmv.org/pipermail/opensim-commits/ OpenSim-Commits].
* You can browse the source code for opensim at [http://openmetaverse.org/svn/index.cgi/opensim/ OpenSim SVN browser] (currently broken - use svn directly - <tt>svn co svn://opensecondlife.org/opensim/trunk opensim.new/trunk</tt>)
* You can report bugs at the [http://bug.opensecondlife.org/ Mantis opensim bug tracker]

Main Page

2007-08-29T19:22:51Z

Tedd:

[[Image:opensim_avatar.png]]

Hello,

This is the top level page for the OpenSim wiki. The links below are to various pages useful in obtaining, compiling and running OpenSim on both Windows & Linux.

----

* [[OpenSim]]
** [[OpenSim: FAQ]] (A set of Frequently Asked Questions)
** [[OpenSim: Install]] (How to install the simulator software)
** [[OpenSim: Configuration]] (How to configure the simulator for various modes)
** [[OpenSim: Network settings]] (How to setup the network for the simulator)
** [[OpenSim: Running]] (How to run standalone, local grid & public grid modes)
** [[OpenSim: Testing]] (What is tested)
** [[OpenSim: TechRef]] (A technical description of the simulator operation)
** [[OpenSim: Grids]] (Known Public grids currently available)
** [[Opensim: 0.4_Release_Target_Discussion]]
** [[OpenSim: Development Team]]
** [[OpenSim: Class Diagrams]]
** [[OpenSim: Scripting]]

* Development Documentation
** [[PhysicsEngines]] (Options for physics engines in OpenSim) 
** [[MonoSqlite]] (How the database model currently works)

== Who are the developers ==
OpenSim is an [http://en.wikipedia.org/wiki/Open_source open source] project. This means that it is developed by anyone who wants to participate. This could be you! 
 
== Making first contact ==
We welcome testers and developers alike. 
If you ''need help'' or ''want to help'' the best way to get in touch is IRC (chat network). There is a lot of activity there every day. 
 
* IRC on EFNet, channel #OpenSim. Download an IRC client like [http://www.xchat.org/ X-Chat] and go to EFNet (server irc.efnet.net), channel #OpenSim. If you already have an IRC client installed you can just follow [irc://irc.efnet.org/OpenSim this link].
* The official website for OpenSim can be found at [http://www.opensimulator.org/ www.opensimulator.org]
* The mailing lists are in the process of moving to another server. The archives are available for [http://openmv.org/pipermail/opensim-dev/ OpenSim-Dev] and [http://openmv.org/pipermail/opensim-commits/ OpenSim-Commits].
* You can browse the source code for opensim at [http://openmetaverse.org/svn/index.cgi/opensim/ OpenSim SVN browser] (currently broken - use svn directly - <tt>svn co svn://opensecondlife.org/opensim/trunk opensim.new/trunk</tt>)
* You can report bugs at the [http://bug.opensecondlife.org/ Mantis opensim bug tracker]

Scripting About

2007-08-29T19:00:51Z

Tedd: /* How to contribute */

== How to use scripts in OpenSim ==

Have a look at the [http://wiki.secondlife.com/wiki/LSL_Portal LSL wiki] to learn LSL. 
The current procedure to get a script working in OpenSim is:
* Create a new script in inventory.
* Write whatever script you want there. Check [[llFunction implementation status]] for what commands that is supported.
* Drag the script over to an object.
* Delete the script from the object to deactivate script.
 
There are still some defects:
* You can not edit script while it is inside object.
* When restarting OpenSim server scripts are lost and not started.
* Line numbers in error messages may miss by 1 or 2 lines.

== About OpenSim scripting ==
An important ingredience in Second Life is scripting. It is the engine that drives it all. 
In SL [http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)] is the language you have to use. This language has its limitations, and is executed very slowly. But nevertheless it works and it gets the job done. 
 
Linden Labs are planning to move LSL scripting over to C# on Mono some time in the future. This has been in the works since 2005 at least. There are many difficult technical challenges related to this. 
 
OpenSim supports LSL and C# scripts. But with limitations: 
* Not all commands and events has been implemented. See [[llFunction implementation status]] for details on what commands work and not.
* Scripts that are running can not cross regions.
* You can not use loops inside your scripts. Actually you can use loops, but it will block other scripts from executing.
 
The OpenSim script engine compiles the LSL code down to .Net code that is JIT'ed to CPU native gode. In effect this means that a LSL script in OpenSim should run faster than in Second Life. 
 
== How to contribute ==
The ScriptEngine is being developed by the many developers. 
New developers are always welcome. If you want to contribute, even just a tiny little bit, have a look at the [[OpenSim.Region.ScriptEngine]] page. There is a low of developer activity on IRC ([[Contact us]]), feel free to drop in. 
A blog with development status can be found at [http://teddmaa.blogspot.com/ http://teddmaa.blogspot.com/].

OpenSim: Scripting

2007-08-29T19:00:51Z

Tedd: /* How to contribute */

Scripting About

2007-08-29T18:58:07Z

Tedd:

== How to use scripts in OpenSim ==

Have a look at the [http://wiki.secondlife.com/wiki/LSL_Portal LSL wiki] to learn LSL. 
The current procedure to get a script working in OpenSim is:
* Create a new script in inventory.
* Write whatever script you want there. Check [[llFunction implementation status]] for what commands that is supported.
* Drag the script over to an object.
* Delete the script from the object to deactivate script.
 
There are still some defects:
* You can not edit script while it is inside object.
* When restarting OpenSim server scripts are lost and not started.
* Line numbers in error messages may miss by 1 or 2 lines.

== About OpenSim scripting ==
An important ingredience in Second Life is scripting. It is the engine that drives it all. 
In SL [http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)] is the language you have to use. This language has its limitations, and is executed very slowly. But nevertheless it works and it gets the job done. 
 
Linden Labs are planning to move LSL scripting over to C# on Mono some time in the future. This has been in the works since 2005 at least. There are many difficult technical challenges related to this. 
 
OpenSim supports LSL and C# scripts. But with limitations: 
* Not all commands and events has been implemented. See [[llFunction implementation status]] for details on what commands work and not.
* Scripts that are running can not cross regions.
* You can not use loops inside your scripts. Actually you can use loops, but it will block other scripts from executing.
 
The OpenSim script engine compiles the LSL code down to .Net code that is JIT'ed to CPU native gode. In effect this means that a LSL script in OpenSim should run faster than in Second Life. 
 
== How to contribute ==
The ScriptEngine is being developed by many developers. New developers are always welcome. If you want to contribute, even just a tiny little bit, have a look at the [[OpenSim.Region.ScriptEngine]] page. 
A blog with development status can be found at [http://teddmaa.blogspot.com/ http://teddmaa.blogspot.com/].

OpenSim: Scripting

2007-08-29T18:58:07Z

Tedd:

== How to use scripts in OpenSim ==

Have a look at the [http://wiki.secondlife.com/wiki/LSL_Portal LSL wiki] to learn LSL. 
The current procedure to get a script working in OpenSim is:
* Create a new script in inventory.
* Write whatever script you want there. Check [[llFunction implementation status]] for what commands that is supported.
* Drag the script over to an object.
* Delete the script from the object to deactivate script.
 
There are still some defects:
* You can not edit script while it is inside object.
* When restarting OpenSim server scripts are lost and not started.
* Line numbers in error messages may miss by 1 or 2 lines.

== About OpenSim scripting ==
An important ingredience in Second Life is scripting. It is the engine that drives it all. 
In SL [http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)] is the language you have to use. This language has its limitations, and is executed very slowly. But nevertheless it works and it gets the job done. 
 
Linden Labs are planning to move LSL scripting over to C# on Mono some time in the future. This has been in the works since 2005 at least. There are many difficult technical challenges related to this. 
 
OpenSim supports LSL and C# scripts. But with limitations: 
* Not all commands and events has been implemented. See [[llFunction implementation status]] for details on what commands work and not.
* Scripts that are running can not cross regions.
* You can not use loops inside your scripts. Actually you can use loops, but it will block other scripts from executing.
 
The OpenSim script engine compiles the LSL code down to .Net code that is JIT'ed to CPU native gode. In effect this means that a LSL script in OpenSim should run faster than in Second Life. 
 
== How to contribute ==
The ScriptEngine is being developed by many developers. New developers are always welcome. If you want to contribute, even just a tiny little bit, have a look at the [[OpenSim.Region.ScriptEngine]] page. 
A blog with development status can be found at [http://teddmaa.blogspot.com/ http://teddmaa.blogspot.com/].

Scripting About

2007-08-29T16:52:19Z

Tedd:

== How to use scripts in OpenSim ==

Have a look at the [http://wiki.secondlife.com/wiki/LSL_Portal LSL wiki] to learn LSL. 
The current procedure to get a script working in OpenSim is:
* Create a new script in inventory.
* Write whatever script you want there. Check [[llFunction implementation status]] for what commands that is supported.
* Drag the script over to an object.
* Delete the script from the object to deactivate script.
 
There are still some defects:
* You can not edit script while it is inside object.
* When restarting OpenSim server scripts are lost and not started.
* Line numbers in error messages may miss by 1 or 2 lines.

== About OpenSim scripting ==
An important ingredience in Second Life is scripting. It is the engine that drives it all. 
In SL [http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)] is the language you have to use. This language has its limitations, and is executed very slowly. But nevertheless it works and it gets the job done. 
 
Linden Labs are planning to move LSL scripting over to C# on Mono some time in the future. This has been in the works since 2005 at least. There are many difficult technical challenges related to this. 
 
OpenSim supports LSL and C# scripts. But with limitations: 
* Not all commands and events has been implemented. See [[llFunction implementation status]] for details on what commands work and not.
* Scripts that are running can not cross regions.
* You can not use loops inside your scripts. Actually you can use loops, but it will block other scripts from executing.
 
The OpenSim script engine compiles the LSL code down to .Net code that is JIT'ed to CPU native gode. In effect this means that a LSL script in OpenSim should run faster than in Second Life. 
 
The ScriptEngine is being developed by many developers. If you want to contribute, have a look at the [[OpenSim.Region.ScriptEngine]] page. 
A blog with development status can be found at [http://teddmaa.blogspot.com/ http://teddmaa.blogspot.com/].

OpenSim: Scripting

2007-08-29T16:52:19Z

Tedd:

== How to use scripts in OpenSim ==

Have a look at the [http://wiki.secondlife.com/wiki/LSL_Portal LSL wiki] to learn LSL. 
The current procedure to get a script working in OpenSim is:
* Create a new script in inventory.
* Write whatever script you want there. Check [[llFunction implementation status]] for what commands that is supported.
* Drag the script over to an object.
* Delete the script from the object to deactivate script.
 
There are still some defects:
* You can not edit script while it is inside object.
* When restarting OpenSim server scripts are lost and not started.
* Line numbers in error messages may miss by 1 or 2 lines.

== About OpenSim scripting ==
An important ingredience in Second Life is scripting. It is the engine that drives it all. 
In SL [http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)] is the language you have to use. This language has its limitations, and is executed very slowly. But nevertheless it works and it gets the job done. 
 
Linden Labs are planning to move LSL scripting over to C# on Mono some time in the future. This has been in the works since 2005 at least. There are many difficult technical challenges related to this. 
 
OpenSim supports LSL and C# scripts. But with limitations: 
* Not all commands and events has been implemented. See [[llFunction implementation status]] for details on what commands work and not.
* Scripts that are running can not cross regions.
* You can not use loops inside your scripts. Actually you can use loops, but it will block other scripts from executing.
 
The OpenSim script engine compiles the LSL code down to .Net code that is JIT'ed to CPU native gode. In effect this means that a LSL script in OpenSim should run faster than in Second Life. 
 
The ScriptEngine is being developed by many developers. If you want to contribute, have a look at the [[OpenSim.Region.ScriptEngine]] page. 
A blog with development status can be found at [http://teddmaa.blogspot.com/ http://teddmaa.blogspot.com/].

Scripting About

2007-08-29T16:51:56Z

Tedd: /* About OpenSim scripting */

== About OpenSim scripting ==
An important ingredience in Second Life is scripting. It is the engine that drives it all. 
In SL [http://wiki.secondlife.com/wiki/LSL_Portal LSL (Linden Scripting Language)] is the language you have to use. This language has its limitations, and is executed very slowly. But nevertheless it works and it gets the job done. 
 
Linden Labs are planning to move LSL scripting over to C# on Mono some time in the future. This has been in the works since 2005 at least. There are many difficult technical challenges related to this. 
 
OpenSim supports LSL and C# scripts. But with limitations: 
* Not all commands and events has been implemented. See [[llFunction implementation status]] for details on what commands work and not.
* Scripts that are running can not cross regions.
* You can not use loops inside your scripts. Actually you can use loops, but it will block other scripts from executing.
 
The OpenSim script engine compiles the LSL code down to .Net code that is JIT'ed to CPU native gode. In effect this means that a LSL script in OpenSim should run faster than in Second Life. 
 
The ScriptEngine is being developed by many developers. If you want to contribute, have a look at the [[OpenSim.Region.ScriptEngine]] page. 
A blog with development status can be found at [http://teddmaa.blogspot.com/ http://teddmaa.blogspot.com/]. 

== How to use scripts in OpenSim ==

Have a look at the [http://wiki.secondlife.com/wiki/LSL_Portal LSL wiki] to learn LSL. 
The current procedure to get a script working in OpenSim is:
* Create a new script in inventory.
* Write whatever script you want there. Check [[llFunction implementation status]] for what commands that is supported.
* Drag the script over to an object.
* Delete the script from the object to deactivate script.
 
There are still some defects:
* You can not edit script while it is inside object.
* When restarting OpenSim server scripts are lost and not started.
* Line numbers in error messages may miss by 1 or 2 lines.

OpenSim: Scripting

2007-08-29T16:51:56Z

Tedd: /* About OpenSim scripting */