ModRex

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Windows)
(Overview)
 
(43 intermediate revisions by 12 users not shown)
Line 1: Line 1:
==Overview==
+
__NOTOC__
ModRex is a joint effort between RealXtend and OpenSim developers to make it
+
{{Quicklinks}}
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
 
RealXtend as a viewer for OpenSim, one obtains real-time shadows, improved
 
RealXtend as a viewer for OpenSim, one obtains real-time shadows, improved
lighting simulation, and more importantly, the OGRE mesh. The mesh is hierarchical
+
lighting simulation, and more importantly, the [http://www.youtube.com/watch?v=yEXqiv2_kbE&feature=channel_page OGRE mesh]. The mesh is hierarchical
 
(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 16: Line 21:
 
trunk code.
 
trunk code.
  
Here is an image built from using Opensim+ModReX [[image:modrex.jpg|250px|thumb|left|ModRex with mesh support, running on Linux]] and a [http://www.youtube.com/watch?v=yEXqiv2_kbE&feature=channel_page movie] 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: (1) The RealXtend viewer, (2) ModRex, and (3) OpenSim.
+
To use ModRex, you need the following:  
The viewer (1) is downloaded from [http://www.realxtend.org/page.php?pg=downloads here]. Make sure to download the latest viewer and any patches that have been added since that viewer version. They should be located on in the sourceforge page. For Windows, the viewer is run
+
* [http://realxtend.org/download/ RealXtend viewer (CodeName: Tundra)]
directly as an .exe, and for Linux, wine is used to launch the viewer. OpenSim (3) is
+
* Alternatively you can also use the new [http://wiki.realxtend.org/index.php/Getting_Started_with_Naali Naali viewer]
compiled as instructed elsewhere in this wiki (Get OpenSim and Building). The setup
+
* [http://forge.opensimulator.org/gf/project/modrex/ ModRex]
for ModRex is documented below for Windows and Linux.
+
* [OpenSim-SVN (rev. 8814+)
 +
* [http://www.mono-project.com/Main_Page Mono] (Linux)
 +
* [http://nant.sourceforge.net/ NAnt] (Linux)
  
 
+
== Links ==
 
+
 
+
 
+
 
+
 
+
 
+
Key areas on the web where modrex and RealXtend functionality is documented:
+
 
* [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===
+
mkdir /opt/opensim opt/opensim/simulator /opt/opensim/authentication /opt/opensim/avatarstorage /opt/opensim/builds
+
cd /opt/opensim/builds/8218
+
svn co http://opensimulator.org/svn/opensim/trunk .
+
sh runprebuild.sh
+
nant
+
mkdir modrex modrex/build
+
cp -R bin/*.dll modrex/build
+
cd modrex
+
svn checkout http://forge.opensimulator.org/svn/modrex/trunk .
+
cd ModularRex
+
vi prebuild.xml
+
* Change each ../../../bin to ../../build, and each ../../bin to ../build, save and exit
+
mono ../../bin/Prebuild.exe /target monodev
+
* Open /opt/opensim/builds/8218/OpenSim.sln with MonoDevelop
+
* Add existing project > modrex/ModularRex/RexFramework/ModularRex.RexFramework.mdp
+
* Add existing project > modrex/ModularRex/NHibernate/ModularRex.NHibernate.mdp
+
* Add existing project > modrex/ModularRex/RexOdePlugin/ModularRex.RexOdePlugin.mdp
+
* Add existing project > modrex/ModularRex/ModularRex.mdp
+
* Change the runtime version for these projects to mono 3.5
+
* Replace the broken OpenSim reference in the ModularRex project with the equally named OpenSim project
+
* Replace the broken OpenSim.Region.Physics.Meshing and OpenSim.Region.Physics.OdePlugin references in the RexOdePlugin project with the equally named OpenSim projects
+
* Build the modularRex projects. If no errors occured, The dll's are stored in /opt/opensim/builds/8218/modrex/build
+
cp /opt/opensim/builds/8218/modrex/build/ModularRex.* /opt/opensim/builds/8218/bin
+
* Copy python-engine dependencies
+
  cp -R /opt/opensim/builds/8218/modrex/ModularRex/RexParts/RexPython/Resources/* /opt/opensim/builds/8218/bin/ScriptEngines
+
cd /opt/opensim/builds/8218/bin
+
cp OpenSim.ini.example OpenSim.ini
+
* edit OpenSim.ini, and add this:
+
;This goes under [startup]
+
rex_python = true
+
[realXtend]
+
enabled = true
+
db_connectionstring = "MySQLDialect;MySqlDataDriver;Data Source=localhost;Database=opensim;User ID=root;Password=mypw;"
+
* Copy the modrex enabled OpenSimulator to the production dir
+
cp -R /opt/opensim/builds/8218/* /opt/opensim/simulator
+
* Add the [[rex mysql]] tables to the opensim database
+
* 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"
+
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
+
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].
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
+
* Create a database "avatarstorage"
+
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)
+
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)
+
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].
* 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 wine and login with your credentials.''
+
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]].
  
===Windows===
+
== Known Issues ==
The following procedure is used to set up modrex:
+
* 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.
 
+
* 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"
+
</pre>
+
* 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
+
* 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. Move the region modules back to continue with the RealXtend viewer. Note that RealXtend-specific artifacts (mesh, shadows) will not appear in LLviewer.
+
 
+
==Known Quirks==
+
* Important: only one region is currently supported. If your opensim has more than one region, you will not be able to visit regions other than home
+
* Avatar is stored, but appearance changes only after viewer restart
+
 
* Inter-mesh collisions not yet implemented, although avatar w/ primitive collisions work
 
* Inter-mesh collisions not yet implemented, although avatar w/ primitive collisions work
* Scripts must be entered into Inventory and copied to the prim. In-world editing in the prim's contents doesn't save script.
+
* Shift-copied Objects may loose their texture after a sim restart
  
==Recent Fixes==
+
== Recent Fixes ==
* NHibernate-db supports mysql, sqlite and mssql2005. Meshes are persistant
+
* 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
 
* Mesh collisions with primitives work
* Python scripting works
+
* 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

Latest revision as of 12:31, 13 August 2012


[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
Personal tools
General
About This Wiki