ModRex

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(→‎Setup)
m (→‎See Also: added link to orphaned simxtd script page)
 
(18 intermediate revisions by 11 users not shown)
Line 1: Line 1:
−
''This software is still pre-alpha. Don't use it, unless you don't mind compiling/debugging it yourself''
+
__NOTOC__
 +
{{Quicklinks}}
  
−
==Overview==
+
{{archive}}
−
[[image:modrex.jpg|250px|thumb|left|ModRex with mesh support, running on Linux]]
+
'''Purpose:''' The information on this page is out of date. However, it may still hold value to some people (examples are chat logs, version history, or OpenSimulator 0.6x specific info) or needs to be preserved for other reasons. It should be marked as archived information to prevent confusion.
−
ModRex is a joint effort between RealXtend and OpenSim developers to make it
+
 
−
possible to join the RealXtend viewer to the OpenSim codebase. The RealXtend
+
<br />
−
viewer employs the open source [http://www.ogre3d.org OGRE game engine]
+
 
 +
== Overview ==
 +
[[Image:modrex.jpg|250px|thumb|left|ModRex with mesh support, running on Linux]]
 +
ModRex is a joint effort between RealXtend and OpenSimulator developers to make it
 +
possible to join the RealXtend viewer to the OpenSimulator codebase. The RealXtend
 +
viewer employs the open source [http://www.ogre3d.org OGRE 3D engine]
 
and differs from the Linden Lab viewer (LLviewer) in several ways. The most distinct
 
and differs from the Linden Lab viewer (LLviewer) in several ways. The most distinct
 
difference is in the new rendering potential offered by OGRE. When using
 
difference is in the new rendering potential offered by OGRE. When using
Line 12: Line 18:
 
(multiple meshes and sub-meshes) and can include a skeleton for defining avatar motion and dynamics.
 
(multiple meshes and sub-meshes) and can include a skeleton for defining avatar motion and dynamics.
  
−
ModRex is important to the OpenSim community mainly because, like the base
+
ModRex is important to the OpenSimulator community mainly because, like the base
 
opensim code base itself, the RealXtend viewer is open source and breaks away
 
opensim code base itself, the RealXtend viewer is open source and breaks away
 
from some of the key contraints imposed by the LLviewer, such as inability to
 
from some of the key contraints imposed by the LLviewer, such as inability to
Line 19: Line 25:
 
trunk code.
 
trunk code.
  
−
and a to illustrate some of the mesh and lighting effects in the viewer:
+
and a to illustrate some of the mesh and lighting effects in the viewer:
  
 
To use ModRex, you need the following:  
 
To use ModRex, you need the following:  
−
* [http://www.realxtend.org/page.php?pg=downloads RealXtend viewer]
+
* [http://realxtend.org/download/ RealXtend viewer (CodeName: Tundra)]
 +
* Alternatively you can also use the new [http://wiki.realxtend.org/index.php/Getting_Started_with_Naali Naali viewer]  
 
* [http://forge.opensimulator.org/gf/project/modrex/ ModRex]
 
* [http://forge.opensimulator.org/gf/project/modrex/ ModRex]
 
* [OpenSim-SVN (rev. 8814+)
 
* [OpenSim-SVN (rev. 8814+)
 +
* [http://www.mono-project.com/Main_Page Mono] (Linux)
 +
* [http://nant.sourceforge.net/ NAnt] (Linux)
  
−
==Links==
+
== Links ==
 
* [http://forge.opensimulator.org/gf/project/modrex/ Source Code]
 
* [http://forge.opensimulator.org/gf/project/modrex/ Source Code]
−
* [http://rexdeveloper.org/wiki/index.php?title=Features_supported_currently ModRex Features/Status]
+
* [http://wiki.realxtend.org/index.php/Features_supported_currently ModRex Features/Status]
 
* [http://www.realxtend.org Main RealXtend]
 
* [http://www.realxtend.org Main RealXtend]
−
* [http://rexdeveloper.org/wiki/index.php?title=Main_Page Rex Developer]
+
* [http://wiki.realxtend.org/ RealXtend community wiki]
  
−
==Setup==
+
== Setup ==
−
===Linux===
+
−
In our setup we will be using standalone OpenSim instances, utilizing modrex. Each OpenSim instance will have it's own database. Copy the following [[simxtd installer code]] to a file called simxtd. Make executable
+
−
chmod +x simxtd
+
  
−
<source lang="bash">
+
First launch realXtend authentication and avatar storage servers. You can download them from [http://sourceforge.net/projects/realxtendserver/files/ SourceForge project page]. Documentation for these servers can be found from [http://docs.realxtend.org/ realXtend user documentation wiki].
−
#!/bin/bash
+
−
oshome='/opt/opensim'
+
  
−
function buildOS {
+
After successfully launching authentication and avatar storage server, build ModreX according to instructions in [http://wiki.realxtend.org/index.php/Building_ModreX realXtend wiki]. To configure ModreX follow the instructions in [http://wiki.realxtend.org/index.php/Configuring_ModreX this wiki page].
−
pushd $oshome/$simdir > /dev/null 2>&1
+
−
sh runprebuild.sh
+
−
nant
+
−
popd > /dev/null 2>&1
+
−
}
+
  
−
function buildModRex {
+
If any bugs occur, please report them to [http://forge.opensimulator.org/gf/project/modrex/tracker/ ModreX bug tracker]. Note that to run realXtend 0.4 series viewer on Linux, you need to follow [[RealXtend Viewer Linux|these instructions]].
−
pushd $oshome/$simdir/modrex/ModularRex > /dev/null 2>&1
+
−
sh runprebuild.sh
+
−
nant
+
−
cp -a RexParts/RexPython/Resources/* ../../bin/ScriptEngines/
+
−
cat modrex.ini ../../bin/OpenSim.ini.example > ../../bin/OpenSim.ini.modrex
+
−
popd > /dev/null 2>&1
+
−
}
+
  
−
function getSimulator {
+
== Known Issues ==
−
if [ -d "$oshome/$simdir" ]; then
+
−
echo -n "Directory exists. Updating..."
+
−
pushd $oshome/$simdir > /dev/null 2>&1
+
−
svn update
+
−
buildOS
+
−
pushd $oshome/$simdir/modrex/ModularRex > /dev/null 2>&1
+
−
svn update
+
−
buildModRex
+
−
popd > /dev/null 2>&1
+
−
popd > /dev/null 2>&1
+
−
else
+
−
echo -n "Installing..."
+
−
mkdir $oshome/$simdir/ $oshome/$simdir/modrex > /dev/null 2>&1
+
−
svn co http://opensimulator.org/svn/opensim/trunk $oshome/$simdir
+
−
buildOS
+
−
svn co http://forge.opensimulator.org/svn/modrex/trunk $oshome/$simdir/modrex
+
−
buildModRex
+
−
fi
+
−
}
+
−
if [ "$#" -eq "1" ]; then
+
−
simdir="$1"
+
−
else
+
−
read -p "modrex installer will use specified dir: $oshome/" simdir
+
−
fi
+
−
getSimulator
+
−
echo -n "Installation Completed"
+
−
exit 0
+
−
</source>
+
−
* Install in /opt/opensim/sim9000 by executing the script like:
+
−
sh getrexsim.sh sim9000
+
−
* Download and build the authentication service
+
−
svn co https://realxtendserver.svn.sourceforge.net/svnroot/realxtendserver/authentication/tags/0.4 /opt/opensim/authentication
+
−
cd /opt/opensim/authentication
+
−
mono bin/Prebuild.exe /target nant
+
−
nant
+
−
* Create a mysql database "authentication" or point to WiXTD's(experimental) database
+
−
cd bin
+
−
mono Authentication.exe
+
−
* Setup authentication
+
−
MySql_SqlHandler.dll (or SQLite_SqlHandler.dll. MySql_SqlHandler.dll gives not implemented messages but seems to work ok)
+
−
<enter>(AuthenticationEngine=AuthenticationEngine.dll)
+
−
<enter>(logging enabled=False)
+
−
<enter>(def. region x 1000)
+
−
<enter>(def. region y 1000)
+
−
<enter>(avatarstorageurl 172.16.1.65:10000)
+
−
<enter>(default gridurl 172.16.1.65:9000)
+
−
<enter>(default dns)
+
−
<enter>(dbserver 127.0.0.1)
+
−
<enter>(dbname authentication)
+
−
<enter>(dbuser root)
+
−
*******(dbpw for root)
+
−
172.16.1.65 (httpsettings LAN-IP)
+
−
''The authentication daemon should run by now''
+
−
* Create a user in the authentication screenconsole
+
−
create user
+
−
 
+
−
* Download and build the avatarstorage service
+
−
svn co https://realxtendserver.svn.sourceforge.net/svnroot/realxtendserver/avatarstorage/tags/0.4 /opt/opensim/avatarstorage
+
−
cd /opt/opensim/avatarstorage
+
−
bin/Prebuild.exe /target nant
+
−
nant
+
−
cd bin
+
−
mono AvatarStorage.exe
+
−
* Setup avatarstorage
+
−
MySql_SqlHandler.dll
+
−
<enter>(AuthenticationEngine.dll)
+
−
<enter>(Inventory True)
+
−
<enter>(PersonalInventoryService.dll)
+
−
PersonalInventory.SQLITE.dll
+
−
<enter>(logging_enabled False)
+
−
<enter>(dbserver 127.0.0.1)
+
−
avatarstorage (dbname)
+
−
<enter>(dbuser root)
+
−
********(dbpw root)
+
−
172.16.1.65 (httpsettings LAN-IP)
+
−
<enter>(http port 10000)
+
−
<enter>(ssl False)
+
−
''The avatarstorage daemon should run by now''
+
−
* You can use this [[rex serverscript]] to manage and start the services(uses screen), or install WiXTD and Moo...
+
−
Most important screen-commands are:
+
−
screen -list (shows screen sessions)
+
−
screen -r screenname (attaches to the screensession)
+
−
ctrl-a + d (detaches from the screensession)
+
−
 
+
−
the 'Account' part is the first part in your rex-username(account@myauthenticationdaemonuri)
+
−
* Check in the Simulator console if everything started the way it's supposed to
+
−
 
+
−
''Once the three services are running, an initial user was made, fire up the realXtend client from [[RealXtend_Viewer_Linux|wine]] and login with your credentials.''
+
−
 
+
−
===Windows===
+
−
The following procedure is used to set up modrex:
+
−
 
+
−
* Modrex uses the latest subversion (latest build) of OpenSim. Download opensim using svn checkout of the trunk code. This procedure used Microsoft Visual C# 2008. To differentiate the checkout from other opensim builds that you may have, call it opensim_modrex, for example. Then, you will remember that this build requires the RealXtend viewer. We'll assume you have your opensim implementation stored in C:\opensim_modrex.
+
−
* Prebuild (i.e., running Prebuild2008) and compile as you would do normally just to make sure that this build of opensim is executing. Start up opensim and make sure that you can view the region using the LLviewer.
+
−
* Create a new folder such as C:\modrex, and then get the latest version of modrex into this folder. Modrex is obtained using a version of svn, such as TortoiseSVN. The checkout URL is http://forge.opensimulator.org/svn/modrex. You will need to enter "anonymous" when asked to check out modrex. Make note of the revision of modrex after all files have been downloaded, just for reference in case you encounter difficulties and need to report a concern or bug.
+
−
* Copy the folders located in C:\modrex\trunk to C:\opensim_modrex\opensim
+
−
* Run the prebuild (if using VC # 2005) or prebuild2008 (if using VC# 2008) that is now located  under C:\opensim_modrex\opensim\ModularRex.
+
−
* Go to your c:\opensim_modrex, launch VC# on the OpenSim solution, and enter 3 projects to the existing OpenSim solution (right-mouse click on the solution name, Add->Existing Project): ModularRex (found in C:\opensim_modrex\opensim\ModularRex), ModularRex.Nhibernate (found in C:\opensim_modrex\opensim\ModularRex\Nhibernate), and ModularRex.RexFramework (found in C:\opensim_modrex\opensim\ModularRex\RexFramework).
+
−
* Re-build the opensim solution. There should not be any errors. This, in turn, will add new region modules especially for the RealXtend viewer/OpenSim connection inside of C:\opensim_modrex\bin.
+
−
* Make sure to copy OpenSim.ini.example to OpenSim.ini. Inside of this new ini file (c:\opensim_modrex\bin\OpenSim.ini), add the following section:
+
−
<pre>
+
−
[realXtend]
+
−
db_connectionstring = "SQLiteDialect;SQLite20Driver;Data Source=RexObjects.db;Version=3"
+
−
# Assuming you are running modrex ver 99 or later, add the following and turn off the OpenSim EventQueue
+
−
RexEventQueue=True
+
−
</pre>
+
−
In the [Startup] section, set EventQueue=False
+
−
 
+
−
* We are almost ready to run the viewer, except that the current incarnation of modrex requires authentication and avatar storage to be run separately in addition to opensim. Therefore, the way to run modrex, is to (1) Start the Authentication server, (2) Start the Avatar Storage server, and finally to (3) run opensim. The server is located in the general web page as the client viewer [http://realxtend.org/page.php?pg=downloads here]. This procedure was based on the latest binary server available. The  authentication server and avatar storage servers are .exe files located in the primary server download. Do not run the server, only Authentication and Avatar Storage. Use the Authentication window to add new users as required.
+
−
* Launch opensim.exe. This will now run opensim, access the new Modrex region modules inside of C:\opensim_modrex\bin, and start up your opensim server.
+
−
* Launch the RealXtend viewer and enter your username, password, and connection. Your username, in contrast to Opensim user names, will be one string such as "testuser". If the domain of your server is myserver.com, then you log in as "testuser@myserver.com" entered in the "User Name" field. Enter the password. For "Connect To:", enter  your server: myserver.com. Then, press "Connect" in the viewer.
+
−
* You should be inside of your opensim world but using the RealXtend viewer. Caveats and Bugs are located below.
+
−
* The RealXtend viewer can run python scripts. To enable python, first add the following line in the [startup] section of OpenSim.ini:  rex_python=true. Then, you must copy the following two directories: C:\opensim_modrex\opensim\ModularRex\RexParts\RexPython\Resources\Lib and PythonScript to C:\opensim_modrex\bin\ScriptEngines. [http://www.youtube.com/watch?v=vlTE7onElVE&feature=channel_page Here] is an example using a python script that postprocesses the main window rendering with OGRE-based effects.
+
−
* If you ever wish to use the LLviewer on the region you have created, temporarily move the RealXtend region modules under C:\opensim_modrex\bin out of there, and launch LLviewer. These modules are all prefixed with "ModularRex.". Move the region modules back to continue with the RealXtend viewer. Note that RealXtend-specific artifacts (mesh, shadows) will not appear in LLviewer.
+
−
 
+
−
==Known Issues==
+
 
* Some parts of the LLViewer interface do not yet exist in the RealXtend viewer. This is related to ModRex not allowing the viewer to set or retrieve certain data.
 
* Some parts of the LLViewer interface do not yet exist in the RealXtend viewer. This is related to ModRex not allowing the viewer to set or retrieve certain data.
 
* Inter-mesh collisions not yet implemented, although avatar w/ primitive collisions work
 
* Inter-mesh collisions not yet implemented, although avatar w/ primitive collisions work
 
* Shift-copied Objects may loose their texture after a sim restart
 
* Shift-copied Objects may loose their texture after a sim restart
  
−
==Recent Fixes==
+
== Recent Fixes ==
 
* Multiregion Support with RexQueue
 
* Multiregion Support with RexQueue
 
* Multiple standalones on one machine supported
 
* Multiple standalones on one machine supported
Line 185: Line 61:
 
* Python scripting works for the most part (some functions are not working yet)
 
* Python scripting works for the most part (some functions are not working yet)
 
* Shift-copy keeps mesh as primdata
 
* Shift-copy keeps mesh as primdata
−
* OpenSim library useable now
+
* OpenSimulator library useable now
 
* Avatar is stored, but appearance changes only after viewer restart
 
* Avatar is stored, but appearance changes only after viewer restart
 +
 +
== See Also ==
 +
 +
* [[Rex_serverscript]] - Example Linux SysVinit startup scripts for ModRex
 +
* [[Rex_mysql]] - Example MySQL table definitions for ModRex
 +
* [[Simxtd]] - BASH script for building and install OpenSimulator with ModRex and RealXtend support

Latest revision as of 08:19, 18 September 2020

Languages Languages: 

En.png English

Imbox obsolete.png

This article or section is archived information.
The information in this page is no longer current, but it is being kept for historical reasons.
Do not delete this information, since it may hold historical value.

Purpose: The information on this page is out of date. However, it may still hold value to some people (examples are chat logs, version history, or OpenSimulator 0.6x specific info) or needs to be preserved for other reasons. It should be marked as archived information to prevent confusion.


[edit] Overview

ModRex with mesh support, running on Linux

ModRex is a joint effort between RealXtend and OpenSimulator developers to make it possible to join the RealXtend viewer to the OpenSimulator codebase. The RealXtend viewer employs the open source OGRE 3D engine and differs from the Linden Lab viewer (LLviewer) in several ways. The most distinct difference is in the new rendering potential offered by OGRE. When using RealXtend as a viewer for OpenSim, one obtains real-time shadows, improved lighting simulation, and more importantly, the OGRE mesh. The mesh is hierarchical (multiple meshes and sub-meshes) and can include a skeleton for defining avatar motion and dynamics.

ModRex is important to the OpenSimulator community mainly because, like the base opensim code base itself, the RealXtend viewer is open source and breaks away from some of the key contraints imposed by the LLviewer, such as inability to create meshes, shadows, realistic avatars, and advanced lighting effects. ModRex while not part of the viewer, is the glue that connects the viewer to the opensim trunk code.

and a to illustrate some of the mesh and lighting effects in the viewer:

To use ModRex, you need the following:

[edit] Links

[edit] Setup

First launch realXtend authentication and avatar storage servers. You can download them from SourceForge project page. Documentation for these servers can be found from realXtend user documentation wiki.

After successfully launching authentication and avatar storage server, build ModreX according to instructions in realXtend wiki. To configure ModreX follow the instructions in this wiki page.

If any bugs occur, please report them to ModreX bug tracker. Note that to run realXtend 0.4 series viewer on Linux, you need to follow these instructions.

[edit] Known Issues

  • Some parts of the LLViewer interface do not yet exist in the RealXtend viewer. This is related to ModRex not allowing the viewer to set or retrieve certain data.
  • Inter-mesh collisions not yet implemented, although avatar w/ primitive collisions work
  • Shift-copied Objects may loose their texture after a sim restart

[edit] Recent Fixes

  • Multiregion Support with RexQueue
  • Multiple standalones on one machine supported
  • NHibernate-db supports mysql, sqlite and mssql2005. Meshes are persistent
  • Mesh collisions with primitives work
  • Python scripting works for the most part (some functions are not working yet)
  • Shift-copy keeps mesh as primdata
  • OpenSimulator library useable now
  • Avatar is stored, but appearance changes only after viewer restart

[edit] See Also

  • Rex_serverscript - Example Linux SysVinit startup scripts for ModRex
  • Rex_mysql - Example MySQL table definitions for ModRex
  • Simxtd - BASH script for building and install OpenSimulator with ModRex and RealXtend support
Retrieved from "http://opensimulator.org/index.php?title=ModRex&oldid=49085"
Personal tools
General
About This Wiki