ModRex

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(Overview)
 
(81 intermediate revisions by 12 users not shown)
Line 1: Line 1:
==Overview==
+
__NOTOC__
ModRex is a joint effort between RealXtend and OpenSim devs to make OpenSim aware of RealXtend specific functionality. It will not only enable the best of both worlds, but also speeds up the development of a solid standard for virtual worlds.
+
{{Quicklinks}}
[[image:modrex.jpg|250px|thumb|right|ModRex with mesh support, running on Linux]]
+
<br />
''This is still pre-alpha code, so some features may not work.''
+
  
==Procedure==
+
== 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
 +
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 [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.
  
===Linux===
+
ModRex is important to the OpenSimulator community mainly because, like the base
mkdir /opt/opensim opt/opensim/simulator /opt/opensim/authentication /opt/opensim/avatarstorage /opt/opensim/builds
+
opensim code base itself, the RealXtend viewer is open source and breaks away
cd /opt/opensim/builds/8218
+
from some of the key contraints imposed by the LLviewer, such as inability to
svn co http://opensimulator.org/svn/opensim/trunk .
+
create meshes, shadows, realistic avatars, and advanced lighting effects. ModRex
sh runprebuild.sh
+
while not part of the viewer, is the glue that connects the viewer to the opensim
nant
+
trunk code.
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
+
* 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
+
and a to illustrate some of the mesh and lighting effects in the viewer:
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)
+
To use ModRex, you need the following:
* Check in the Simulator console if everything started the way it's supposed to
+
* [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]
 +
* [OpenSim-SVN (rev. 8814+)
 +
* [http://www.mono-project.com/Main_Page Mono] (Linux)
 +
* [http://nant.sourceforge.net/ NAnt] (Linux)
  
''Once the three services are running, an initial user was made, fire up the realXtend client from wine and login with your credentials.''
+
== Links ==
 +
* [http://forge.opensimulator.org/gf/project/modrex/ Source Code]
 +
* [http://wiki.realxtend.org/index.php/Features_supported_currently ModRex Features/Status]
 +
* [http://www.realxtend.org Main RealXtend]
 +
* [http://wiki.realxtend.org/ RealXtend community wiki]
  
==Known Quirks==
+
== Setup ==
* Shift-copy a mesh leaves a prim behind
+
* Avatar is stored, but appearance changes only after viewer restart
+
  
==Recent Fixes==
+
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].
* NHibernate-db supports mysql, sqlite and mssql2005. Meshes are persistant
+
 
* Mesh collisions work
+
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].
 +
 
 +
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]].
 +
 
 +
== 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
 +
 
 +
== 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

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