http://opensimulator.org/api.php?action=feedcontributions&feedformat=atom&user=RtkwebmanOpenSimulator - User contributions [en]2026-04-21T12:07:06ZUser contributionsMediaWiki 1.19.9http://opensimulator.org/wiki/Automated_TestingAutomated Testing2009-03-05T03:36:59Z<p>Rtkwebman: </p>
<hr />
<div>As OpenSim matures, we are extremely interested in adding more automated verification into the OpenSim source tree. Test exist not only to prevent bugs from creeping in, but also to provide fair warning that the behavior of the system has changed, and tests may need updating.<br />
<br />
In OpenSim today we use NUnit tests. Our conventions are:<br />
# Tests should '''not''' exist inside runtime assemblies, as this makes nunit a production requirement<br />
# Tests should be in .Tests.dll assemblies. For instance, the tests for OpenSim.Data.SQLite.dll should be in the OpenSim.Data.SQLite.Tests.dll assembly. This allows for easy removal of test assemblies in products.<br />
# Tests should be as close to the code as possible, but not intermingled. So the tests for OpenSim/Data/SQLite should be in OpenSim/Data/SQLite/Tests/. Through the use of the '''Exclude''' keyword in prebuild.xml you can ensure that directory is part of OpenSim.Data.SQLite.Tests.dll and not OpenSim.Data.SQLite.dll. See exclude clarification in writing unit tests section.<br />
# Tests testing a class should be grouped into a test class file called xxxTest.cs, where xxx is the name of the class that is being tested.<br />
# Tests should be able to run safely in a production environment. That means that care must be taken not to damage data on the machine that it is being run.<br />
# Tests should be deterministic in other words repeatable. Avoid randomness in tests. See good and bad testing practices below.<br />
<br />
== Core Functionality Missing Unit Tests ==<br />
<br />
This is a list of functionality which is not covered by unit tests and is identified as highly desireable test target:<br />
<br />
# Database Modules (These are mysql tables)<br />
## region ban<br />
## land<br />
## landaccesslist<br />
<br />
== Good / Bad Test practices ==<br />
Creating good tests is an art, not a science. Tests are useful by how many bugs they find or how many bugs they avoid. Things you should think about in creating good tests is:<br />
* Throwing edge cases, like 0, "", or Null at parameters. This ensures that people functions are hardened against incomplete data. Many of our crashes come from the lack of this hardening showing up at just the wrong time.<br />
* Use stateful testing to build up complex scenarios. This is more useful than just cursory get / set calls.<br />
* Random tests are not a good idea. We need test results to be deterministic. In other words tests need to be repeatable. If you want to test for a range it is good idea to make separate tests for min and max values. Random values in fields can fail randomly. When something goes wrong for example in database schema the developer will not necessarily notice if the stored values are random. On the other hand its hard to troubleshoot randomly failing tests as you dont know which specific value caused the failure.<br />
<br />
== Writing Tests ==<br />
Writing a new unit test is pretty easy, and very helpful in increasing the stability of opensim by nailing down bugs. I'm going to present an example here of SQLite Asset testing to show how simple such a test case is to write. The actual in tree SQLite Asset tests are a little different because the code was factored out so that it was easily applied to any database driver, so don't be concerned with the fact that what you see here isn't in the tree.<br />
<br />
Exclude clarification: Make sure your master project (not the test project) has an entry for files like the following so that the test code is not included in the master project dll:<br />
<br />
<pre><br />
<Files><br />
<Match pattern="*.cs" recurse="true"><br />
<Exclude name="Tests" pattern="Tests" /><br />
</Match><br />
</Files><br />
</pre><br />
<br />
=== NUnit Conventions ===<br />
An NUnit test suite:<br />
* is a class with a default constructor (takes no arguments)<br />
* has public methods that are tests<br />
* uses annotations to determine what are tests<br />
* runs it's tests in '''alphabetical order by method name'''<br />
<br />
An NUnit test method:<br />
* must be public<br />
* must return void<br />
* must take no arguments<br />
* is successful if no exception or assert is thrown while running it<br />
<br />
The run order is important if you want to have early tests that setup some complicated state (like creating objects), and have later tests remove or update that state. For that reason I find it very helpful to name all test methods '''Txxx_somename''' where '''xxx''' is a number between 000 and 999. That guaruntees no surprises in run order.<br />
<br />
==== Setup / Teardown ====<br />
In the case of testing something like the database layer, we have to actually attempt to store / retrieve things from a database. Following from rule #4 of good tests, we want to make sure not to touch the production databases to run our tests, so during startup we generate a temporary file name which is guaranteed not to be an existing file on the system, and use that as our database file name. By running db.Initialize() the OpenSim migration code will correctly populate that database with the latest schema.<br />
<br />
Once we are done with the tests we want to make sure we aren't leaving garbage temp files on the user's system. So we remove that file we created.<br />
<br />
During setup we also create a set of state variables, such as 3 uuids, 3 strings, and a data block. You could have always just stuck these inline, but variables are there for a reason, so use them.<br />
<br />
==== Asserts ====<br />
You will see scattered through the code '''Assert.That(...)'''. These will throw an exception if the condition is not valid. This format of assertions is called the [http://www.nunit.org/index.php?p=constraintModel&r=2.4 Contraint Model] in NUnit, and provides a large number of tests with the flavor of:<br />
* Assert.That(foo, Is.Null)<br />
* Assert.That(foo, Is.Not.Null)<br />
* Assert.That(foo, Is.True)<br />
* Assert.That(foo, Is.EqualTo(bar))<br />
* Assert.That(foo, Text.Matches( "*bar*" ))<br />
<br />
Of note, Is.EqualTo uses the Equals function of foo, so this can only be used on objects that are IComparable. Most of the OpenSim base objects are not, so you'll have to compare fields manually in tests.<br />
<br />
For the complete set of conditions you can use see [http://www.nunit.org/index.php?p=constraintModel&r=2.4 the Contraint Model NUnit documentation]. While there is another syntax for tests, the Constraint Model is preferred as it is far more human readable.<br />
<br />
=== Simple Negative Tests ===<br />
Test T001 is an example of a simple negative test. We assume a new database will not have any of those assets in them. While the value of this test may look low, it does provide a baseline in ensuring that the database connection is there, that these return false correctly, and that no other exception is thrown. Negative tests are a good way to force bounds conditions and ensure that not only does it ''return what you expect'' it also ''doesn't return what you don't expect''. Thought of another way, it ensures your code is somewhat defensive in nature, not coughing on bad or unexpected data.<br />
<br />
=== Simple Positive Tests ===<br />
T010 is an example of a simple positive test. In it we create and store 3 assets (ensuring no exceptions), then load those 3 assets back from the database and ensure the fields are correct. Because AssetBase is not IComparible we just check the ID and Name fields with equals tests. If any of the Asserts fail, the whole test fails.<br />
<br />
=== Stateful Tests ===<br />
T011 is an example of a stateful test, because it requires the state created by T010 (i.e. the creation of those 3 objects). In order to test any kind of complicated scenario you will find that you need to use stateful tests to build up various amounts of state (testing along the way), then manipulating and possibly tearing it down. Without doing this you can't do truly deep testing of function in any complex environment. This example isn't very stateful (I tried to pick an easy example), but it should give you some ideas.<br />
<br />
=== Speculative Tests ===<br />
Speculative tests are tests that might or might not apply in a given situation. MySQL testing in the OpenSim tree is done by speculative testing, the tests will only run if there is a properly configured database, otherwise they will not be run. If you execute '''Assert.Ignore()''' in a '''Test''' the test will end and be ignored. If you run '''Assert.Ignore()''' in the '''TestFixtureSetup''' all tests in the test fixture will be skipped and ignored.<br />
<br />
Speculative testing lets you create tests that require certain preconditions to be met which you can't guarantee on all platforms/configuration, and are an important part of deep testing.<br />
<br />
=== An Example Test - SQLite Assets ===<br />
<source lang="csharp"><br />
using System;<br />
using System.IO;<br />
using System.Collections.Generic;<br />
using NUnit.Framework;<br />
using NUnit.Framework.SyntaxHelpers;<br />
using OpenSim.Framework;<br />
using OpenSim.Data.Tests;<br />
using OpenSim.Data.SQLite;<br />
using OpenSim.Region.Environment.Scenes;<br />
using OpenMetaverse;<br />
<br />
namespace OpenSim.Data.SQLite.Tests<br />
{<br />
[TestFixture]<br />
public class SQLiteAssetTest<br />
{<br />
public string file;<br />
public string connect;<br />
public AssetDataBase db;<br />
public UUID uuid1;<br />
public UUID uuid2;<br />
public UUID uuid3;<br />
public string name1;<br />
public string name2;<br />
public string name3;<br />
public byte[] asset1;<br />
<br />
[TestFixtureSetUp]<br />
public void Init()<br />
{<br />
uuid1 = UUID.Random();<br />
uuid2 = UUID.Random();<br />
uuid3 = UUID.Random();<br />
name1 = "asset one";<br />
name2 = "asset two";<br />
name3 = "asset three";<br />
<br />
asset1 = new byte[100];<br />
asset1.Initialize();<br />
file = Path.GetTempFileName() + ".db";<br />
connect = "URI=file:" + file + ",version=3";<br />
db = new SQLiteAssetData();<br />
db.Initialise(connect);<br />
}<br />
<br />
[TestFixtureTearDown]<br />
public void Cleanup()<br />
{<br />
db.Dispose();<br />
System.IO.File.Delete(file);<br />
}<br />
<br />
[Test]<br />
public void T001_LoadEmpty()<br />
{<br />
Assert.That(db.ExistsAsset(uuid1), Is.False);<br />
Assert.That(db.ExistsAsset(uuid2), Is.False);<br />
Assert.That(db.ExistsAsset(uuid3), Is.False);<br />
}<br />
<br />
[Test]<br />
public void T010_StoreSimpleAsset()<br />
{<br />
AssetBase a1 = new AssetBase(uuid1, name1);<br />
AssetBase a2 = new AssetBase(uuid2, name2);<br />
AssetBase a3 = new AssetBase(uuid3, name3);<br />
a1.Data = asset1;<br />
a2.Data = asset1;<br />
a3.Data = asset1;<br />
<br />
db.CreateAsset(a1);<br />
db.CreateAsset(a2);<br />
db.CreateAsset(a3);<br />
<br />
AssetBase a1a = db.FetchAsset(uuid1);<br />
Assert.That(a1a.ID, Is.EqualTo(uuid1));<br />
Assert.That(a1a.Name, Is.EqualTo(name1));<br />
<br />
AssetBase a2a = db.FetchAsset(uuid2);<br />
Assert.That(a2a.ID, Is.EqualTo(uuid2));<br />
Assert.That(a2a.Name, Is.EqualTo(name2));<br />
<br />
AssetBase a3a = db.FetchAsset(uuid3);<br />
Assert.That(a3a.ID, Is.EqualTo(uuid3));<br />
Assert.That(a3a.Name, Is.EqualTo(name3));<br />
}<br />
<br />
[Test]<br />
public void T011_ExistsSimpleAsset()<br />
{<br />
Assert.That(db.ExistsAsset(uuid1), Is.True);<br />
Assert.That(db.ExistsAsset(uuid2), Is.True);<br />
Assert.That(db.ExistsAsset(uuid3), Is.True);<br />
}<br />
}<br />
}<br />
</source><br />
<br />
You can see 4 of the important annotations here:<br />
* TestFixture - this class is a test suite<br />
* TestFixtureSetup - this code is always run before any of the tests are executed<br />
* TestFixtureTearDown - this code is always run after the tests are done executing, even if they fail.<br />
* Test - this method is a test<br />
<br />
== Adding Tests to the Tree ==<br />
As we said previously all tests for assembly OpenSim.Foo (in directory OpenSim/Foo) should:<br />
* be in assembly OpenSim.Foo.Tests.dll<br />
* not be in the OpenSim.Foo.dll assembly<br />
* be in OpenSim/Foo/Tests directory<br />
<br />
Also, if you have created a new test assembly you must add references to it in both ''.nant/local.include'' and ''.nant/bamboo.build'' to ensure that the assembly is added to the automated bamboo runs as well as the nant test target.<br />
<br />
== Executing Tests ==<br />
<br />
=== Bamboo ===<br />
On every commit to opensim all the tests are run on a [http://opensimulator.org:8085 Bamboo build server on opensimulator.org]. The process takes about 5 minutes to build, test, and report the results back out on #opensim-dev via the osmantis bot.<br />
<br />
=== Nant ===<br />
You can manually run all the tests for OpenSim on your system by running '''nant test''' as a nant target. This will run all the tests that are in the tree, though some speculative tests might be ignored if your platform does not have the right features or configuration to run these tests.<br />
<br />
=== NUnit Console ===<br />
If you only want to run tests for one assembly you can do that using the NUnit Console. On Linux just run '''nunit-console2 OpenSim.Foo.Tests.dll''' and it will run only the tests for OpenSim.Foo.Tests.dll. If you are only making changes to 1 dll and just want a quick sanity check, this is the fastest way to do that.<br />
<br />
=== Debugging Tests ===<br />
There is a special page dedicated to this. See [[Debugging Unit Tests]].<br />
<br />
== Learning More ==<br />
You should definitely read the documentation at the [http://www.nunit.org/index.php?p=documentation NUnit homepage] if you want to know more about testing. It's a very good reference for all the APIs in NUnit that you can use for creating tests.<br />
<br />
== Code Coverage ==<br />
<br />
A prototype has been included using monocov, which has a profile built-in in mono. Instructions for using monocov can be found on the Mono homepage, in [http://www.mono-project.com/Code_Coverage Code Coverage] section. Unfortunately nunit2 and nant do not support code coverage with monocov (only some other proprietary code coverages), so there is no <monocov> tag. The solution was to implement it using many nunit-console and on <exec> tags. <br />
<br />
ATTENTION: Code coverage only works with mono 1.2.x , any other version will most likely not work. Code coverage development is being put on hold for now until it supports newer mono versions.<br />
<br />
=== Running ===<br />
<br />
Download [http://primates.ximian.com/~lupus/monocov-0.2.tar.gz monocov] and [http://prdownloads.sourceforge.net/nunit/NUnit-2.4.8-net-2.0.zip?download nunit-console] if your nunit-console does not work. To test if it works (my Ubuntu's Hardy version did not), just run one of the tests with nunit-console.<br />
<br />
Install monocov (./configure, ./make install, there could be some minor conflicts, I had to add to the compiling line -I/usr/include/mono-1.0/) and make sure the working nunit-console.exe is in /usr/lib/nunit/nunit-console.exe. Now just run nant test-cov and it will generate .cov files and HTML directories in the cov directory. The .cov files can be seen by running monocov on them, and have the same information as the HTML directories.<br />
<br />
== Testing Todo ==<br />
<br />
=== Coverage ===<br />
<br />
A prototype has been done and documented. Now we must keep a look if monocov will evolve to support newer mono versions.<br />
<br />
[[Category:Development]]<br />
[[Category:Testing]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Manual_Test_ScriptManual Test Script2009-03-05T03:35:06Z<p>Rtkwebman: New page: The need for testing is great so let's participate! Need a table here with columns for Step Number, Task, Result, etc... Category:Testing</p>
<hr />
<div>The need for testing is great so let's participate!<br />
<br />
Need a table here with columns for Step Number, Task, Result, etc...<br />
<br />
<br />
[[Category:Testing]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Category:TestingCategory:Testing2009-03-05T03:24:56Z<p>Rtkwebman: New page: As OpenSim matures the need for proper testing increases too. Please take the time to place your ideas and concepts for improving the OpenSim Testing program in this category. Scripts both...</p>
<hr />
<div>As OpenSim matures the need for proper testing increases too. Please take the time to place your ideas and concepts for improving the OpenSim Testing program in this category. Scripts both manual and automated are welcome!</div>Rtkwebmanhttp://opensimulator.org/wiki/Hypergrid_MeetingsHypergrid Meetings2009-02-13T19:40:36Z<p>Rtkwebman: </p>
<hr />
<div>* [[HG Meeting 2009/02/06]]<br />
<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Hypergrid_ListsHypergrid Lists2009-02-13T19:40:07Z<p>Rtkwebman: </p>
<hr />
<div>== Hypergrid Lists ==<br />
<br />
Draft 1:<br />
<br />
A new feature for hypergrids that is currently being worked on, is support for shared online lists of hypergrid links. So there could be various lists of a set of hypergrid enabled regions that all share a similar theme. And hopefully a lot of these lists will enable a user to add their own region data to that list.<br />
<br />
Basically these lists will be a xml file, listing all the regions and the relevant data required for a hypergrid link; like their hostName and port number. Each region will also have a assigned "virtual location" within a 0,0 - 99,99 map area (the size of this area could change at a later data).<br />
<br />
A user can then tell their own hypergrid enabled region to load that hypergrid list, by telling it the url of that list. <br />
<br />
They user will also need to tell their own region how to deal with the location of those regions. So you can define a Hypergrid area, that is 99,99 region spaces in size, anywhere on your region's map. And then as your region loads that list, it will translate the link locations from the list (those assigned positions within that 0,0-99,99 area) into that hypergrid area. So if you had set the hypergrid area to start at location 2200, 2200. Then the link for the region that had a assigned list position of 2,2, will appear at 2202,2202 on your map.<br />
<br />
The following image (not to scale) gives a basic overview, the regions on your home grid are the green squares and the orange area is the hypergrid area that you want the hypergrid regions to be in. <br />
<br />
[[Image:HyperGrid-Area.png]]<br />
<br />
<br />
The StartXLoc,StartYloc are the coordinates for the start of the hypergrid area that you need to set.<br />
<br />
So there are two things that need to be done to load such a list. <br />
<br />
First set the Start location for that hypergrid area using the console command: link-mapping <startXloc> <startYloc> <br />
<br />
So for our example it would be: link-mapping 2200 2200<br />
<br />
Next the region needs to be told to load the list by providing it with the url, using the console command : link-region <url> [excludeList]<br />
<br />
That would result in the region fetching that xml file and creating all the links for the regions in that list. <br />
<br />
<br />
----<br />
<br />
However there are currently two problems with this.<br />
<br />
The first being that if the details for your own region was in that list, it would try to create a link to itself. So this is where the excludeList parameter (mentioned above ) comes in.<br />
<br />
The details for each region in a list includes a "Section Name" which can be anything as long as it has no spaces and each region has a unique one. This is the name that you need to include in the excludelist, so that you region knows to ignore that data. <br />
<br />
So if my region had a section name of "Hyper-Gateway1" in the list, I would need to use the command: link-region <url of list> excludeList:Hyper-Gateway1<br />
<br />
How the section names are actually set will depend on how and where the list is hosted. And as there are no such lists at the time of writing, its not possible to give instructions on how to find that name. But hopefully each list will have some instructions on either setting your own section name or how to find it if they assign one for you.<br />
<br />
The second problem is that due to a bug in the viewer, teleports can only happen between regions that are within 4096,4096 map spaces of each other. As you should know from reading the rest of this page, Hypergrid regions have two map locations, their real location where they are on their home region. And the "virtual map location" somewhere within your hypergrid area, which is really just a local link to the real location. <br />
<br />
For this bug, its the real location that matters. So when trying to teleport to a hypergrid region, there can't be more than a 4096,4096 difference between the location that you are currently on and the real location of the hypergrid region.<br />
<br />
To get around this, the list can include details of a region's real location. And then currently when a list is loaded, your region will check that this real location is within the 4096,4096 range of its potential "virtual map location". If it is outside that limit, then no link will be created for that region. <br />
<br />
This is all done automatically so there is nothing the user has to do.<br />
<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Public_Hypergrid_NodesPublic Hypergrid Nodes2009-02-13T19:39:28Z<p>Rtkwebman: </p>
<hr />
<div>The following is a list of hypergrid-ready nodes that you can use for testing your installation and for linking your world. Please add your public node here if you wish to help build a web of opensims!<br />
<br />
For the time being, and until the security concerns are addressed, we advise you to be careful about who you link to. <br />
<br />
<br />
{| border="1" cellpadding="5" cellspacing="0" align="center"<br />
![[Hypergrid|link-region server and port]]<br />
!Organization<br />
!Description<br />
!Grid Location<br />
|-<br />
|'''osl2.nac.uci.edu 9006'''<br />
|University of California, Irvine<br />
|The "UCI Welcome" region connected to OSGrid. It is run by Diva (Crista Lopes) on a machine owned by the University of California, Irvine. You can link to it as a way to link to OSGrid.<br />
|OSGrid is centered at 10,000, 10,000<br />
<br />
|-<br />
|'''osl3.nac.uci.edu 9000'''<br />
|University of California, Irvine<br />
|The "UC Irvine" region connected to OSGrid, neighboring Wright Plaza. You can link to it as a way to link to OSGrid.<br />
|OSGrid is centered at 10,000, 10,000<br />
<br />
|-<br />
|'''ucigrid02.nacs.uci.edu 9000'''<br />
|University of California, Irvine<br />
|The UCI Grid<br />
|UCIGrid is centered at 8,888, 8,888<br />
<br />
|-<br />
|'''ucigrid04.nacs.uci.edu 9003'''<br />
|University of California, Irvine<br />
|The UCI Grid, region "Gateway 3000". Link your lower-1,000's grid to this node in order to bridge to grids in the 10,000's.<br />
|This node is positioned at 3,000, 3,000<br />
<br />
|-<br />
|'''ucigrid04.nacs.uci.edu 9007'''<br />
|University of California, Irvine<br />
|The UCI Grid, region "Gateway 7000". Link your 10,000's grid to this node in order to bridge to grids in the lower-1,000's.<br />
|This node is positioned at 7,000, 7,000. <br />
<br />
<br />
|-<br />
|'''grid.cyberlandia.net 9000'''<br />
|Cyberlandia<br />
|The "Cyberlandia Gw" region. http://www.cyberlandia.net Metaverso italiano 3D, more to 250 region and 1000 users. You can link to it as a way to link to Cyberlandia. <br />
|Cyberlandia is centered at ???<br />
<br />
|-<br />
|'''hypergrid.cyberlandia.net 9000'''<br />
|Cyberlandia <br />
|The "Osgrid Gw" region connected to Cyberlandia grid http://www.cyberlandia.net. Search on map "Cyberlandia grid" You can link to it as a way to link to OSGrid. <br />
|OSGrid is centered at 10,000, 10,000<br />
<br />
|-<br />
|'''regionsde.ralf-haifisch.biz 9000'''<br />
|Ralf Haifisch on osgrid<br />
|The "Sharkland Tropical" region connected to OSGrid. German welcome aerea, Freebie aerea, region rental, pretty tropical regions <br />
|Centered at 10000,10000<br />
<br />
<br />
|-<br />
|'''joomla-italia.net 9000'''<br />
|Social Network Italia<br />
|The "SNI City" region connected to SNI (Social Network Italia) grid http://www.opensim-italia.net. This grid is connected with Osgrid,Collateral World,Francogrid and Darwin <br />
|Centered at ???<br />
<br />
|-<br />
|'''collateral.opensim-italia.net 9000'''<br />
|Part of Social Network Italia<br />
|Collateral World <br />
|Centered at ???<br />
<br />
|-<br />
|'''88.191.79.199 9050'''<br />
|Francogrid<br />
|Francogrid node, connected to "City", behind the welcome land of Francogrid "Orion" <br />
|Centered at 1000 1000<br />
<br />
|-<br />
|'''94.23.8.158 9999'''<br />
|Le Monde de Darwin<br />
|The Lost World of Darwin http://www.LeMondedeDarwin.com. [[Image:hypergrid.jpg|200px]]<br />
|Centered at ???<br />
<br />
|-<br />
|'''sg.k-grid.com 9000'''<br />
|K-Grid<br />
|The Kool grid for the Kool KidZ . Feel free to visit us. The main Gateway is located at 3700,3700 so take that in account before any HyperJump. Adress updated 02/07/09 <br />
|This node is located at 3700,3700 <br />
<br />
|-<br />
|'''metropolis.hypergrid.org 9000'''<br />
|METROPOLIS-Grid<br />
|The Region "Center-World" connected to the METROPOLIS-Grid http://metropolis.hypergrid.org . German Grid with a lot of free Content and free SIM-hosting. Connected via HG to the most of the Grids listed here <br />
|Centered at 6000,6000<br />
<br />
|-<br />
|'''ascent.bluewallgroup.com 9910'''<br />
|BlueWall Group<br />
|This region is in a good proximity @ (6000,6000) for intermediate jumps to OSGrid from grids in the (2000,2000) range, or any region within 4096 units. [[Image:Hypernaut 001.png|150px|none|thumb|Get your Hypernaut here :)]]<br />
|Centered at 6000,6000<br />
<br />
|-<br />
|'''sim.thestudyofracialism.org 9000'''<br />
|Backintyme Publishing<br />
|TSOR1 is a stand-alone sim owned by Backintyme Publishing. It connects to most of the other downrange sites listed here. The sim is intended for an SL study/discussion group's eventual migration from SL to OS.<br />
|Centered at 4000,4000<br />
<br />
|-<br />
|'''pc.backintyme.com 9100'''<br />
|Backintyme Publishing<br />
|TSOR2 is a small teleport relay island, also owned by Backintyme Publishing, intended for jumps to the vicinity of OSGrid. It is linked to most of the uprange sites listed here.<br />
|Centered at 8000,8000<br />
<br />
|-<br />
|'''24.248.172.208 9005'''<br />
|'''MyOpenGrid'''<br />
|Myopengrid is connected to osl2.nac.uci.edu "Osgrid Gateway" and 88.191.79.199 9050 "Franco Grid"<br />
|Centered at 7000,7000<br />
<br />
|-<br />
|'''cuonsim1.de 9300'''<br />
|Cuon-Grid<br />
|Cuon-Grid is a little grid and has some Main Sims with linux themes, server are in Germany. To login in to the grid use this http://sim-linuxmain.org:8081/CuonGrid/index.html. There are free sims for testing. <br />
|Centered at 10,000, 10,000<br />
<br />
|-<br />
|'''metaversesims.net 9000'''<br />
|Metaverse Sims<br />
|Standalone mode - 6 regions - linked to several other grids. [[Image:Mtvs09010101.jpg|200px]]<br />
|Centered at 9000, 9000<br />
<br />
<br />
|-<br />
|'''ellis.pseudospace.net 9000'''<br />
|Pseudospace Central Gateway & Welcome Center <br />
|Pseudospace is a free to play, public access OpenSimulator grid created to provide role players with an immersive environment by which they may play, socialize, and build within. This is a mature grid which may contain adult content and situations, only those who are 18 or older may enter.<br />
<br />
Please be advised, that we are currently under heavy construction. Feel free to look around, but mind the mess and the occasional flying prims! If you have any questions or concerns please feel free to email john(at)pseudospace(dot)net.<br />
<br />
<br />
All user content such as skins, attachments, textures, etc. are provided for free using a share and share alike, create for the sake of creativity methodology. All such assets are kept within the content library on Ellis Island and are freely copyable / distributable unless the "No Transfer" option is enabled which simply means that the asset may not be copied off of the grid. Individual contributions to the grid's content library are greatly welcomed and may be done so by leaving a copyable box containing your contribution on one of the shelves located inside the Ellis Library.<br />
<br />
| 9000 9000<br />
|-<br />
<br />
|-<br />
|'''ellis.pseudospace.net 9009'''<br />
|Pseudospace Lost Gateway <br />
|Gateway on Pseudospace grid for regions within the 5000x5000 range. - See above description for grid info.<br />
| 5000 5000<br />
|-<br />
<br />
|-<br />
<br />
|'''grid4us.net 9020'''<br />
|Grid4Us<br />
|German Grid that is linked to OSGrid and Francogrid.<br />
|Centered at 8500,8500<br />
<br />
<br />
|-<br />
|'''87.230.89.74 9000 '''<br />
|SCHWARZE WELT<br />
| inworld location of www.schwarze-welle.de , the maybe biggest dark music streaming readio<br />
| 100000 10000<br />
<br />
<br />
|-<br />
|'''peak.sciencesim.com 9001'''<br />
|ScienceSim<br />
|[http://www.sciencesim.com/ ScienceSim] is a virtual world created for the high performance computing community for scientific visualizations, a number of interesting real world terrains (Mt St Helens and Yellowstone Park) and some astronomical simulations. And some useful, BSD-licensed content.<br />
| Centered at 10000,10000<br />
<br />
|-<br />
|'''meanduland.com 9124'''<br />
|Meanduland<br />
|[http://www.meanduland.com] is a residentual only sim offering beautiful regions with low lag and friendly neighbors. Located on the hypergrid to allow easy access to OSGrid. Links to the most popular OS grids available in our Welcome Island. This grid is up 24/7 and all are welcome to drop in and and look around. If you have trouble connecting, please contact Frank Northmead or Ayana Northmead and let us know so we can help fix the problem.<br />
| Centered at 8000,8000<br />
<br />
|-<br />
|'''alpha.bubblecloud.org 9000'''<br />
|Bubble Cloud<br />
|The alpha 00 is the entrance area to bubble cloud grid. Bubble cloud is test grid where anyone can experiment. If you build something please do it in medieval fantasy setting for others to enjoy.<br />
|Centered at 10,000, 10,000<br />
<br />
|-<br />
|'''opensim.mydyn.de 9090'''<br />
|OpenSIM.de<br />
|[http://www.opensim.de OpenSim.de], 2 Server (Linux/Windows), hypergrided standalones, 16 Regions, German Users (Deutsche Benutzer), Live-Support, IRC-Gateway, Wiki, FAQ, Howto´s, Downloads. Connected to most of the Grids and some hypergrided standalones.<br />
|Centered at 1000,1000<br />
|}<br />
<br />
<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/HypergridHypergrid2009-02-13T19:35:24Z<p>Rtkwebman: /* Hyperlinks and Agent Transfers */</p>
<hr />
<div>==The OpenSim Hypergrid==<br />
<br />
<br />
=== What is the hypergrid? ===<br />
<!-- [[image:VWV.jpg|250px|thumb|Web of Virtual Worlds]] --><br />
<br />
The hypergrid is an extension to opensim that allows you to link your opensim to other opensims on the internet, and that supports seamless agent transfers among those opensims. It can be used both in standalone mode and in grid mode. The hypergrid is effectively supporting the emergence of a Web of virtual worlds. <br />
<br />
The basic idea for the hypergrid is that region/grid administrations can place hyperlinks on their map to hypergrided regions run by others. Once those hyperlinks are established, users interact with those regions in exactly the same way as they interact with local regions. Specifically, users can choose to teleport there. Once the user reaches the region behind the hyperlink, she is automatically interacting with a different virtual world without having to logout from the world where she came from, and while still having access to her inventory.<br />
<br />
The hypergrid started as a GForge project, but it is now included in the standard distribution of OpenSim. To run your OpenSim instance in hypergrid mode, please see [[Installing_and_Running_Hypergrid|Installing and Running]].<br />
<br />
=== Virtual World Hyperlinks ===<br />
[[image:hghyperlink.jpg|250px|thumb|A Virtual World Hyperlink]]<br />
<br />
We're all familiar with hypertext links on the Web. But what is a virtual world hyperlink?<br />
<br />
In the hypergrid model, we consider the 2D map of the virtual world as the equivalent of a web page. As such, a VW hyperlink is simply a region on that map. <br />
<br />
The default model of opensim-based virtual worlds already supports this concept of hyperlink, to some extent. When you teleport from one region to another via the map, chances are you are migrating your agent into a different opensim server. This migration is a glorified "agent transfer" that also exists, in rudimentary form, on the web when hypertext links are followed. The default model, however, imposes two very strong constraints on these hyperlinks: <br />
# The entire map of regions is controlled by a central service known as the grid service, whose job is to provide a uniform view of the world to all of its regions.<br />
# The only agents that can be transferred are those pertaining to users known to another central service, the user service; if the incoming user is not on that service's database, the agent transfer doesn't go through.<br />
<br />
The hypergrid simply removes these two constraints. <br />
<br />
First, it allows individual opensim instances to add "neighbors" to their local map, shifting the control of the map down from the grid server to individual opensim instances (although hyperlinks can also be served by grid servers if grid admins so wish). In doing so, the world becomes a lot more interesting and varied. The map that you see in one opensim instance may be completely different from the map that you see after you teleport via an hyperlink. As an opensim administrator, you are free to define what other opensims you want to see on your map.<br />
<br />
Second, it allows the transfer of agents pertaining to foreigner users, i.e. users who are registered elsewhere. Instead of assuming one central user service, the hypergrid assumes an arbitrarily large number of such services distributed all over the world. As such, when agents are transferred among hypergrided opensims, a lot more information is passed about the corresponding user. That information includes the collection of servers that the transferring user needs.<br />
<br />
=== Usage Scenarios ===<br />
<br />
The following are some usage scenarios. There isn't a clear separation between these scenarios, there's a large overlap between them. This is also not an exhaustive list. The purpose of these descriptions is to give you some starting ideas for how to use the hypergrid in practice. Please feel free to add other interesting scenarios to this list.<br />
<br />
{| {{Prettytable}}<br />
|-<br />
|<br />
[[image:topoA.jpg|400px|left]]<br />
|<br />
'''Personal Worlds'''<br />
<br />
This first scenario pertains to standalone opensims. Normally, standalones are completely disconnected from the internet. However, when run in hypergrid mode, standalones become network-able. As such, you can run your own world in your own computer, and link your world to whoever you want. For example, you can link to your friends' hypergrided opensims and to hypergrid gateways in open grids such as OSGrid. <br />
<br />
The great thing about this scenario is that all of your assets are stored on your computer, and not on somebody else's server. You can back them up using ordinary backend tools. The not so great thing about this scenario is that all of your assets are stored on your computer! If your disk goes berserk, you loose them. (so make sure you make external backups regularly)<br />
<br />
|-<br />
|<br />
[[image:topoB.jpg|400px|left]]<br />
|<br />
'''Communities'''<br />
<br />
This second scenario is about communities, broadly construed. The idea here is that a group of people come together to support a small community grid, i.e. a common world where shared activities take place. But at the same time, the members of the community maintain their own standalone worlds. The standalones link to the community grid, and the community grid may link back to the individual members' worlds and other places of interest.<br />
<br />
The members' identities are probably the identities they have on their standalones, and their assets are also probably stored there. The assets present in the community regions, however, are stored on the grid asset server.<br />
<br />
|-<br />
|<br />
[[image:topoC.jpg|400px|left]]<br />
|<br />
'''Grid Public Regions'''<br />
<br />
Walled-gardens are here to stay, and they serve many useful purposes. There is a hybrid mode for the hypergrid that some walled-garden grid operators may be interested in supporting. In this hybrid mode, most opensim instances on the grid run in normal, wall-garden mode, so no foreign visitors are allowed there - technically it is impossible to reach them. However, a few opensim instances on that grid can run in hypergrid mode, so that foreign visitors are allowed. This way, there is a gateway for grid-local users and arbitrary visitors to meet. This is also a good strategy for attracting new users to the grid, since random users are able to visit those gateway regions without having to sign up for an account upfront.<br />
<br />
This hybrid mode is very similar to what happens on the web. For example, anyone can visit Facebook's public pages without having to sign up for a Facebook account. However, only Facebook users can go further inside.<br />
<br />
|-<br />
|<br />
[[image:topoD.jpg|400px|left]]<br />
|<br />
'''Level Games'''<br />
<br />
The normal version of OpenSim enforces a common map for all the regions on a grid. The hypergrid removes that constraint. As such, it becomes easy to design VW games where the world looks different depending of where the player is. <br />
<br />
|-<br />
|}<br />
<br />
<br />
<br />
== Hypergrid Implementation ==<br />
<br />
=== Hyperlinks and Agent Transfers ===<br />
<br />
When you establish a link between your opensim and another, a message is sent out to that other opensim requesting information about it; the required information includes the network information of that opensim host, and the coordinates of its first region on its local grid in the form of a region handle. For example, suppose you are linking node X.com:9000, placing it in your local map at 900, 900. That opensim runs one or more regions that likely are not in 900, 900 on their own map; suppose the first region of that opensim is at 1100, 1100. From your point of view, it doesn't matter what those other coordinates are, and you don't need to know -- that's the key to being able to decentralize the "world" as given by a 2D map; you want to place it in your map at 900, 900. The "true" position of that simulator only matters for the LL viewer, when there are teleports between your world and that other opensim. This mapping between coordinate systems is the essence of hyperlinks for opensim; it's one simple but critical thing that the hypergrid implementation does. The mapping happens on the TeleportFinish event; instead of sending the local coordinates to the viewer, the hypergrid teleport wrapper sends the remote coordinates.<br />
<br />
When an agent teleports through that hyperlink the following happens. First, before InformRegionOfChildAgent, the local opensim notifies the remote opensim of this foreign user via the "expect_hg_user" method. That message sends along the addresses of all the servers that this user uses, i.e. user, inventory and asset servers. The remote opensim places an entry for that user in its local user profile cache but not in its user database; the foreign user information is non-persistent. After that, the teleport process is exactly the same as the normal teleport process; the only difference is that the region handles are switched between the remote region's hyperlink position on the local grid and its actual position on its grid. <br />
<br />
In summary, the two new concepts introduced by the hypergrid are the concept of an hyperlink and the concept of a "local user" vs. "[[Banning_Foreign_Users_in_Hypergrid|foreign user]]".<br />
<br />
=== Inventory Access ===<br />
<br />
Inventory access from abroad is done by wrapping the existing scene-inventory interactions with additional code that gets or posts inventory assets from/to the user's asset server. When inventory is accessed, the hypergrid wrapper checks if the user is foreign and, if she is, the wrapper simply brings the necessary assets from the user's asset server to the local asset cache and server; from then on, the wrapper passes the control to the existing inventory access functions. When something is added to inventory, the hypergrid wrapper is notified via an event, and posts the assets to the user's asset server. A cache of the exchanged item identifiers is maintained so that they aren't brought back over and over again.<br />
<br />
The result is that hypergrided opensim instances end up interacting with several asset servers, instead of just one. That interaction is implemented in a straightforward manner by instantiating several GridAssetClient objects, instead of just one.<br />
<br />
=== The Hypergrid Classes ===<br />
<br />
Currently, the hypergrid is implemented outside of the OpenSim namespace, so that there is complete separation between what already exists and this new behavior. It has its own namespace, HyperGrid. In it, there are 4 sub-namespaces that follow directly the software architecture of OpenSim, namely:<br />
<br />
* '''OpenSim.Framework''':<br />
** ForeignUserProfileData extends UserProfileData by introducing information about the user's "home", namely the home address, port and remoting port. The user's home is not that user's user service; it's the opensim that the user has defined to be her home. This is necessary for supporting the home jump (Ctrl-Shift-H).<br />
** HGNetworkServersInfo follows the spirit of NetworkServersInfo, although it neither extends it nor uses it. For now, it's a utility class whose two main functions are to convert domain names of servers to IP addresses, and to uniformly provide the answer to the question bool IsLocalUser(...).<br />
<br />
* '''OpenSim.Region.Framework.Scenes.Hypergrid''':<br />
** HGSceneCommunicationService extends SceneCommunicationService, overriding RequestTeleportToLocation. There are two very small but critical changes to the base method: (a) on the TeleportFinish event, we switch the region handles when the destination region is an hyperlink; (b) the connections at the end are always closed for hyperlink TPs.<br />
** HGScene extends Scene, overriding TeleportClientHome(...). The only change to the base method is to stay away from the user server, for now, because the user service is still not completely wrapped up for foreign users. Once the user service is properly wrapped up, this class will become unnecessary.<br />
** HGScene.Inventory is a partial class of HGScene, just like what happens in the OpenSim framework. This part of HGScene overrides some inventory-scene interaction methods, so that assets are fetched/posted from/to the user's asset server. Once that extra fetching/posting is done, these methods simply pass the ball to the base methods.<br />
** HGAssetMapper: this is a new class specific to the hypergrid that manages the fetching and posting of assets between foreign regions where the user is and the user's asset server.<br />
<br />
* '''OpenSim.Region.Communications.HyperGrid''' is a mashup of OpenSim.Region.Communications.*. This is the place where most of the hypergrid extension lies. One of the reasons for this is that the hypergrid communications part is doing one additional thing: it is making standalones network-able.<br />
** HGCommunicationsStandalone extends CommuniationsLocal. Just as its base, it is a hub for the several network services available in standalone mode. The main difference is that those services are extensions of what's in OpenSim.<br />
** HGCommunicationsGridMode extends CommunicationsManager directly. Again, it's a hub for the network services available in grid mode, those services being extensions of OpenSim.<br />
** The cluster HGGridServices (superclass), HGGridServicesStandalone and HGGridServicesGridMode (subclasses) implements the OpenSim interfaces IGridServices and IInterRegionCommunications. The 2 subclasses are wrappers for LocalBackEndServices and OGS1GridServices, respectively. There is one common pattern throughout these classes: check if the region to talk to is an hyperlink; if it's not, simply delegate the work to LocalBackEndServices/OGS1GridServices; if it is, push the work to the base class HGGridServices. HGGridServices, in turn, does the management of hyperlink regions, and defines two additional pieces of inter-region protocol:<br />
*** region_uuid: for linking regions<br />
*** expect_hg_user: similar to the existing expect_user interface, but with a lot more information about the user being passed around, namely all the user's servers (inventory, asset, user, home, etc.)<br />
** HGInventoryService extends LocalInventoryService and implements ISecureInventoryService. This class is the most obvious mashup of the pack, mixing local service access for standalone users and remote inventory access for when users are out and about. Right now, there is a fair amount of selective copy-and-paste, to stay away from the ugliness coming from OGS1InventoryService and OGS1SecureInventoryService. HGInventoryService is always a ISecureInventoryService. Its methods all follow the same pattern: check if the user is a local standalone user; if it is, pass the work to the base method (in LocalInventoryService); if it's not perform secure remote access.<br />
** HGUserServices wraps OSG1UserServices, but it's not functional yet.<br />
<br />
* '''OpenSim.Region.CoreModules.HyperGrid''' is a collection of 3 region modules:<br />
** HGWorldMapModule extends WorldMapModule. It reuses almost everything from the base class. The only small change is in RequestMapBlocks, where it tries to send Offline mapblocks to the client.<br />
** HGStandaloneInventoryService and HGStandaloneAssetService do what their names say. They are region modules that allow access to inventory and assets for standalones, when the standalone user is out and about. In spirit, there is a lot in common between these modules and the REST inventory/asset plugin. Unfortunately, that plugin could not be used because it defines a completely different interface than that used by existing inventory and asset servers, and the access for the hypergrid must use a consistent interface.<br />
<br />
<br />
<br />
<br />
== Public Hypergrid Nodes ==<br />
<br />
Please see [[Public Hypergrid Nodes]].<br />
<br />
<br />
== Hypergrid Lists ==<br />
Please see [[Hypergrid Lists]].<br />
<br />
== Manuals and Tutorials ==<br />
<br />
* '''Unofficial Hypernauta's Basic Manual''': If you are a real beginner it can be for you. Talking about "personal" worlds created using domestic computers. [http://www.dmu.com/opensime LINK]<br />
<br />
== Development Meetings ==<br />
<br />
[[Hypergrid Meetings]]<br />
<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/HypergridHypergrid2009-02-13T19:33:39Z<p>Rtkwebman: /* What is the hypergrid? */</p>
<hr />
<div>==The OpenSim Hypergrid==<br />
<br />
<br />
=== What is the hypergrid? ===<br />
<!-- [[image:VWV.jpg|250px|thumb|Web of Virtual Worlds]] --><br />
<br />
The hypergrid is an extension to opensim that allows you to link your opensim to other opensims on the internet, and that supports seamless agent transfers among those opensims. It can be used both in standalone mode and in grid mode. The hypergrid is effectively supporting the emergence of a Web of virtual worlds. <br />
<br />
The basic idea for the hypergrid is that region/grid administrations can place hyperlinks on their map to hypergrided regions run by others. Once those hyperlinks are established, users interact with those regions in exactly the same way as they interact with local regions. Specifically, users can choose to teleport there. Once the user reaches the region behind the hyperlink, she is automatically interacting with a different virtual world without having to logout from the world where she came from, and while still having access to her inventory.<br />
<br />
The hypergrid started as a GForge project, but it is now included in the standard distribution of OpenSim. To run your OpenSim instance in hypergrid mode, please see [[Installing_and_Running_Hypergrid|Installing and Running]].<br />
<br />
=== Virtual World Hyperlinks ===<br />
[[image:hghyperlink.jpg|250px|thumb|A Virtual World Hyperlink]]<br />
<br />
We're all familiar with hypertext links on the Web. But what is a virtual world hyperlink?<br />
<br />
In the hypergrid model, we consider the 2D map of the virtual world as the equivalent of a web page. As such, a VW hyperlink is simply a region on that map. <br />
<br />
The default model of opensim-based virtual worlds already supports this concept of hyperlink, to some extent. When you teleport from one region to another via the map, chances are you are migrating your agent into a different opensim server. This migration is a glorified "agent transfer" that also exists, in rudimentary form, on the web when hypertext links are followed. The default model, however, imposes two very strong constraints on these hyperlinks: <br />
# The entire map of regions is controlled by a central service known as the grid service, whose job is to provide a uniform view of the world to all of its regions.<br />
# The only agents that can be transferred are those pertaining to users known to another central service, the user service; if the incoming user is not on that service's database, the agent transfer doesn't go through.<br />
<br />
The hypergrid simply removes these two constraints. <br />
<br />
First, it allows individual opensim instances to add "neighbors" to their local map, shifting the control of the map down from the grid server to individual opensim instances (although hyperlinks can also be served by grid servers if grid admins so wish). In doing so, the world becomes a lot more interesting and varied. The map that you see in one opensim instance may be completely different from the map that you see after you teleport via an hyperlink. As an opensim administrator, you are free to define what other opensims you want to see on your map.<br />
<br />
Second, it allows the transfer of agents pertaining to foreigner users, i.e. users who are registered elsewhere. Instead of assuming one central user service, the hypergrid assumes an arbitrarily large number of such services distributed all over the world. As such, when agents are transferred among hypergrided opensims, a lot more information is passed about the corresponding user. That information includes the collection of servers that the transferring user needs.<br />
<br />
=== Usage Scenarios ===<br />
<br />
The following are some usage scenarios. There isn't a clear separation between these scenarios, there's a large overlap between them. This is also not an exhaustive list. The purpose of these descriptions is to give you some starting ideas for how to use the hypergrid in practice. Please feel free to add other interesting scenarios to this list.<br />
<br />
{| {{Prettytable}}<br />
|-<br />
|<br />
[[image:topoA.jpg|400px|left]]<br />
|<br />
'''Personal Worlds'''<br />
<br />
This first scenario pertains to standalone opensims. Normally, standalones are completely disconnected from the internet. However, when run in hypergrid mode, standalones become network-able. As such, you can run your own world in your own computer, and link your world to whoever you want. For example, you can link to your friends' hypergrided opensims and to hypergrid gateways in open grids such as OSGrid. <br />
<br />
The great thing about this scenario is that all of your assets are stored on your computer, and not on somebody else's server. You can back them up using ordinary backend tools. The not so great thing about this scenario is that all of your assets are stored on your computer! If your disk goes berserk, you loose them. (so make sure you make external backups regularly)<br />
<br />
|-<br />
|<br />
[[image:topoB.jpg|400px|left]]<br />
|<br />
'''Communities'''<br />
<br />
This second scenario is about communities, broadly construed. The idea here is that a group of people come together to support a small community grid, i.e. a common world where shared activities take place. But at the same time, the members of the community maintain their own standalone worlds. The standalones link to the community grid, and the community grid may link back to the individual members' worlds and other places of interest.<br />
<br />
The members' identities are probably the identities they have on their standalones, and their assets are also probably stored there. The assets present in the community regions, however, are stored on the grid asset server.<br />
<br />
|-<br />
|<br />
[[image:topoC.jpg|400px|left]]<br />
|<br />
'''Grid Public Regions'''<br />
<br />
Walled-gardens are here to stay, and they serve many useful purposes. There is a hybrid mode for the hypergrid that some walled-garden grid operators may be interested in supporting. In this hybrid mode, most opensim instances on the grid run in normal, wall-garden mode, so no foreign visitors are allowed there - technically it is impossible to reach them. However, a few opensim instances on that grid can run in hypergrid mode, so that foreign visitors are allowed. This way, there is a gateway for grid-local users and arbitrary visitors to meet. This is also a good strategy for attracting new users to the grid, since random users are able to visit those gateway regions without having to sign up for an account upfront.<br />
<br />
This hybrid mode is very similar to what happens on the web. For example, anyone can visit Facebook's public pages without having to sign up for a Facebook account. However, only Facebook users can go further inside.<br />
<br />
|-<br />
|<br />
[[image:topoD.jpg|400px|left]]<br />
|<br />
'''Level Games'''<br />
<br />
The normal version of OpenSim enforces a common map for all the regions on a grid. The hypergrid removes that constraint. As such, it becomes easy to design VW games where the world looks different depending of where the player is. <br />
<br />
|-<br />
|}<br />
<br />
<br />
<br />
== Hypergrid Implementation ==<br />
<br />
=== Hyperlinks and Agent Transfers ===<br />
<br />
When you establish a link between your opensim and another, a message is sent out to that other opensim requesting information about it; the required information includes the network information of that opensim host, and the coordinates of its first region on its local grid in the form of a region handle. For example, suppose you are linking node X.com:9000, placing it in your local map at 900, 900. That opensim runs one or more regions that likely are not in 900, 900 on their own map; suppose the first region of that opensim is at 1100, 1100. From your point of view, it doesn't matter what those other coordinates are, and you don't need to know -- that's the key to being able to decentralize the "world" as given by a 2D map; you want to place it in your map at 900, 900. The "true" position of that simulator only matters for the LL viewer, when there are teleports between your world and that other opensim. This mapping between coordinate systems is the essence of hyperlinks for opensim; it's one simple but critical thing that the hypergrid implementation does. The mapping happens on the TeleportFinish event; instead of sending the local coordinates to the viewer, the hypergrid teleport wrapper sends the remote coordinates.<br />
<br />
When an agent teleports through that hyperlink the following happens. First, before InformRegionOfChildAgent, the local opensim notifies the remote opensim of this foreign user via the "expect_hg_user" method. That message sends along the addresses of all the servers that this user uses, i.e. user, inventory and asset servers. The remote opensim places an entry for that user in its local user profile cache but not in its user database; the foreign user information is non-persistent. After that, the teleport process is exactly the same as the normal teleport process; the only difference is that the region handles are switched between the remote region's hyperlink position on the local grid and its actual position on its grid. <br />
<br />
In summary, the two new concepts introduced by the hypergrid are the concept of an hyperlink and the concept of a "local user" vs. "foreign user".<br />
<br />
=== Inventory Access ===<br />
<br />
Inventory access from abroad is done by wrapping the existing scene-inventory interactions with additional code that gets or posts inventory assets from/to the user's asset server. When inventory is accessed, the hypergrid wrapper checks if the user is foreign and, if she is, the wrapper simply brings the necessary assets from the user's asset server to the local asset cache and server; from then on, the wrapper passes the control to the existing inventory access functions. When something is added to inventory, the hypergrid wrapper is notified via an event, and posts the assets to the user's asset server. A cache of the exchanged item identifiers is maintained so that they aren't brought back over and over again.<br />
<br />
The result is that hypergrided opensim instances end up interacting with several asset servers, instead of just one. That interaction is implemented in a straightforward manner by instantiating several GridAssetClient objects, instead of just one.<br />
<br />
=== The Hypergrid Classes ===<br />
<br />
Currently, the hypergrid is implemented outside of the OpenSim namespace, so that there is complete separation between what already exists and this new behavior. It has its own namespace, HyperGrid. In it, there are 4 sub-namespaces that follow directly the software architecture of OpenSim, namely:<br />
<br />
* '''OpenSim.Framework''':<br />
** ForeignUserProfileData extends UserProfileData by introducing information about the user's "home", namely the home address, port and remoting port. The user's home is not that user's user service; it's the opensim that the user has defined to be her home. This is necessary for supporting the home jump (Ctrl-Shift-H).<br />
** HGNetworkServersInfo follows the spirit of NetworkServersInfo, although it neither extends it nor uses it. For now, it's a utility class whose two main functions are to convert domain names of servers to IP addresses, and to uniformly provide the answer to the question bool IsLocalUser(...).<br />
<br />
* '''OpenSim.Region.Framework.Scenes.Hypergrid''':<br />
** HGSceneCommunicationService extends SceneCommunicationService, overriding RequestTeleportToLocation. There are two very small but critical changes to the base method: (a) on the TeleportFinish event, we switch the region handles when the destination region is an hyperlink; (b) the connections at the end are always closed for hyperlink TPs.<br />
** HGScene extends Scene, overriding TeleportClientHome(...). The only change to the base method is to stay away from the user server, for now, because the user service is still not completely wrapped up for foreign users. Once the user service is properly wrapped up, this class will become unnecessary.<br />
** HGScene.Inventory is a partial class of HGScene, just like what happens in the OpenSim framework. This part of HGScene overrides some inventory-scene interaction methods, so that assets are fetched/posted from/to the user's asset server. Once that extra fetching/posting is done, these methods simply pass the ball to the base methods.<br />
** HGAssetMapper: this is a new class specific to the hypergrid that manages the fetching and posting of assets between foreign regions where the user is and the user's asset server.<br />
<br />
* '''OpenSim.Region.Communications.HyperGrid''' is a mashup of OpenSim.Region.Communications.*. This is the place where most of the hypergrid extension lies. One of the reasons for this is that the hypergrid communications part is doing one additional thing: it is making standalones network-able.<br />
** HGCommunicationsStandalone extends CommuniationsLocal. Just as its base, it is a hub for the several network services available in standalone mode. The main difference is that those services are extensions of what's in OpenSim.<br />
** HGCommunicationsGridMode extends CommunicationsManager directly. Again, it's a hub for the network services available in grid mode, those services being extensions of OpenSim.<br />
** The cluster HGGridServices (superclass), HGGridServicesStandalone and HGGridServicesGridMode (subclasses) implements the OpenSim interfaces IGridServices and IInterRegionCommunications. The 2 subclasses are wrappers for LocalBackEndServices and OGS1GridServices, respectively. There is one common pattern throughout these classes: check if the region to talk to is an hyperlink; if it's not, simply delegate the work to LocalBackEndServices/OGS1GridServices; if it is, push the work to the base class HGGridServices. HGGridServices, in turn, does the management of hyperlink regions, and defines two additional pieces of inter-region protocol:<br />
*** region_uuid: for linking regions<br />
*** expect_hg_user: similar to the existing expect_user interface, but with a lot more information about the user being passed around, namely all the user's servers (inventory, asset, user, home, etc.)<br />
** HGInventoryService extends LocalInventoryService and implements ISecureInventoryService. This class is the most obvious mashup of the pack, mixing local service access for standalone users and remote inventory access for when users are out and about. Right now, there is a fair amount of selective copy-and-paste, to stay away from the ugliness coming from OGS1InventoryService and OGS1SecureInventoryService. HGInventoryService is always a ISecureInventoryService. Its methods all follow the same pattern: check if the user is a local standalone user; if it is, pass the work to the base method (in LocalInventoryService); if it's not perform secure remote access.<br />
** HGUserServices wraps OSG1UserServices, but it's not functional yet.<br />
<br />
* '''OpenSim.Region.CoreModules.HyperGrid''' is a collection of 3 region modules:<br />
** HGWorldMapModule extends WorldMapModule. It reuses almost everything from the base class. The only small change is in RequestMapBlocks, where it tries to send Offline mapblocks to the client.<br />
** HGStandaloneInventoryService and HGStandaloneAssetService do what their names say. They are region modules that allow access to inventory and assets for standalones, when the standalone user is out and about. In spirit, there is a lot in common between these modules and the REST inventory/asset plugin. Unfortunately, that plugin could not be used because it defines a completely different interface than that used by existing inventory and asset servers, and the access for the hypergrid must use a consistent interface.<br />
<br />
<br />
<br />
<br />
== Public Hypergrid Nodes ==<br />
<br />
Please see [[Public Hypergrid Nodes]].<br />
<br />
<br />
== Hypergrid Lists ==<br />
Please see [[Hypergrid Lists]].<br />
<br />
== Manuals and Tutorials ==<br />
<br />
* '''Unofficial Hypernauta's Basic Manual''': If you are a real beginner it can be for you. Talking about "personal" worlds created using domestic computers. [http://www.dmu.com/opensime LINK]<br />
<br />
== Development Meetings ==<br />
<br />
[[Hypergrid Meetings]]<br />
<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/HypergridHypergrid2009-02-13T19:31:55Z<p>Rtkwebman: /* Installing and Running Hypergrid */</p>
<hr />
<div>==The OpenSim Hypergrid==<br />
<br />
<br />
=== What is the hypergrid? ===<br />
<!-- [[image:VWV.jpg|250px|thumb|Web of Virtual Worlds]] --><br />
<br />
The hypergrid is an extension to opensim that allows you to link your opensim to other opensims on the internet, and that supports seamless agent transfers among those opensims. It can be used both in standalone mode and in grid mode. The hypergrid is effectively supporting the emergence of a Web of virtual worlds. <br />
<br />
The basic idea for the hypergrid is that region/grid administrations can place hyperlinks on their map to hypergrided regions run by others. Once those hyperlinks are established, users interact with those regions in exactly the same way as they interact with local regions. Specifically, users can choose to teleport there. Once the user reaches the region behind the hyperlink, she is automatically interacting with a different virtual world without having to logout from the world where she came from, and while still having access to her inventory.<br />
<br />
The hypergrid started as a GForge project, but it is now included in the standard distribution of OpenSim. To run your OpenSim instance in hypergrid mode, please see [[Hypergrid#Installing_and_Running_Hypergrid|Installing and Running]].<br />
<br />
=== Virtual World Hyperlinks ===<br />
[[image:hghyperlink.jpg|250px|thumb|A Virtual World Hyperlink]]<br />
<br />
We're all familiar with hypertext links on the Web. But what is a virtual world hyperlink?<br />
<br />
In the hypergrid model, we consider the 2D map of the virtual world as the equivalent of a web page. As such, a VW hyperlink is simply a region on that map. <br />
<br />
The default model of opensim-based virtual worlds already supports this concept of hyperlink, to some extent. When you teleport from one region to another via the map, chances are you are migrating your agent into a different opensim server. This migration is a glorified "agent transfer" that also exists, in rudimentary form, on the web when hypertext links are followed. The default model, however, imposes two very strong constraints on these hyperlinks: <br />
# The entire map of regions is controlled by a central service known as the grid service, whose job is to provide a uniform view of the world to all of its regions.<br />
# The only agents that can be transferred are those pertaining to users known to another central service, the user service; if the incoming user is not on that service's database, the agent transfer doesn't go through.<br />
<br />
The hypergrid simply removes these two constraints. <br />
<br />
First, it allows individual opensim instances to add "neighbors" to their local map, shifting the control of the map down from the grid server to individual opensim instances (although hyperlinks can also be served by grid servers if grid admins so wish). In doing so, the world becomes a lot more interesting and varied. The map that you see in one opensim instance may be completely different from the map that you see after you teleport via an hyperlink. As an opensim administrator, you are free to define what other opensims you want to see on your map.<br />
<br />
Second, it allows the transfer of agents pertaining to foreigner users, i.e. users who are registered elsewhere. Instead of assuming one central user service, the hypergrid assumes an arbitrarily large number of such services distributed all over the world. As such, when agents are transferred among hypergrided opensims, a lot more information is passed about the corresponding user. That information includes the collection of servers that the transferring user needs.<br />
<br />
=== Usage Scenarios ===<br />
<br />
The following are some usage scenarios. There isn't a clear separation between these scenarios, there's a large overlap between them. This is also not an exhaustive list. The purpose of these descriptions is to give you some starting ideas for how to use the hypergrid in practice. Please feel free to add other interesting scenarios to this list.<br />
<br />
{| {{Prettytable}}<br />
|-<br />
|<br />
[[image:topoA.jpg|400px|left]]<br />
|<br />
'''Personal Worlds'''<br />
<br />
This first scenario pertains to standalone opensims. Normally, standalones are completely disconnected from the internet. However, when run in hypergrid mode, standalones become network-able. As such, you can run your own world in your own computer, and link your world to whoever you want. For example, you can link to your friends' hypergrided opensims and to hypergrid gateways in open grids such as OSGrid. <br />
<br />
The great thing about this scenario is that all of your assets are stored on your computer, and not on somebody else's server. You can back them up using ordinary backend tools. The not so great thing about this scenario is that all of your assets are stored on your computer! If your disk goes berserk, you loose them. (so make sure you make external backups regularly)<br />
<br />
|-<br />
|<br />
[[image:topoB.jpg|400px|left]]<br />
|<br />
'''Communities'''<br />
<br />
This second scenario is about communities, broadly construed. The idea here is that a group of people come together to support a small community grid, i.e. a common world where shared activities take place. But at the same time, the members of the community maintain their own standalone worlds. The standalones link to the community grid, and the community grid may link back to the individual members' worlds and other places of interest.<br />
<br />
The members' identities are probably the identities they have on their standalones, and their assets are also probably stored there. The assets present in the community regions, however, are stored on the grid asset server.<br />
<br />
|-<br />
|<br />
[[image:topoC.jpg|400px|left]]<br />
|<br />
'''Grid Public Regions'''<br />
<br />
Walled-gardens are here to stay, and they serve many useful purposes. There is a hybrid mode for the hypergrid that some walled-garden grid operators may be interested in supporting. In this hybrid mode, most opensim instances on the grid run in normal, wall-garden mode, so no foreign visitors are allowed there - technically it is impossible to reach them. However, a few opensim instances on that grid can run in hypergrid mode, so that foreign visitors are allowed. This way, there is a gateway for grid-local users and arbitrary visitors to meet. This is also a good strategy for attracting new users to the grid, since random users are able to visit those gateway regions without having to sign up for an account upfront.<br />
<br />
This hybrid mode is very similar to what happens on the web. For example, anyone can visit Facebook's public pages without having to sign up for a Facebook account. However, only Facebook users can go further inside.<br />
<br />
|-<br />
|<br />
[[image:topoD.jpg|400px|left]]<br />
|<br />
'''Level Games'''<br />
<br />
The normal version of OpenSim enforces a common map for all the regions on a grid. The hypergrid removes that constraint. As such, it becomes easy to design VW games where the world looks different depending of where the player is. <br />
<br />
|-<br />
|}<br />
<br />
<br />
<br />
== Hypergrid Implementation ==<br />
<br />
=== Hyperlinks and Agent Transfers ===<br />
<br />
When you establish a link between your opensim and another, a message is sent out to that other opensim requesting information about it; the required information includes the network information of that opensim host, and the coordinates of its first region on its local grid in the form of a region handle. For example, suppose you are linking node X.com:9000, placing it in your local map at 900, 900. That opensim runs one or more regions that likely are not in 900, 900 on their own map; suppose the first region of that opensim is at 1100, 1100. From your point of view, it doesn't matter what those other coordinates are, and you don't need to know -- that's the key to being able to decentralize the "world" as given by a 2D map; you want to place it in your map at 900, 900. The "true" position of that simulator only matters for the LL viewer, when there are teleports between your world and that other opensim. This mapping between coordinate systems is the essence of hyperlinks for opensim; it's one simple but critical thing that the hypergrid implementation does. The mapping happens on the TeleportFinish event; instead of sending the local coordinates to the viewer, the hypergrid teleport wrapper sends the remote coordinates.<br />
<br />
When an agent teleports through that hyperlink the following happens. First, before InformRegionOfChildAgent, the local opensim notifies the remote opensim of this foreign user via the "expect_hg_user" method. That message sends along the addresses of all the servers that this user uses, i.e. user, inventory and asset servers. The remote opensim places an entry for that user in its local user profile cache but not in its user database; the foreign user information is non-persistent. After that, the teleport process is exactly the same as the normal teleport process; the only difference is that the region handles are switched between the remote region's hyperlink position on the local grid and its actual position on its grid. <br />
<br />
In summary, the two new concepts introduced by the hypergrid are the concept of an hyperlink and the concept of a "local user" vs. "foreign user".<br />
<br />
=== Inventory Access ===<br />
<br />
Inventory access from abroad is done by wrapping the existing scene-inventory interactions with additional code that gets or posts inventory assets from/to the user's asset server. When inventory is accessed, the hypergrid wrapper checks if the user is foreign and, if she is, the wrapper simply brings the necessary assets from the user's asset server to the local asset cache and server; from then on, the wrapper passes the control to the existing inventory access functions. When something is added to inventory, the hypergrid wrapper is notified via an event, and posts the assets to the user's asset server. A cache of the exchanged item identifiers is maintained so that they aren't brought back over and over again.<br />
<br />
The result is that hypergrided opensim instances end up interacting with several asset servers, instead of just one. That interaction is implemented in a straightforward manner by instantiating several GridAssetClient objects, instead of just one.<br />
<br />
=== The Hypergrid Classes ===<br />
<br />
Currently, the hypergrid is implemented outside of the OpenSim namespace, so that there is complete separation between what already exists and this new behavior. It has its own namespace, HyperGrid. In it, there are 4 sub-namespaces that follow directly the software architecture of OpenSim, namely:<br />
<br />
* '''OpenSim.Framework''':<br />
** ForeignUserProfileData extends UserProfileData by introducing information about the user's "home", namely the home address, port and remoting port. The user's home is not that user's user service; it's the opensim that the user has defined to be her home. This is necessary for supporting the home jump (Ctrl-Shift-H).<br />
** HGNetworkServersInfo follows the spirit of NetworkServersInfo, although it neither extends it nor uses it. For now, it's a utility class whose two main functions are to convert domain names of servers to IP addresses, and to uniformly provide the answer to the question bool IsLocalUser(...).<br />
<br />
* '''OpenSim.Region.Framework.Scenes.Hypergrid''':<br />
** HGSceneCommunicationService extends SceneCommunicationService, overriding RequestTeleportToLocation. There are two very small but critical changes to the base method: (a) on the TeleportFinish event, we switch the region handles when the destination region is an hyperlink; (b) the connections at the end are always closed for hyperlink TPs.<br />
** HGScene extends Scene, overriding TeleportClientHome(...). The only change to the base method is to stay away from the user server, for now, because the user service is still not completely wrapped up for foreign users. Once the user service is properly wrapped up, this class will become unnecessary.<br />
** HGScene.Inventory is a partial class of HGScene, just like what happens in the OpenSim framework. This part of HGScene overrides some inventory-scene interaction methods, so that assets are fetched/posted from/to the user's asset server. Once that extra fetching/posting is done, these methods simply pass the ball to the base methods.<br />
** HGAssetMapper: this is a new class specific to the hypergrid that manages the fetching and posting of assets between foreign regions where the user is and the user's asset server.<br />
<br />
* '''OpenSim.Region.Communications.HyperGrid''' is a mashup of OpenSim.Region.Communications.*. This is the place where most of the hypergrid extension lies. One of the reasons for this is that the hypergrid communications part is doing one additional thing: it is making standalones network-able.<br />
** HGCommunicationsStandalone extends CommuniationsLocal. Just as its base, it is a hub for the several network services available in standalone mode. The main difference is that those services are extensions of what's in OpenSim.<br />
** HGCommunicationsGridMode extends CommunicationsManager directly. Again, it's a hub for the network services available in grid mode, those services being extensions of OpenSim.<br />
** The cluster HGGridServices (superclass), HGGridServicesStandalone and HGGridServicesGridMode (subclasses) implements the OpenSim interfaces IGridServices and IInterRegionCommunications. The 2 subclasses are wrappers for LocalBackEndServices and OGS1GridServices, respectively. There is one common pattern throughout these classes: check if the region to talk to is an hyperlink; if it's not, simply delegate the work to LocalBackEndServices/OGS1GridServices; if it is, push the work to the base class HGGridServices. HGGridServices, in turn, does the management of hyperlink regions, and defines two additional pieces of inter-region protocol:<br />
*** region_uuid: for linking regions<br />
*** expect_hg_user: similar to the existing expect_user interface, but with a lot more information about the user being passed around, namely all the user's servers (inventory, asset, user, home, etc.)<br />
** HGInventoryService extends LocalInventoryService and implements ISecureInventoryService. This class is the most obvious mashup of the pack, mixing local service access for standalone users and remote inventory access for when users are out and about. Right now, there is a fair amount of selective copy-and-paste, to stay away from the ugliness coming from OGS1InventoryService and OGS1SecureInventoryService. HGInventoryService is always a ISecureInventoryService. Its methods all follow the same pattern: check if the user is a local standalone user; if it is, pass the work to the base method (in LocalInventoryService); if it's not perform secure remote access.<br />
** HGUserServices wraps OSG1UserServices, but it's not functional yet.<br />
<br />
* '''OpenSim.Region.CoreModules.HyperGrid''' is a collection of 3 region modules:<br />
** HGWorldMapModule extends WorldMapModule. It reuses almost everything from the base class. The only small change is in RequestMapBlocks, where it tries to send Offline mapblocks to the client.<br />
** HGStandaloneInventoryService and HGStandaloneAssetService do what their names say. They are region modules that allow access to inventory and assets for standalones, when the standalone user is out and about. In spirit, there is a lot in common between these modules and the REST inventory/asset plugin. Unfortunately, that plugin could not be used because it defines a completely different interface than that used by existing inventory and asset servers, and the access for the hypergrid must use a consistent interface.<br />
<br />
<br />
<br />
<br />
== Public Hypergrid Nodes ==<br />
<br />
Please see [[Public Hypergrid Nodes]].<br />
<br />
<br />
== Hypergrid Lists ==<br />
Please see [[Hypergrid Lists]].<br />
<br />
== Manuals and Tutorials ==<br />
<br />
* '''Unofficial Hypernauta's Basic Manual''': If you are a real beginner it can be for you. Talking about "personal" worlds created using domestic computers. [http://www.dmu.com/opensime LINK]<br />
<br />
== Development Meetings ==<br />
<br />
[[Hypergrid Meetings]]<br />
<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Installing_and_Running_HypergridInstalling and Running Hypergrid2009-02-13T19:31:31Z<p>Rtkwebman: New page: === Installing === # Checkout OpenSim, prebuild and build as normal. # #* If you're running your opensim in grid mode with the UGAIM servers on other machines, you're done. If you're run...</p>
<hr />
<div>=== Installing ===<br />
<br />
# Checkout OpenSim, prebuild and build as normal.<br />
# <br />
#* If you're running your opensim in grid mode with the UGAIM servers on other machines, you're done. If you're running in standalone and you want it to be network-able, or if you have your grid on loopback (127.0.0.1) change all the [Network] server addresses to <nowiki>"http://<external_host_name>:<http_port>"</nowiki>. See below.<br />
# Run opensim like this: <nowiki>[mono] OpenSim.exe -hypergrid=true</nowiki>. To make sure the hypergrid is running type this on your console: '''link-region'''. If you don't hear anything back, the hypergrid is not properly installed.<br />
'''[mono] OpenSim.exe -hypergrid=true'''<br />
<br />
Here is an example of the Network settings for a standalone:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:9300<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:9300<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:9300<br />
inventory_server_url = http://example.com:9300<br />
messaging_server_url = http://example.com:9300<br />
<br />
<br />
Here is an example of the Network settings for a grided opensim:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:8001<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:8002<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:8003<br />
inventory_server_url = http://example.com:8004<br />
; Port 8005 reserved<br />
messaging_server_url = http://example.com:8006<br />
<br />
<br />
'''Important Note'''<br />
<br />
Make sure you have a 'home' set. If your home region doesn't exist, the hyperlink TPs may not work. To set your home, go to one of your local regions and "Set Home" from the viewer.<br />
<br />
=== Linking regions ===<br />
<br />
==== Method 1 ====<br />
<br />
On the console, type for example:<br />
<br />
link-region <Xloc> <Yloc> osl2.nac.uci.edu:9006<br />
<br />
* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.<br />
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the http_listener_port of the simulator where the region is running you want to link to<br />
<br />
You can link to a specific region within an instance, by using the name of the region at the end, for example:<br />
<br />
link-region 997 997 osl2.nac.uci.edu:9006:UCI Welcome<br />
<br />
==== Method 2 ====<br />
<br />
There is also some initial support for reading the links from a xml file.<br />
<br />
Use the console command: link-region <URI> [<excludeList>]<br />
<br />
The uri can be either the path of a local xml file or a xml document on a http server.<br />
<br />
The format of the xml file is:<br />
<br />
<Nini><br />
<Section Name="Region1"> <!-- can be any name but each section should have a different name and have no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
<Key Name="real-xloc" Value="10222"/> //optional field that gives the region's real location on its home grid<br />
<Key Name="real-yloc" Value="10265" /> //optional field that gives the region's real location on its home grid<br />
</Section><br />
<Section Name="Region2"> <br />
...<br />
</Section><br />
...<br />
</Nini><br />
<br />
[Note] The section names can be anything you want, but they all should be different and have no spaces in the name.<br />
<br />
<br />
ExcludeList:<br />
<br />
The exclude list is a single string paramater with the format: excludeList:<SectionName>[;<SectionName>]<br />
<br />
This means that while reading from the xml file any sections that are listed in the excludeList will be ignored and no HyperGrid link created for them.<br />
<br />
This could allow, link lists to be created on a webserver that everyone could add their own regions to, and then they just make sure they add their own section name(s) to the exclude list on their own region(s). <br />
<br />
So for example, someone might create a editable online list for the up coming OpenSimulator's 2nd birthday. Which might look something like:<br />
<br />
<Nini><br />
<Section Name="OSGrid-Party"> <!-- can be any name but each section should have a different name and no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
</Section><br />
<Section Name="UCIGrid-Party"> <br />
...<br />
</Section><br />
</Nini><br />
<br />
I could then add my own region to the list with the section name "MW-Party". Then when I startup that region that I want to be part of this hypergrid, I use the command: "link-region <URI of xml file> excludeList:MW-Party" <br />
<br />
This is so that my region doesn't try to create a hyper link to itself.<br />
<br />
==== Method 3 (dynamic) ====<br />
<br />
Starting in r8193, if you're in an HG-enabled region, you'll be able <br />
to dynamically link sims, and TP there, in any one of these ways (and <br />
probably more). All you need to know is the target addresse, e.g. from the<br />
list below.<br />
<br />
1) Type for example secondlife://ucigrid04.nacs.uci.edu:9007/ in the <br />
chat box, pull up the chat history and click on that link<br />
<br />
2) Pull up the map and search for things like <br />
ucigrid04.nacs.uci.edu:9007<br />
<br />
3) Using the embedded browser visit pages that have links like <br />
secondlife://ucigrid04.nacs.uci.edu:9007/ (there's one up at<br />
http://www.ics.uci.edu/~lopes/hypergrid/test.html)<br />
<br />
Again, you can link to a specific region within an instance by adding the name of that region at the end, like this:<br />
secondlife://ucigrid04.nacs.uci.edu:9007:Gateway 7000/<br />
<br />
'''Important Note'''<br />
<br />
Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.<br />
<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/HypergridHypergrid2009-02-13T19:29:49Z<p>Rtkwebman: /* Development Meetings */</p>
<hr />
<div>==The OpenSim Hypergrid==<br />
<br />
<br />
=== What is the hypergrid? ===<br />
<!-- [[image:VWV.jpg|250px|thumb|Web of Virtual Worlds]] --><br />
<br />
The hypergrid is an extension to opensim that allows you to link your opensim to other opensims on the internet, and that supports seamless agent transfers among those opensims. It can be used both in standalone mode and in grid mode. The hypergrid is effectively supporting the emergence of a Web of virtual worlds. <br />
<br />
The basic idea for the hypergrid is that region/grid administrations can place hyperlinks on their map to hypergrided regions run by others. Once those hyperlinks are established, users interact with those regions in exactly the same way as they interact with local regions. Specifically, users can choose to teleport there. Once the user reaches the region behind the hyperlink, she is automatically interacting with a different virtual world without having to logout from the world where she came from, and while still having access to her inventory.<br />
<br />
The hypergrid started as a GForge project, but it is now included in the standard distribution of OpenSim. To run your OpenSim instance in hypergrid mode, please see [[Hypergrid#Installing_and_Running_Hypergrid|Installing and Running]].<br />
<br />
=== Virtual World Hyperlinks ===<br />
[[image:hghyperlink.jpg|250px|thumb|A Virtual World Hyperlink]]<br />
<br />
We're all familiar with hypertext links on the Web. But what is a virtual world hyperlink?<br />
<br />
In the hypergrid model, we consider the 2D map of the virtual world as the equivalent of a web page. As such, a VW hyperlink is simply a region on that map. <br />
<br />
The default model of opensim-based virtual worlds already supports this concept of hyperlink, to some extent. When you teleport from one region to another via the map, chances are you are migrating your agent into a different opensim server. This migration is a glorified "agent transfer" that also exists, in rudimentary form, on the web when hypertext links are followed. The default model, however, imposes two very strong constraints on these hyperlinks: <br />
# The entire map of regions is controlled by a central service known as the grid service, whose job is to provide a uniform view of the world to all of its regions.<br />
# The only agents that can be transferred are those pertaining to users known to another central service, the user service; if the incoming user is not on that service's database, the agent transfer doesn't go through.<br />
<br />
The hypergrid simply removes these two constraints. <br />
<br />
First, it allows individual opensim instances to add "neighbors" to their local map, shifting the control of the map down from the grid server to individual opensim instances (although hyperlinks can also be served by grid servers if grid admins so wish). In doing so, the world becomes a lot more interesting and varied. The map that you see in one opensim instance may be completely different from the map that you see after you teleport via an hyperlink. As an opensim administrator, you are free to define what other opensims you want to see on your map.<br />
<br />
Second, it allows the transfer of agents pertaining to foreigner users, i.e. users who are registered elsewhere. Instead of assuming one central user service, the hypergrid assumes an arbitrarily large number of such services distributed all over the world. As such, when agents are transferred among hypergrided opensims, a lot more information is passed about the corresponding user. That information includes the collection of servers that the transferring user needs.<br />
<br />
=== Usage Scenarios ===<br />
<br />
The following are some usage scenarios. There isn't a clear separation between these scenarios, there's a large overlap between them. This is also not an exhaustive list. The purpose of these descriptions is to give you some starting ideas for how to use the hypergrid in practice. Please feel free to add other interesting scenarios to this list.<br />
<br />
{| {{Prettytable}}<br />
|-<br />
|<br />
[[image:topoA.jpg|400px|left]]<br />
|<br />
'''Personal Worlds'''<br />
<br />
This first scenario pertains to standalone opensims. Normally, standalones are completely disconnected from the internet. However, when run in hypergrid mode, standalones become network-able. As such, you can run your own world in your own computer, and link your world to whoever you want. For example, you can link to your friends' hypergrided opensims and to hypergrid gateways in open grids such as OSGrid. <br />
<br />
The great thing about this scenario is that all of your assets are stored on your computer, and not on somebody else's server. You can back them up using ordinary backend tools. The not so great thing about this scenario is that all of your assets are stored on your computer! If your disk goes berserk, you loose them. (so make sure you make external backups regularly)<br />
<br />
|-<br />
|<br />
[[image:topoB.jpg|400px|left]]<br />
|<br />
'''Communities'''<br />
<br />
This second scenario is about communities, broadly construed. The idea here is that a group of people come together to support a small community grid, i.e. a common world where shared activities take place. But at the same time, the members of the community maintain their own standalone worlds. The standalones link to the community grid, and the community grid may link back to the individual members' worlds and other places of interest.<br />
<br />
The members' identities are probably the identities they have on their standalones, and their assets are also probably stored there. The assets present in the community regions, however, are stored on the grid asset server.<br />
<br />
|-<br />
|<br />
[[image:topoC.jpg|400px|left]]<br />
|<br />
'''Grid Public Regions'''<br />
<br />
Walled-gardens are here to stay, and they serve many useful purposes. There is a hybrid mode for the hypergrid that some walled-garden grid operators may be interested in supporting. In this hybrid mode, most opensim instances on the grid run in normal, wall-garden mode, so no foreign visitors are allowed there - technically it is impossible to reach them. However, a few opensim instances on that grid can run in hypergrid mode, so that foreign visitors are allowed. This way, there is a gateway for grid-local users and arbitrary visitors to meet. This is also a good strategy for attracting new users to the grid, since random users are able to visit those gateway regions without having to sign up for an account upfront.<br />
<br />
This hybrid mode is very similar to what happens on the web. For example, anyone can visit Facebook's public pages without having to sign up for a Facebook account. However, only Facebook users can go further inside.<br />
<br />
|-<br />
|<br />
[[image:topoD.jpg|400px|left]]<br />
|<br />
'''Level Games'''<br />
<br />
The normal version of OpenSim enforces a common map for all the regions on a grid. The hypergrid removes that constraint. As such, it becomes easy to design VW games where the world looks different depending of where the player is. <br />
<br />
|-<br />
|}<br />
<br />
<br />
<br />
== Hypergrid Implementation ==<br />
<br />
=== Hyperlinks and Agent Transfers ===<br />
<br />
When you establish a link between your opensim and another, a message is sent out to that other opensim requesting information about it; the required information includes the network information of that opensim host, and the coordinates of its first region on its local grid in the form of a region handle. For example, suppose you are linking node X.com:9000, placing it in your local map at 900, 900. That opensim runs one or more regions that likely are not in 900, 900 on their own map; suppose the first region of that opensim is at 1100, 1100. From your point of view, it doesn't matter what those other coordinates are, and you don't need to know -- that's the key to being able to decentralize the "world" as given by a 2D map; you want to place it in your map at 900, 900. The "true" position of that simulator only matters for the LL viewer, when there are teleports between your world and that other opensim. This mapping between coordinate systems is the essence of hyperlinks for opensim; it's one simple but critical thing that the hypergrid implementation does. The mapping happens on the TeleportFinish event; instead of sending the local coordinates to the viewer, the hypergrid teleport wrapper sends the remote coordinates.<br />
<br />
When an agent teleports through that hyperlink the following happens. First, before InformRegionOfChildAgent, the local opensim notifies the remote opensim of this foreign user via the "expect_hg_user" method. That message sends along the addresses of all the servers that this user uses, i.e. user, inventory and asset servers. The remote opensim places an entry for that user in its local user profile cache but not in its user database; the foreign user information is non-persistent. After that, the teleport process is exactly the same as the normal teleport process; the only difference is that the region handles are switched between the remote region's hyperlink position on the local grid and its actual position on its grid. <br />
<br />
In summary, the two new concepts introduced by the hypergrid are the concept of an hyperlink and the concept of a "local user" vs. "foreign user".<br />
<br />
=== Inventory Access ===<br />
<br />
Inventory access from abroad is done by wrapping the existing scene-inventory interactions with additional code that gets or posts inventory assets from/to the user's asset server. When inventory is accessed, the hypergrid wrapper checks if the user is foreign and, if she is, the wrapper simply brings the necessary assets from the user's asset server to the local asset cache and server; from then on, the wrapper passes the control to the existing inventory access functions. When something is added to inventory, the hypergrid wrapper is notified via an event, and posts the assets to the user's asset server. A cache of the exchanged item identifiers is maintained so that they aren't brought back over and over again.<br />
<br />
The result is that hypergrided opensim instances end up interacting with several asset servers, instead of just one. That interaction is implemented in a straightforward manner by instantiating several GridAssetClient objects, instead of just one.<br />
<br />
=== The Hypergrid Classes ===<br />
<br />
Currently, the hypergrid is implemented outside of the OpenSim namespace, so that there is complete separation between what already exists and this new behavior. It has its own namespace, HyperGrid. In it, there are 4 sub-namespaces that follow directly the software architecture of OpenSim, namely:<br />
<br />
* '''OpenSim.Framework''':<br />
** ForeignUserProfileData extends UserProfileData by introducing information about the user's "home", namely the home address, port and remoting port. The user's home is not that user's user service; it's the opensim that the user has defined to be her home. This is necessary for supporting the home jump (Ctrl-Shift-H).<br />
** HGNetworkServersInfo follows the spirit of NetworkServersInfo, although it neither extends it nor uses it. For now, it's a utility class whose two main functions are to convert domain names of servers to IP addresses, and to uniformly provide the answer to the question bool IsLocalUser(...).<br />
<br />
* '''OpenSim.Region.Framework.Scenes.Hypergrid''':<br />
** HGSceneCommunicationService extends SceneCommunicationService, overriding RequestTeleportToLocation. There are two very small but critical changes to the base method: (a) on the TeleportFinish event, we switch the region handles when the destination region is an hyperlink; (b) the connections at the end are always closed for hyperlink TPs.<br />
** HGScene extends Scene, overriding TeleportClientHome(...). The only change to the base method is to stay away from the user server, for now, because the user service is still not completely wrapped up for foreign users. Once the user service is properly wrapped up, this class will become unnecessary.<br />
** HGScene.Inventory is a partial class of HGScene, just like what happens in the OpenSim framework. This part of HGScene overrides some inventory-scene interaction methods, so that assets are fetched/posted from/to the user's asset server. Once that extra fetching/posting is done, these methods simply pass the ball to the base methods.<br />
** HGAssetMapper: this is a new class specific to the hypergrid that manages the fetching and posting of assets between foreign regions where the user is and the user's asset server.<br />
<br />
* '''OpenSim.Region.Communications.HyperGrid''' is a mashup of OpenSim.Region.Communications.*. This is the place where most of the hypergrid extension lies. One of the reasons for this is that the hypergrid communications part is doing one additional thing: it is making standalones network-able.<br />
** HGCommunicationsStandalone extends CommuniationsLocal. Just as its base, it is a hub for the several network services available in standalone mode. The main difference is that those services are extensions of what's in OpenSim.<br />
** HGCommunicationsGridMode extends CommunicationsManager directly. Again, it's a hub for the network services available in grid mode, those services being extensions of OpenSim.<br />
** The cluster HGGridServices (superclass), HGGridServicesStandalone and HGGridServicesGridMode (subclasses) implements the OpenSim interfaces IGridServices and IInterRegionCommunications. The 2 subclasses are wrappers for LocalBackEndServices and OGS1GridServices, respectively. There is one common pattern throughout these classes: check if the region to talk to is an hyperlink; if it's not, simply delegate the work to LocalBackEndServices/OGS1GridServices; if it is, push the work to the base class HGGridServices. HGGridServices, in turn, does the management of hyperlink regions, and defines two additional pieces of inter-region protocol:<br />
*** region_uuid: for linking regions<br />
*** expect_hg_user: similar to the existing expect_user interface, but with a lot more information about the user being passed around, namely all the user's servers (inventory, asset, user, home, etc.)<br />
** HGInventoryService extends LocalInventoryService and implements ISecureInventoryService. This class is the most obvious mashup of the pack, mixing local service access for standalone users and remote inventory access for when users are out and about. Right now, there is a fair amount of selective copy-and-paste, to stay away from the ugliness coming from OGS1InventoryService and OGS1SecureInventoryService. HGInventoryService is always a ISecureInventoryService. Its methods all follow the same pattern: check if the user is a local standalone user; if it is, pass the work to the base method (in LocalInventoryService); if it's not perform secure remote access.<br />
** HGUserServices wraps OSG1UserServices, but it's not functional yet.<br />
<br />
* '''OpenSim.Region.CoreModules.HyperGrid''' is a collection of 3 region modules:<br />
** HGWorldMapModule extends WorldMapModule. It reuses almost everything from the base class. The only small change is in RequestMapBlocks, where it tries to send Offline mapblocks to the client.<br />
** HGStandaloneInventoryService and HGStandaloneAssetService do what their names say. They are region modules that allow access to inventory and assets for standalones, when the standalone user is out and about. In spirit, there is a lot in common between these modules and the REST inventory/asset plugin. Unfortunately, that plugin could not be used because it defines a completely different interface than that used by existing inventory and asset servers, and the access for the hypergrid must use a consistent interface.<br />
<br />
<br />
== Installing and Running Hypergrid ==<br />
<br />
=== Installing ===<br />
<br />
# Checkout OpenSim, prebuild and build as normal.<br />
# <br />
#* If you're running your opensim in grid mode with the UGAIM servers on other machines, you're done. If you're running in standalone and you want it to be network-able, or if you have your grid on loopback (127.0.0.1) change all the [Network] server addresses to <nowiki>"http://<external_host_name>:<http_port>"</nowiki>. See below.<br />
# Run opensim like this: <nowiki>[mono] OpenSim.exe -hypergrid=true</nowiki>. To make sure the hypergrid is running type this on your console: '''link-region'''. If you don't hear anything back, the hypergrid is not properly installed.<br />
'''[mono] OpenSim.exe -hypergrid=true'''<br />
<br />
Here is an example of the Network settings for a standalone:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:9300<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:9300<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:9300<br />
inventory_server_url = http://example.com:9300<br />
messaging_server_url = http://example.com:9300<br />
<br />
<br />
Here is an example of the Network settings for a grided opensim:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:8001<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:8002<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:8003<br />
inventory_server_url = http://example.com:8004<br />
; Port 8005 reserved<br />
messaging_server_url = http://example.com:8006<br />
<br />
<br />
'''Important Note'''<br />
<br />
Make sure you have a 'home' set. If your home region doesn't exist, the hyperlink TPs may not work. To set your home, go to one of your local regions and "Set Home" from the viewer.<br />
<br />
=== Linking regions ===<br />
<br />
==== Method 1 ====<br />
<br />
On the console, type for example:<br />
<br />
link-region <Xloc> <Yloc> osl2.nac.uci.edu:9006<br />
<br />
* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.<br />
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the http_listener_port of the simulator where the region is running you want to link to<br />
<br />
You can link to a specific region within an instance, by using the name of the region at the end, for example:<br />
<br />
link-region 997 997 osl2.nac.uci.edu:9006:UCI Welcome<br />
<br />
==== Method 2 ====<br />
<br />
There is also some initial support for reading the links from a xml file.<br />
<br />
Use the console command: link-region <URI> [<excludeList>]<br />
<br />
The uri can be either the path of a local xml file or a xml document on a http server.<br />
<br />
The format of the xml file is:<br />
<br />
<Nini><br />
<Section Name="Region1"> <!-- can be any name but each section should have a different name and have no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
<Key Name="real-xloc" Value="10222"/> //optional field that gives the region's real location on its home grid<br />
<Key Name="real-yloc" Value="10265" /> //optional field that gives the region's real location on its home grid<br />
</Section><br />
<Section Name="Region2"> <br />
...<br />
</Section><br />
...<br />
</Nini><br />
<br />
[Note] The section names can be anything you want, but they all should be different and have no spaces in the name.<br />
<br />
<br />
ExcludeList:<br />
<br />
The exclude list is a single string paramater with the format: excludeList:<SectionName>[;<SectionName>]<br />
<br />
This means that while reading from the xml file any sections that are listed in the excludeList will be ignored and no HyperGrid link created for them.<br />
<br />
This could allow, link lists to be created on a webserver that everyone could add their own regions to, and then they just make sure they add their own section name(s) to the exclude list on their own region(s). <br />
<br />
So for example, someone might create a editable online list for the up coming OpenSimulator's 2nd birthday. Which might look something like:<br />
<br />
<Nini><br />
<Section Name="OSGrid-Party"> <!-- can be any name but each section should have a different name and no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
</Section><br />
<Section Name="UCIGrid-Party"> <br />
...<br />
</Section><br />
</Nini><br />
<br />
I could then add my own region to the list with the section name "MW-Party". Then when I startup that region that I want to be part of this hypergrid, I use the command: "link-region <URI of xml file> excludeList:MW-Party" <br />
<br />
This is so that my region doesn't try to create a hyper link to itself.<br />
<br />
==== Method 3 (dynamic) ====<br />
<br />
Starting in r8193, if you're in an HG-enabled region, you'll be able <br />
to dynamically link sims, and TP there, in any one of these ways (and <br />
probably more). All you need to know is the target addresse, e.g. from the<br />
list below.<br />
<br />
1) Type for example secondlife://ucigrid04.nacs.uci.edu:9007/ in the <br />
chat box, pull up the chat history and click on that link<br />
<br />
2) Pull up the map and search for things like <br />
ucigrid04.nacs.uci.edu:9007<br />
<br />
3) Using the embedded browser visit pages that have links like <br />
secondlife://ucigrid04.nacs.uci.edu:9007/ (there's one up at<br />
http://www.ics.uci.edu/~lopes/hypergrid/test.html)<br />
<br />
Again, you can link to a specific region within an instance by adding the name of that region at the end, like this:<br />
secondlife://ucigrid04.nacs.uci.edu:9007:Gateway 7000/<br />
<br />
'''Important Note'''<br />
<br />
Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.<br />
<br />
<br />
<br />
<br />
== Public Hypergrid Nodes ==<br />
<br />
Please see [[Public Hypergrid Nodes]].<br />
<br />
<br />
== Hypergrid Lists ==<br />
Please see [[Hypergrid Lists]].<br />
<br />
== Manuals and Tutorials ==<br />
<br />
* '''Unofficial Hypernauta's Basic Manual''': If you are a real beginner it can be for you. Talking about "personal" worlds created using domestic computers. [http://www.dmu.com/opensime LINK]<br />
<br />
== Development Meetings ==<br />
<br />
[[Hypergrid Meetings]]<br />
<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/HypergridHypergrid2009-02-13T19:27:47Z<p>Rtkwebman: /* Banning Foreign Users */</p>
<hr />
<div>==The OpenSim Hypergrid==<br />
<br />
<br />
=== What is the hypergrid? ===<br />
<!-- [[image:VWV.jpg|250px|thumb|Web of Virtual Worlds]] --><br />
<br />
The hypergrid is an extension to opensim that allows you to link your opensim to other opensims on the internet, and that supports seamless agent transfers among those opensims. It can be used both in standalone mode and in grid mode. The hypergrid is effectively supporting the emergence of a Web of virtual worlds. <br />
<br />
The basic idea for the hypergrid is that region/grid administrations can place hyperlinks on their map to hypergrided regions run by others. Once those hyperlinks are established, users interact with those regions in exactly the same way as they interact with local regions. Specifically, users can choose to teleport there. Once the user reaches the region behind the hyperlink, she is automatically interacting with a different virtual world without having to logout from the world where she came from, and while still having access to her inventory.<br />
<br />
The hypergrid started as a GForge project, but it is now included in the standard distribution of OpenSim. To run your OpenSim instance in hypergrid mode, please see [[Hypergrid#Installing_and_Running_Hypergrid|Installing and Running]].<br />
<br />
=== Virtual World Hyperlinks ===<br />
[[image:hghyperlink.jpg|250px|thumb|A Virtual World Hyperlink]]<br />
<br />
We're all familiar with hypertext links on the Web. But what is a virtual world hyperlink?<br />
<br />
In the hypergrid model, we consider the 2D map of the virtual world as the equivalent of a web page. As such, a VW hyperlink is simply a region on that map. <br />
<br />
The default model of opensim-based virtual worlds already supports this concept of hyperlink, to some extent. When you teleport from one region to another via the map, chances are you are migrating your agent into a different opensim server. This migration is a glorified "agent transfer" that also exists, in rudimentary form, on the web when hypertext links are followed. The default model, however, imposes two very strong constraints on these hyperlinks: <br />
# The entire map of regions is controlled by a central service known as the grid service, whose job is to provide a uniform view of the world to all of its regions.<br />
# The only agents that can be transferred are those pertaining to users known to another central service, the user service; if the incoming user is not on that service's database, the agent transfer doesn't go through.<br />
<br />
The hypergrid simply removes these two constraints. <br />
<br />
First, it allows individual opensim instances to add "neighbors" to their local map, shifting the control of the map down from the grid server to individual opensim instances (although hyperlinks can also be served by grid servers if grid admins so wish). In doing so, the world becomes a lot more interesting and varied. The map that you see in one opensim instance may be completely different from the map that you see after you teleport via an hyperlink. As an opensim administrator, you are free to define what other opensims you want to see on your map.<br />
<br />
Second, it allows the transfer of agents pertaining to foreigner users, i.e. users who are registered elsewhere. Instead of assuming one central user service, the hypergrid assumes an arbitrarily large number of such services distributed all over the world. As such, when agents are transferred among hypergrided opensims, a lot more information is passed about the corresponding user. That information includes the collection of servers that the transferring user needs.<br />
<br />
=== Usage Scenarios ===<br />
<br />
The following are some usage scenarios. There isn't a clear separation between these scenarios, there's a large overlap between them. This is also not an exhaustive list. The purpose of these descriptions is to give you some starting ideas for how to use the hypergrid in practice. Please feel free to add other interesting scenarios to this list.<br />
<br />
{| {{Prettytable}}<br />
|-<br />
|<br />
[[image:topoA.jpg|400px|left]]<br />
|<br />
'''Personal Worlds'''<br />
<br />
This first scenario pertains to standalone opensims. Normally, standalones are completely disconnected from the internet. However, when run in hypergrid mode, standalones become network-able. As such, you can run your own world in your own computer, and link your world to whoever you want. For example, you can link to your friends' hypergrided opensims and to hypergrid gateways in open grids such as OSGrid. <br />
<br />
The great thing about this scenario is that all of your assets are stored on your computer, and not on somebody else's server. You can back them up using ordinary backend tools. The not so great thing about this scenario is that all of your assets are stored on your computer! If your disk goes berserk, you loose them. (so make sure you make external backups regularly)<br />
<br />
|-<br />
|<br />
[[image:topoB.jpg|400px|left]]<br />
|<br />
'''Communities'''<br />
<br />
This second scenario is about communities, broadly construed. The idea here is that a group of people come together to support a small community grid, i.e. a common world where shared activities take place. But at the same time, the members of the community maintain their own standalone worlds. The standalones link to the community grid, and the community grid may link back to the individual members' worlds and other places of interest.<br />
<br />
The members' identities are probably the identities they have on their standalones, and their assets are also probably stored there. The assets present in the community regions, however, are stored on the grid asset server.<br />
<br />
|-<br />
|<br />
[[image:topoC.jpg|400px|left]]<br />
|<br />
'''Grid Public Regions'''<br />
<br />
Walled-gardens are here to stay, and they serve many useful purposes. There is a hybrid mode for the hypergrid that some walled-garden grid operators may be interested in supporting. In this hybrid mode, most opensim instances on the grid run in normal, wall-garden mode, so no foreign visitors are allowed there - technically it is impossible to reach them. However, a few opensim instances on that grid can run in hypergrid mode, so that foreign visitors are allowed. This way, there is a gateway for grid-local users and arbitrary visitors to meet. This is also a good strategy for attracting new users to the grid, since random users are able to visit those gateway regions without having to sign up for an account upfront.<br />
<br />
This hybrid mode is very similar to what happens on the web. For example, anyone can visit Facebook's public pages without having to sign up for a Facebook account. However, only Facebook users can go further inside.<br />
<br />
|-<br />
|<br />
[[image:topoD.jpg|400px|left]]<br />
|<br />
'''Level Games'''<br />
<br />
The normal version of OpenSim enforces a common map for all the regions on a grid. The hypergrid removes that constraint. As such, it becomes easy to design VW games where the world looks different depending of where the player is. <br />
<br />
|-<br />
|}<br />
<br />
<br />
<br />
== Hypergrid Implementation ==<br />
<br />
=== Hyperlinks and Agent Transfers ===<br />
<br />
When you establish a link between your opensim and another, a message is sent out to that other opensim requesting information about it; the required information includes the network information of that opensim host, and the coordinates of its first region on its local grid in the form of a region handle. For example, suppose you are linking node X.com:9000, placing it in your local map at 900, 900. That opensim runs one or more regions that likely are not in 900, 900 on their own map; suppose the first region of that opensim is at 1100, 1100. From your point of view, it doesn't matter what those other coordinates are, and you don't need to know -- that's the key to being able to decentralize the "world" as given by a 2D map; you want to place it in your map at 900, 900. The "true" position of that simulator only matters for the LL viewer, when there are teleports between your world and that other opensim. This mapping between coordinate systems is the essence of hyperlinks for opensim; it's one simple but critical thing that the hypergrid implementation does. The mapping happens on the TeleportFinish event; instead of sending the local coordinates to the viewer, the hypergrid teleport wrapper sends the remote coordinates.<br />
<br />
When an agent teleports through that hyperlink the following happens. First, before InformRegionOfChildAgent, the local opensim notifies the remote opensim of this foreign user via the "expect_hg_user" method. That message sends along the addresses of all the servers that this user uses, i.e. user, inventory and asset servers. The remote opensim places an entry for that user in its local user profile cache but not in its user database; the foreign user information is non-persistent. After that, the teleport process is exactly the same as the normal teleport process; the only difference is that the region handles are switched between the remote region's hyperlink position on the local grid and its actual position on its grid. <br />
<br />
In summary, the two new concepts introduced by the hypergrid are the concept of an hyperlink and the concept of a "local user" vs. "foreign user".<br />
<br />
=== Inventory Access ===<br />
<br />
Inventory access from abroad is done by wrapping the existing scene-inventory interactions with additional code that gets or posts inventory assets from/to the user's asset server. When inventory is accessed, the hypergrid wrapper checks if the user is foreign and, if she is, the wrapper simply brings the necessary assets from the user's asset server to the local asset cache and server; from then on, the wrapper passes the control to the existing inventory access functions. When something is added to inventory, the hypergrid wrapper is notified via an event, and posts the assets to the user's asset server. A cache of the exchanged item identifiers is maintained so that they aren't brought back over and over again.<br />
<br />
The result is that hypergrided opensim instances end up interacting with several asset servers, instead of just one. That interaction is implemented in a straightforward manner by instantiating several GridAssetClient objects, instead of just one.<br />
<br />
=== The Hypergrid Classes ===<br />
<br />
Currently, the hypergrid is implemented outside of the OpenSim namespace, so that there is complete separation between what already exists and this new behavior. It has its own namespace, HyperGrid. In it, there are 4 sub-namespaces that follow directly the software architecture of OpenSim, namely:<br />
<br />
* '''OpenSim.Framework''':<br />
** ForeignUserProfileData extends UserProfileData by introducing information about the user's "home", namely the home address, port and remoting port. The user's home is not that user's user service; it's the opensim that the user has defined to be her home. This is necessary for supporting the home jump (Ctrl-Shift-H).<br />
** HGNetworkServersInfo follows the spirit of NetworkServersInfo, although it neither extends it nor uses it. For now, it's a utility class whose two main functions are to convert domain names of servers to IP addresses, and to uniformly provide the answer to the question bool IsLocalUser(...).<br />
<br />
* '''OpenSim.Region.Framework.Scenes.Hypergrid''':<br />
** HGSceneCommunicationService extends SceneCommunicationService, overriding RequestTeleportToLocation. There are two very small but critical changes to the base method: (a) on the TeleportFinish event, we switch the region handles when the destination region is an hyperlink; (b) the connections at the end are always closed for hyperlink TPs.<br />
** HGScene extends Scene, overriding TeleportClientHome(...). The only change to the base method is to stay away from the user server, for now, because the user service is still not completely wrapped up for foreign users. Once the user service is properly wrapped up, this class will become unnecessary.<br />
** HGScene.Inventory is a partial class of HGScene, just like what happens in the OpenSim framework. This part of HGScene overrides some inventory-scene interaction methods, so that assets are fetched/posted from/to the user's asset server. Once that extra fetching/posting is done, these methods simply pass the ball to the base methods.<br />
** HGAssetMapper: this is a new class specific to the hypergrid that manages the fetching and posting of assets between foreign regions where the user is and the user's asset server.<br />
<br />
* '''OpenSim.Region.Communications.HyperGrid''' is a mashup of OpenSim.Region.Communications.*. This is the place where most of the hypergrid extension lies. One of the reasons for this is that the hypergrid communications part is doing one additional thing: it is making standalones network-able.<br />
** HGCommunicationsStandalone extends CommuniationsLocal. Just as its base, it is a hub for the several network services available in standalone mode. The main difference is that those services are extensions of what's in OpenSim.<br />
** HGCommunicationsGridMode extends CommunicationsManager directly. Again, it's a hub for the network services available in grid mode, those services being extensions of OpenSim.<br />
** The cluster HGGridServices (superclass), HGGridServicesStandalone and HGGridServicesGridMode (subclasses) implements the OpenSim interfaces IGridServices and IInterRegionCommunications. The 2 subclasses are wrappers for LocalBackEndServices and OGS1GridServices, respectively. There is one common pattern throughout these classes: check if the region to talk to is an hyperlink; if it's not, simply delegate the work to LocalBackEndServices/OGS1GridServices; if it is, push the work to the base class HGGridServices. HGGridServices, in turn, does the management of hyperlink regions, and defines two additional pieces of inter-region protocol:<br />
*** region_uuid: for linking regions<br />
*** expect_hg_user: similar to the existing expect_user interface, but with a lot more information about the user being passed around, namely all the user's servers (inventory, asset, user, home, etc.)<br />
** HGInventoryService extends LocalInventoryService and implements ISecureInventoryService. This class is the most obvious mashup of the pack, mixing local service access for standalone users and remote inventory access for when users are out and about. Right now, there is a fair amount of selective copy-and-paste, to stay away from the ugliness coming from OGS1InventoryService and OGS1SecureInventoryService. HGInventoryService is always a ISecureInventoryService. Its methods all follow the same pattern: check if the user is a local standalone user; if it is, pass the work to the base method (in LocalInventoryService); if it's not perform secure remote access.<br />
** HGUserServices wraps OSG1UserServices, but it's not functional yet.<br />
<br />
* '''OpenSim.Region.CoreModules.HyperGrid''' is a collection of 3 region modules:<br />
** HGWorldMapModule extends WorldMapModule. It reuses almost everything from the base class. The only small change is in RequestMapBlocks, where it tries to send Offline mapblocks to the client.<br />
** HGStandaloneInventoryService and HGStandaloneAssetService do what their names say. They are region modules that allow access to inventory and assets for standalones, when the standalone user is out and about. In spirit, there is a lot in common between these modules and the REST inventory/asset plugin. Unfortunately, that plugin could not be used because it defines a completely different interface than that used by existing inventory and asset servers, and the access for the hypergrid must use a consistent interface.<br />
<br />
<br />
== Installing and Running Hypergrid ==<br />
<br />
=== Installing ===<br />
<br />
# Checkout OpenSim, prebuild and build as normal.<br />
# <br />
#* If you're running your opensim in grid mode with the UGAIM servers on other machines, you're done. If you're running in standalone and you want it to be network-able, or if you have your grid on loopback (127.0.0.1) change all the [Network] server addresses to <nowiki>"http://<external_host_name>:<http_port>"</nowiki>. See below.<br />
# Run opensim like this: <nowiki>[mono] OpenSim.exe -hypergrid=true</nowiki>. To make sure the hypergrid is running type this on your console: '''link-region'''. If you don't hear anything back, the hypergrid is not properly installed.<br />
'''[mono] OpenSim.exe -hypergrid=true'''<br />
<br />
Here is an example of the Network settings for a standalone:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:9300<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:9300<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:9300<br />
inventory_server_url = http://example.com:9300<br />
messaging_server_url = http://example.com:9300<br />
<br />
<br />
Here is an example of the Network settings for a grided opensim:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:8001<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:8002<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:8003<br />
inventory_server_url = http://example.com:8004<br />
; Port 8005 reserved<br />
messaging_server_url = http://example.com:8006<br />
<br />
<br />
'''Important Note'''<br />
<br />
Make sure you have a 'home' set. If your home region doesn't exist, the hyperlink TPs may not work. To set your home, go to one of your local regions and "Set Home" from the viewer.<br />
<br />
=== Linking regions ===<br />
<br />
==== Method 1 ====<br />
<br />
On the console, type for example:<br />
<br />
link-region <Xloc> <Yloc> osl2.nac.uci.edu:9006<br />
<br />
* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.<br />
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the http_listener_port of the simulator where the region is running you want to link to<br />
<br />
You can link to a specific region within an instance, by using the name of the region at the end, for example:<br />
<br />
link-region 997 997 osl2.nac.uci.edu:9006:UCI Welcome<br />
<br />
==== Method 2 ====<br />
<br />
There is also some initial support for reading the links from a xml file.<br />
<br />
Use the console command: link-region <URI> [<excludeList>]<br />
<br />
The uri can be either the path of a local xml file or a xml document on a http server.<br />
<br />
The format of the xml file is:<br />
<br />
<Nini><br />
<Section Name="Region1"> <!-- can be any name but each section should have a different name and have no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
<Key Name="real-xloc" Value="10222"/> //optional field that gives the region's real location on its home grid<br />
<Key Name="real-yloc" Value="10265" /> //optional field that gives the region's real location on its home grid<br />
</Section><br />
<Section Name="Region2"> <br />
...<br />
</Section><br />
...<br />
</Nini><br />
<br />
[Note] The section names can be anything you want, but they all should be different and have no spaces in the name.<br />
<br />
<br />
ExcludeList:<br />
<br />
The exclude list is a single string paramater with the format: excludeList:<SectionName>[;<SectionName>]<br />
<br />
This means that while reading from the xml file any sections that are listed in the excludeList will be ignored and no HyperGrid link created for them.<br />
<br />
This could allow, link lists to be created on a webserver that everyone could add their own regions to, and then they just make sure they add their own section name(s) to the exclude list on their own region(s). <br />
<br />
So for example, someone might create a editable online list for the up coming OpenSimulator's 2nd birthday. Which might look something like:<br />
<br />
<Nini><br />
<Section Name="OSGrid-Party"> <!-- can be any name but each section should have a different name and no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
</Section><br />
<Section Name="UCIGrid-Party"> <br />
...<br />
</Section><br />
</Nini><br />
<br />
I could then add my own region to the list with the section name "MW-Party". Then when I startup that region that I want to be part of this hypergrid, I use the command: "link-region <URI of xml file> excludeList:MW-Party" <br />
<br />
This is so that my region doesn't try to create a hyper link to itself.<br />
<br />
==== Method 3 (dynamic) ====<br />
<br />
Starting in r8193, if you're in an HG-enabled region, you'll be able <br />
to dynamically link sims, and TP there, in any one of these ways (and <br />
probably more). All you need to know is the target addresse, e.g. from the<br />
list below.<br />
<br />
1) Type for example secondlife://ucigrid04.nacs.uci.edu:9007/ in the <br />
chat box, pull up the chat history and click on that link<br />
<br />
2) Pull up the map and search for things like <br />
ucigrid04.nacs.uci.edu:9007<br />
<br />
3) Using the embedded browser visit pages that have links like <br />
secondlife://ucigrid04.nacs.uci.edu:9007/ (there's one up at<br />
http://www.ics.uci.edu/~lopes/hypergrid/test.html)<br />
<br />
Again, you can link to a specific region within an instance by adding the name of that region at the end, like this:<br />
secondlife://ucigrid04.nacs.uci.edu:9007:Gateway 7000/<br />
<br />
'''Important Note'''<br />
<br />
Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.<br />
<br />
<br />
<br />
<br />
== Public Hypergrid Nodes ==<br />
<br />
Please see [[Public Hypergrid Nodes]].<br />
<br />
<br />
== Hypergrid Lists ==<br />
Please see [[Hypergrid Lists]].<br />
<br />
== Manuals and Tutorials ==<br />
<br />
* '''Unofficial Hypernauta's Basic Manual''': If you are a real beginner it can be for you. Talking about "personal" worlds created using domestic computers. [http://www.dmu.com/opensime LINK]<br />
<br />
== Development Meetings ==<br />
<br />
[[Hypergrid Meetings]]<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Banning_Foreign_Users_in_HypergridBanning Foreign Users in Hypergrid2009-02-13T19:27:25Z<p>Rtkwebman: </p>
<hr />
<div>=== Banning Foreign Users ===<br />
<br />
Even though the current viewers are incapable of dealing with foreign users, it is possible to ban specific foreign users from your estates. For now, you have to do it on the backend, i.e. directly editing the database and reviewing the log. Not easy for the faint of heart, but any sys admin should be able to do this with their eyes shut. What follows are instructions for adding a foreign user to the estate's ban list. <br />
<br />
The first thing you need to do is to find out the UUID and IP address of the user you want to ban. For that you need to look at OpenSim.log. Search for log messages like this:<br />
<br />
2009-01-23 03:45:11,995 INFO - OpenSim.Region.Communications.Hypergrid.HGGridServicesGridMode [HGrid]: Incoming HGrid Agent<br />
Annoying.Person http://problematic.domain.org:9002<br />
2009-01-23 03:45:11,995 DEBUG - OpenSim.Region.Environment.Scenes.Scene [CONNECTION BEGIN]: Region Gateway 3000 told of incoming client<br />
Annoying.Person http://problematic.domain.org:9002 c3c9ecbf-bfb3-43eb-8dce-140afad7995f (circuit code 1896255323)<br />
<br />
In this case, the information you need is: UUID = c3c9ecbf-bfb3-43eb-8dce-140afad7995f and IPAddress = problematic.domain.org<br />
<br />
Next, let's add this foreign user to the ban list. Note that the estate information and ban lists are kept at the region server, not in the UGAIM. If you are using local storage for your regions, this information is stored in bin/OpenSim.db. So, open that DB with whatever tool you use to access your DBs. The instructions here assume a local sqlite database; if you're using MySql or other DB technologies for the regions' storage, the instructions are almost identical, but may need adjustments.<br />
<br />
SqlLite usually comes with a common Linux installation. In Linux, just type:<br />
<br />
$ sqlite3 OpenSim.db<br />
<br />
In Windows, you need to get it from [http://www.sqlite.org/download.html here]. Once installed, run it on your OpenSim.db, like this, for example (on a command shell):<br />
<br />
$ C:/Opt/SQLite3/sqlite3.exe OpenSim.db<br />
<br />
Once you are connected to the database, you can explore as much as you want. What follows are the concrete interactions you need for adding that foreign user into an estate ban list. Change the data for your situation.<br />
<br />
[opensim@ucigrid04 bin]$ sqlite3 OpenSim.db<br />
SQLite version 3.3.6<br />
Enter ".help" for instructions<br />
sqlite> .tables<br />
estate_groups estate_users migrations regionban<br />
estate_managers estateban primitems regionsettings<br />
estate_map land prims terrain<br />
estate_settings landaccesslist primshapes<br />
sqlite> .schema estateban<br />
CREATE TABLE estateban (<br />
EstateID int(10) NOT NULL,<br />
bannedUUID varchar(36) NOT NULL,<br />
bannedIp varchar(16) NOT NULL,<br />
bannedIpHostMask varchar(16) NOT NULL,<br />
bannedNameMask varchar(64) default NULL<br />
);<br />
CREATE INDEX estate_ban_estate_id on estateban(EstateID);<br />
sqlite> select EstateID, EstateName from estate_settings;<br />
100|My Estate<br />
101|My Estate<br />
102|My Estate<br />
103|My Estate<br />
sqlite> insert into estateban values (100, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> insert into estateban values (101, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> insert into estateban values (102, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> insert into estateban values (103, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> select * from estateban;<br />
100|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
101|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
102|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
103|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
sqlite> .quit<br />
<br />
Once this data is entered you need to restart OpenSim, so that it gets loaded.<br />
<br />
[[Category:Hypergrid]]<br />
[[Category:Security]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Banning_Foreign_Users_in_HypergridBanning Foreign Users in Hypergrid2009-02-13T19:25:52Z<p>Rtkwebman: </p>
<hr />
<div>[[Category:Hypergrid]]<br />
[[Category:Security]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Banning_Foreign_Users_in_HypergridBanning Foreign Users in Hypergrid2009-02-13T19:24:44Z<p>Rtkwebman: New page: Category:Hypergid Category:Security</p>
<hr />
<div>[[Category:Hypergid]]<br />
[[Category:Security]]</div>Rtkwebmanhttp://opensimulator.org/wiki/HypergridHypergrid2009-02-13T19:14:59Z<p>Rtkwebman: /* Security Concerns */</p>
<hr />
<div>==The OpenSim Hypergrid==<br />
<br />
<br />
=== What is the hypergrid? ===<br />
<!-- [[image:VWV.jpg|250px|thumb|Web of Virtual Worlds]] --><br />
<br />
The hypergrid is an extension to opensim that allows you to link your opensim to other opensims on the internet, and that supports seamless agent transfers among those opensims. It can be used both in standalone mode and in grid mode. The hypergrid is effectively supporting the emergence of a Web of virtual worlds. <br />
<br />
The basic idea for the hypergrid is that region/grid administrations can place hyperlinks on their map to hypergrided regions run by others. Once those hyperlinks are established, users interact with those regions in exactly the same way as they interact with local regions. Specifically, users can choose to teleport there. Once the user reaches the region behind the hyperlink, she is automatically interacting with a different virtual world without having to logout from the world where she came from, and while still having access to her inventory.<br />
<br />
The hypergrid started as a GForge project, but it is now included in the standard distribution of OpenSim. To run your OpenSim instance in hypergrid mode, please see [[Hypergrid#Installing_and_Running_Hypergrid|Installing and Running]].<br />
<br />
=== Virtual World Hyperlinks ===<br />
[[image:hghyperlink.jpg|250px|thumb|A Virtual World Hyperlink]]<br />
<br />
We're all familiar with hypertext links on the Web. But what is a virtual world hyperlink?<br />
<br />
In the hypergrid model, we consider the 2D map of the virtual world as the equivalent of a web page. As such, a VW hyperlink is simply a region on that map. <br />
<br />
The default model of opensim-based virtual worlds already supports this concept of hyperlink, to some extent. When you teleport from one region to another via the map, chances are you are migrating your agent into a different opensim server. This migration is a glorified "agent transfer" that also exists, in rudimentary form, on the web when hypertext links are followed. The default model, however, imposes two very strong constraints on these hyperlinks: <br />
# The entire map of regions is controlled by a central service known as the grid service, whose job is to provide a uniform view of the world to all of its regions.<br />
# The only agents that can be transferred are those pertaining to users known to another central service, the user service; if the incoming user is not on that service's database, the agent transfer doesn't go through.<br />
<br />
The hypergrid simply removes these two constraints. <br />
<br />
First, it allows individual opensim instances to add "neighbors" to their local map, shifting the control of the map down from the grid server to individual opensim instances (although hyperlinks can also be served by grid servers if grid admins so wish). In doing so, the world becomes a lot more interesting and varied. The map that you see in one opensim instance may be completely different from the map that you see after you teleport via an hyperlink. As an opensim administrator, you are free to define what other opensims you want to see on your map.<br />
<br />
Second, it allows the transfer of agents pertaining to foreigner users, i.e. users who are registered elsewhere. Instead of assuming one central user service, the hypergrid assumes an arbitrarily large number of such services distributed all over the world. As such, when agents are transferred among hypergrided opensims, a lot more information is passed about the corresponding user. That information includes the collection of servers that the transferring user needs.<br />
<br />
=== Usage Scenarios ===<br />
<br />
The following are some usage scenarios. There isn't a clear separation between these scenarios, there's a large overlap between them. This is also not an exhaustive list. The purpose of these descriptions is to give you some starting ideas for how to use the hypergrid in practice. Please feel free to add other interesting scenarios to this list.<br />
<br />
{| {{Prettytable}}<br />
|-<br />
|<br />
[[image:topoA.jpg|400px|left]]<br />
|<br />
'''Personal Worlds'''<br />
<br />
This first scenario pertains to standalone opensims. Normally, standalones are completely disconnected from the internet. However, when run in hypergrid mode, standalones become network-able. As such, you can run your own world in your own computer, and link your world to whoever you want. For example, you can link to your friends' hypergrided opensims and to hypergrid gateways in open grids such as OSGrid. <br />
<br />
The great thing about this scenario is that all of your assets are stored on your computer, and not on somebody else's server. You can back them up using ordinary backend tools. The not so great thing about this scenario is that all of your assets are stored on your computer! If your disk goes berserk, you loose them. (so make sure you make external backups regularly)<br />
<br />
|-<br />
|<br />
[[image:topoB.jpg|400px|left]]<br />
|<br />
'''Communities'''<br />
<br />
This second scenario is about communities, broadly construed. The idea here is that a group of people come together to support a small community grid, i.e. a common world where shared activities take place. But at the same time, the members of the community maintain their own standalone worlds. The standalones link to the community grid, and the community grid may link back to the individual members' worlds and other places of interest.<br />
<br />
The members' identities are probably the identities they have on their standalones, and their assets are also probably stored there. The assets present in the community regions, however, are stored on the grid asset server.<br />
<br />
|-<br />
|<br />
[[image:topoC.jpg|400px|left]]<br />
|<br />
'''Grid Public Regions'''<br />
<br />
Walled-gardens are here to stay, and they serve many useful purposes. There is a hybrid mode for the hypergrid that some walled-garden grid operators may be interested in supporting. In this hybrid mode, most opensim instances on the grid run in normal, wall-garden mode, so no foreign visitors are allowed there - technically it is impossible to reach them. However, a few opensim instances on that grid can run in hypergrid mode, so that foreign visitors are allowed. This way, there is a gateway for grid-local users and arbitrary visitors to meet. This is also a good strategy for attracting new users to the grid, since random users are able to visit those gateway regions without having to sign up for an account upfront.<br />
<br />
This hybrid mode is very similar to what happens on the web. For example, anyone can visit Facebook's public pages without having to sign up for a Facebook account. However, only Facebook users can go further inside.<br />
<br />
|-<br />
|<br />
[[image:topoD.jpg|400px|left]]<br />
|<br />
'''Level Games'''<br />
<br />
The normal version of OpenSim enforces a common map for all the regions on a grid. The hypergrid removes that constraint. As such, it becomes easy to design VW games where the world looks different depending of where the player is. <br />
<br />
|-<br />
|}<br />
<br />
<br />
<br />
== Hypergrid Implementation ==<br />
<br />
=== Hyperlinks and Agent Transfers ===<br />
<br />
When you establish a link between your opensim and another, a message is sent out to that other opensim requesting information about it; the required information includes the network information of that opensim host, and the coordinates of its first region on its local grid in the form of a region handle. For example, suppose you are linking node X.com:9000, placing it in your local map at 900, 900. That opensim runs one or more regions that likely are not in 900, 900 on their own map; suppose the first region of that opensim is at 1100, 1100. From your point of view, it doesn't matter what those other coordinates are, and you don't need to know -- that's the key to being able to decentralize the "world" as given by a 2D map; you want to place it in your map at 900, 900. The "true" position of that simulator only matters for the LL viewer, when there are teleports between your world and that other opensim. This mapping between coordinate systems is the essence of hyperlinks for opensim; it's one simple but critical thing that the hypergrid implementation does. The mapping happens on the TeleportFinish event; instead of sending the local coordinates to the viewer, the hypergrid teleport wrapper sends the remote coordinates.<br />
<br />
When an agent teleports through that hyperlink the following happens. First, before InformRegionOfChildAgent, the local opensim notifies the remote opensim of this foreign user via the "expect_hg_user" method. That message sends along the addresses of all the servers that this user uses, i.e. user, inventory and asset servers. The remote opensim places an entry for that user in its local user profile cache but not in its user database; the foreign user information is non-persistent. After that, the teleport process is exactly the same as the normal teleport process; the only difference is that the region handles are switched between the remote region's hyperlink position on the local grid and its actual position on its grid. <br />
<br />
In summary, the two new concepts introduced by the hypergrid are the concept of an hyperlink and the concept of a "local user" vs. "foreign user".<br />
<br />
=== Inventory Access ===<br />
<br />
Inventory access from abroad is done by wrapping the existing scene-inventory interactions with additional code that gets or posts inventory assets from/to the user's asset server. When inventory is accessed, the hypergrid wrapper checks if the user is foreign and, if she is, the wrapper simply brings the necessary assets from the user's asset server to the local asset cache and server; from then on, the wrapper passes the control to the existing inventory access functions. When something is added to inventory, the hypergrid wrapper is notified via an event, and posts the assets to the user's asset server. A cache of the exchanged item identifiers is maintained so that they aren't brought back over and over again.<br />
<br />
The result is that hypergrided opensim instances end up interacting with several asset servers, instead of just one. That interaction is implemented in a straightforward manner by instantiating several GridAssetClient objects, instead of just one.<br />
<br />
=== The Hypergrid Classes ===<br />
<br />
Currently, the hypergrid is implemented outside of the OpenSim namespace, so that there is complete separation between what already exists and this new behavior. It has its own namespace, HyperGrid. In it, there are 4 sub-namespaces that follow directly the software architecture of OpenSim, namely:<br />
<br />
* '''OpenSim.Framework''':<br />
** ForeignUserProfileData extends UserProfileData by introducing information about the user's "home", namely the home address, port and remoting port. The user's home is not that user's user service; it's the opensim that the user has defined to be her home. This is necessary for supporting the home jump (Ctrl-Shift-H).<br />
** HGNetworkServersInfo follows the spirit of NetworkServersInfo, although it neither extends it nor uses it. For now, it's a utility class whose two main functions are to convert domain names of servers to IP addresses, and to uniformly provide the answer to the question bool IsLocalUser(...).<br />
<br />
* '''OpenSim.Region.Framework.Scenes.Hypergrid''':<br />
** HGSceneCommunicationService extends SceneCommunicationService, overriding RequestTeleportToLocation. There are two very small but critical changes to the base method: (a) on the TeleportFinish event, we switch the region handles when the destination region is an hyperlink; (b) the connections at the end are always closed for hyperlink TPs.<br />
** HGScene extends Scene, overriding TeleportClientHome(...). The only change to the base method is to stay away from the user server, for now, because the user service is still not completely wrapped up for foreign users. Once the user service is properly wrapped up, this class will become unnecessary.<br />
** HGScene.Inventory is a partial class of HGScene, just like what happens in the OpenSim framework. This part of HGScene overrides some inventory-scene interaction methods, so that assets are fetched/posted from/to the user's asset server. Once that extra fetching/posting is done, these methods simply pass the ball to the base methods.<br />
** HGAssetMapper: this is a new class specific to the hypergrid that manages the fetching and posting of assets between foreign regions where the user is and the user's asset server.<br />
<br />
* '''OpenSim.Region.Communications.HyperGrid''' is a mashup of OpenSim.Region.Communications.*. This is the place where most of the hypergrid extension lies. One of the reasons for this is that the hypergrid communications part is doing one additional thing: it is making standalones network-able.<br />
** HGCommunicationsStandalone extends CommuniationsLocal. Just as its base, it is a hub for the several network services available in standalone mode. The main difference is that those services are extensions of what's in OpenSim.<br />
** HGCommunicationsGridMode extends CommunicationsManager directly. Again, it's a hub for the network services available in grid mode, those services being extensions of OpenSim.<br />
** The cluster HGGridServices (superclass), HGGridServicesStandalone and HGGridServicesGridMode (subclasses) implements the OpenSim interfaces IGridServices and IInterRegionCommunications. The 2 subclasses are wrappers for LocalBackEndServices and OGS1GridServices, respectively. There is one common pattern throughout these classes: check if the region to talk to is an hyperlink; if it's not, simply delegate the work to LocalBackEndServices/OGS1GridServices; if it is, push the work to the base class HGGridServices. HGGridServices, in turn, does the management of hyperlink regions, and defines two additional pieces of inter-region protocol:<br />
*** region_uuid: for linking regions<br />
*** expect_hg_user: similar to the existing expect_user interface, but with a lot more information about the user being passed around, namely all the user's servers (inventory, asset, user, home, etc.)<br />
** HGInventoryService extends LocalInventoryService and implements ISecureInventoryService. This class is the most obvious mashup of the pack, mixing local service access for standalone users and remote inventory access for when users are out and about. Right now, there is a fair amount of selective copy-and-paste, to stay away from the ugliness coming from OGS1InventoryService and OGS1SecureInventoryService. HGInventoryService is always a ISecureInventoryService. Its methods all follow the same pattern: check if the user is a local standalone user; if it is, pass the work to the base method (in LocalInventoryService); if it's not perform secure remote access.<br />
** HGUserServices wraps OSG1UserServices, but it's not functional yet.<br />
<br />
* '''OpenSim.Region.CoreModules.HyperGrid''' is a collection of 3 region modules:<br />
** HGWorldMapModule extends WorldMapModule. It reuses almost everything from the base class. The only small change is in RequestMapBlocks, where it tries to send Offline mapblocks to the client.<br />
** HGStandaloneInventoryService and HGStandaloneAssetService do what their names say. They are region modules that allow access to inventory and assets for standalones, when the standalone user is out and about. In spirit, there is a lot in common between these modules and the REST inventory/asset plugin. Unfortunately, that plugin could not be used because it defines a completely different interface than that used by existing inventory and asset servers, and the access for the hypergrid must use a consistent interface.<br />
<br />
<br />
== Installing and Running Hypergrid ==<br />
<br />
=== Installing ===<br />
<br />
# Checkout OpenSim, prebuild and build as normal.<br />
# <br />
#* If you're running your opensim in grid mode with the UGAIM servers on other machines, you're done. If you're running in standalone and you want it to be network-able, or if you have your grid on loopback (127.0.0.1) change all the [Network] server addresses to <nowiki>"http://<external_host_name>:<http_port>"</nowiki>. See below.<br />
# Run opensim like this: <nowiki>[mono] OpenSim.exe -hypergrid=true</nowiki>. To make sure the hypergrid is running type this on your console: '''link-region'''. If you don't hear anything back, the hypergrid is not properly installed.<br />
'''[mono] OpenSim.exe -hypergrid=true'''<br />
<br />
Here is an example of the Network settings for a standalone:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:9300<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:9300<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:9300<br />
inventory_server_url = http://example.com:9300<br />
messaging_server_url = http://example.com:9300<br />
<br />
<br />
Here is an example of the Network settings for a grided opensim:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:8001<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:8002<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:8003<br />
inventory_server_url = http://example.com:8004<br />
; Port 8005 reserved<br />
messaging_server_url = http://example.com:8006<br />
<br />
<br />
'''Important Note'''<br />
<br />
Make sure you have a 'home' set. If your home region doesn't exist, the hyperlink TPs may not work. To set your home, go to one of your local regions and "Set Home" from the viewer.<br />
<br />
=== Linking regions ===<br />
<br />
==== Method 1 ====<br />
<br />
On the console, type for example:<br />
<br />
link-region <Xloc> <Yloc> osl2.nac.uci.edu:9006<br />
<br />
* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.<br />
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the http_listener_port of the simulator where the region is running you want to link to<br />
<br />
You can link to a specific region within an instance, by using the name of the region at the end, for example:<br />
<br />
link-region 997 997 osl2.nac.uci.edu:9006:UCI Welcome<br />
<br />
==== Method 2 ====<br />
<br />
There is also some initial support for reading the links from a xml file.<br />
<br />
Use the console command: link-region <URI> [<excludeList>]<br />
<br />
The uri can be either the path of a local xml file or a xml document on a http server.<br />
<br />
The format of the xml file is:<br />
<br />
<Nini><br />
<Section Name="Region1"> <!-- can be any name but each section should have a different name and have no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
<Key Name="real-xloc" Value="10222"/> //optional field that gives the region's real location on its home grid<br />
<Key Name="real-yloc" Value="10265" /> //optional field that gives the region's real location on its home grid<br />
</Section><br />
<Section Name="Region2"> <br />
...<br />
</Section><br />
...<br />
</Nini><br />
<br />
[Note] The section names can be anything you want, but they all should be different and have no spaces in the name.<br />
<br />
<br />
ExcludeList:<br />
<br />
The exclude list is a single string paramater with the format: excludeList:<SectionName>[;<SectionName>]<br />
<br />
This means that while reading from the xml file any sections that are listed in the excludeList will be ignored and no HyperGrid link created for them.<br />
<br />
This could allow, link lists to be created on a webserver that everyone could add their own regions to, and then they just make sure they add their own section name(s) to the exclude list on their own region(s). <br />
<br />
So for example, someone might create a editable online list for the up coming OpenSimulator's 2nd birthday. Which might look something like:<br />
<br />
<Nini><br />
<Section Name="OSGrid-Party"> <!-- can be any name but each section should have a different name and no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
</Section><br />
<Section Name="UCIGrid-Party"> <br />
...<br />
</Section><br />
</Nini><br />
<br />
I could then add my own region to the list with the section name "MW-Party". Then when I startup that region that I want to be part of this hypergrid, I use the command: "link-region <URI of xml file> excludeList:MW-Party" <br />
<br />
This is so that my region doesn't try to create a hyper link to itself.<br />
<br />
==== Method 3 (dynamic) ====<br />
<br />
Starting in r8193, if you're in an HG-enabled region, you'll be able <br />
to dynamically link sims, and TP there, in any one of these ways (and <br />
probably more). All you need to know is the target addresse, e.g. from the<br />
list below.<br />
<br />
1) Type for example secondlife://ucigrid04.nacs.uci.edu:9007/ in the <br />
chat box, pull up the chat history and click on that link<br />
<br />
2) Pull up the map and search for things like <br />
ucigrid04.nacs.uci.edu:9007<br />
<br />
3) Using the embedded browser visit pages that have links like <br />
secondlife://ucigrid04.nacs.uci.edu:9007/ (there's one up at<br />
http://www.ics.uci.edu/~lopes/hypergrid/test.html)<br />
<br />
Again, you can link to a specific region within an instance by adding the name of that region at the end, like this:<br />
secondlife://ucigrid04.nacs.uci.edu:9007:Gateway 7000/<br />
<br />
'''Important Note'''<br />
<br />
Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.<br />
<br />
<br />
=== Banning Foreign Users ===<br />
<br />
Even though the current viewers are incapable of dealing with foreign users, it is possible to ban specific foreign users from your estates. For now, you have to do it on the backend, i.e. directly editing the database and reviewing the log. Not easy for the faint of heart, but any sys admin should be able to do this with their eyes shut. What follows are instructions for adding a foreign user to the estate's ban list. <br />
<br />
The first thing you need to do is to find out the UUID and IP address of the user you want to ban. For that you need to look at OpenSim.log. Search for log messages like this:<br />
<br />
2009-01-23 03:45:11,995 INFO - OpenSim.Region.Communications.Hypergrid.HGGridServicesGridMode [HGrid]: Incoming HGrid Agent<br />
Annoying.Person http://problematic.domain.org:9002<br />
2009-01-23 03:45:11,995 DEBUG - OpenSim.Region.Environment.Scenes.Scene [CONNECTION BEGIN]: Region Gateway 3000 told of incoming client<br />
Annoying.Person http://problematic.domain.org:9002 c3c9ecbf-bfb3-43eb-8dce-140afad7995f (circuit code 1896255323)<br />
<br />
In this case, the information you need is: UUID = c3c9ecbf-bfb3-43eb-8dce-140afad7995f and IPAddress = problematic.domain.org<br />
<br />
Next, let's add this foreign user to the ban list. Note that the estate information and ban lists are kept at the region server, not in the UGAIM. If you are using local storage for your regions, this information is stored in bin/OpenSim.db. So, open that DB with whatever tool you use to access your DBs. The instructions here assume a local sqlite database; if you're using MySql or other DB technologies for the regions' storage, the instructions are almost identical, but may need adjustments.<br />
<br />
SqlLite usually comes with a common Linux installation. In Linux, just type:<br />
<br />
$ sqlite3 OpenSim.db<br />
<br />
In Windows, you need to get it from [http://www.sqlite.org/download.html here]. Once installed, run it on your OpenSim.db, like this, for example (on a command shell):<br />
<br />
$ C:/Opt/SQLite3/sqlite3.exe OpenSim.db<br />
<br />
Once you are connected to the database, you can explore as much as you want. What follows are the concrete interactions you need for adding that foreign user into an estate ban list. Change the data for your situation.<br />
<br />
[opensim@ucigrid04 bin]$ sqlite3 OpenSim.db<br />
SQLite version 3.3.6<br />
Enter ".help" for instructions<br />
sqlite> .tables<br />
estate_groups estate_users migrations regionban<br />
estate_managers estateban primitems regionsettings<br />
estate_map land prims terrain<br />
estate_settings landaccesslist primshapes<br />
sqlite> .schema estateban<br />
CREATE TABLE estateban (<br />
EstateID int(10) NOT NULL,<br />
bannedUUID varchar(36) NOT NULL,<br />
bannedIp varchar(16) NOT NULL,<br />
bannedIpHostMask varchar(16) NOT NULL,<br />
bannedNameMask varchar(64) default NULL<br />
);<br />
CREATE INDEX estate_ban_estate_id on estateban(EstateID);<br />
sqlite> select EstateID, EstateName from estate_settings;<br />
100|My Estate<br />
101|My Estate<br />
102|My Estate<br />
103|My Estate<br />
sqlite> insert into estateban values (100, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> insert into estateban values (101, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> insert into estateban values (102, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> insert into estateban values (103, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> select * from estateban;<br />
100|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
101|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
102|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
103|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
sqlite> .quit<br />
<br />
Once this data is entered you need to restart OpenSim, so that it gets loaded.<br />
<br />
<br />
== Public Hypergrid Nodes ==<br />
<br />
Please see [[Public Hypergrid Nodes]].<br />
<br />
<br />
== Hypergrid Lists ==<br />
Please see [[Hypergrid Lists]].<br />
<br />
== Manuals and Tutorials ==<br />
<br />
* '''Unofficial Hypernauta's Basic Manual''': If you are a real beginner it can be for you. Talking about "personal" worlds created using domestic computers. [http://www.dmu.com/opensime LINK]<br />
<br />
== Development Meetings ==<br />
<br />
[[Hypergrid Meetings]]<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Hypergrid_SecurityHypergrid Security2009-02-13T19:14:29Z<p>Rtkwebman: New page: == Security Concerns == There is a wide-spread assumption that open grids such as OSGrid and new forms of grids such as the hypergrid are inherently insecure, and that it will be impossib...</p>
<hr />
<div>== Security Concerns ==<br />
<br />
There is a wide-spread assumption that open grids such as OSGrid and new forms of grids such as the hypergrid are inherently insecure, and that it will be impossible to develop a "goods-based" economy on top of them; only walled-gardens can be secured. This is both true and false. While it is true with the current state of things, open grids, whatever their form, can be made as secure as the web. The first step towards that is to define exactly what the security threats are, and how they affect (or not) open and closed grids. So, let's spell them out, and face them head-on. This will help put our feet on the ground so that we start developing appropriate solutions.<br />
<br />
=== Malicious Clients ===<br />
<br />
==== CopyBots ====<br />
<br />
Everyone knows about the infamous [http://en.wikipedia.org/wiki/CopyBot CopyBot]. Using libraries such as [http://www.libsecondlife.org/wiki/Main_Page LibSL] (now known as OpenMetaverse) it is possible to develop clients for opensim servers that do unorthodox things such as bypassing the permissions system to copy people's assets. Bots written by griefers can do lots of other nasty things.<br />
<br />
Malicious bots are a problem for all opensim administrators, including walled-garden grids. They can be prevented, to a certain extent, by exo-technical solutions such as Terms of Service and real-world lawsuits. Technically speaking, the only way to keep intruders out is to run opensim inside a firewall, pretty much like all other pieces of client/server software out there. If that's an acceptable solution for your case, you should do it.<br />
<br />
Unfortunately firewalls also keep the public out, and most opensim operators, even the ones running walled-garden grids, want to reach out to the public. In this case, opensim operators may develop additional technical obstacles for bots, similar to those we see on the Web. For example, make sure agents are being run by real people by giving them a human-challenge during the login/TP process, etc.<br />
<br />
Every obstacle to malicious clients lowers the risk of an intruder attack. However keep this in mind: no matter how many obstacles one builds, a sufficiently skilled and motivated attacker will be able to overcome them to penetrate opensims connected to the public internet. This affects hypergrid nodes as much as walled-garden grids. In fact, it's more pervasive than that: it affects '''all''' servers (opensim, web, etc.) connected to the public internet. Fighting malicious intruders is a fact of a connected world. Fortunately, those attacks don't happen very often, or the Web would have been dead by now.<br />
<br />
==== Web Clients ====<br />
<br />
CopyBots are the most well-known bots for opensim-based virtual worlds, but these virtual worlds are also susceptible to attacks by regular web clients. With the current state of things, it is actually easier to copy assets with a web-based client than with a libsl-based one. The weakness is that asset servers are connected to the public internet, and the protocol for interacting with them is public. <br />
<br />
OpenSim has some minimal guards in place to fence against these kinds of attacks. Specifically, when the inventory server receives a request for an item, it checks the session identifier of the requester. Web clients aren't logged in, so they are refused service. I don't want to expand much more on this, so not to make life easy for attackers, but let's just say that opensim has the necessary mechanisms in place to fence off web-based attackers.<br />
<br />
=== Malicious Hosts ===<br />
<br />
==== Actively Malicious Hosts ====<br />
<br />
The new security threat introduced by openness, one that does not exist in closed grids, is the possibility of a user to visit a region that is running malicious code. In the current state of opensim, a malicious host can do serious damage to the user's assets. Let's see how.<br />
<br />
Assume you have your assets in your hypergrided-standalone opensim, and you go visit another opensim that happens to be running malicious code. Here is a non-exhaustive list of vulnerabilities that you are exposed to:<br />
<br />
* The host has your session id, so it can request your inventory items on your behalf and store copies in its local asset server. To add insult to injury, a malicious host could simply wipe out your inventory after having copied it.<br />
* Even if the malicious host doesn't access your items by itself, every time you access items in your inventory while you are in that region, those items are cached in the region's local cache, and can be stored persistently by the malicious host.<br />
<br />
Malicious hosts can do a lot more damage, but those two are enough to illustrate this new kind of vulnerability affecting open grids. Note that this affects all open grids, i.e. those where arbitrary people can plug-in their opensims, and not just the hypergrid.<br />
<br />
Fortunately, there is a family of simple solutions to this problem that can be summarized as "protecting you from yourself." That proposal is described [[Hypergrid Inventory Access|here]].<br />
<br />
==== Piracy ====<br />
<br />
A second new security threat affecting open grids is one pertaining to commerce of virtual goods. Suppose you put something out for sale on your hypergrided opensim. A foreign user comes and buys it. What that really means is that that user will physically get a copy of the assets moved to his/her asset server, which is different from your asset server. The permissions will be whatever you define them to be, and using the regular VW client, that user can only do what you defined he/she should could do with the object, as usual. However, if the user has direct backend access to the asset and inventory servers, that person can simply modify the permissions on his/her copy. This is commonly known as '''piracy'''. (This is also a problem with programmers who have direct access to the cache that their client keeps; in this case, the only thing that needs to be done to enable piracy is for the user to actually see a texture/animation/in-world object. This does NOT allow scripts to be copied, though, since the script is only interpreted on the server and is never sent for interpretation by the client.)<br />
<br />
This situation is the kernel of the belief that open grids are hopeless for a virtual-goods economy. DRM discussion aside, maybe they are hopeless. But then, everyone thought the web was hopeless for selling music, and look at the success of iTunes in spite of all the piracy that still exists out there. Who will be the equivalent of iTunes for virtual hair, skin and clothes?</div>Rtkwebmanhttp://opensimulator.org/wiki/HypergridHypergrid2009-02-13T18:53:24Z<p>Rtkwebman: </p>
<hr />
<div>==The OpenSim Hypergrid==<br />
<br />
<br />
=== What is the hypergrid? ===<br />
<!-- [[image:VWV.jpg|250px|thumb|Web of Virtual Worlds]] --><br />
<br />
The hypergrid is an extension to opensim that allows you to link your opensim to other opensims on the internet, and that supports seamless agent transfers among those opensims. It can be used both in standalone mode and in grid mode. The hypergrid is effectively supporting the emergence of a Web of virtual worlds. <br />
<br />
The basic idea for the hypergrid is that region/grid administrations can place hyperlinks on their map to hypergrided regions run by others. Once those hyperlinks are established, users interact with those regions in exactly the same way as they interact with local regions. Specifically, users can choose to teleport there. Once the user reaches the region behind the hyperlink, she is automatically interacting with a different virtual world without having to logout from the world where she came from, and while still having access to her inventory.<br />
<br />
The hypergrid started as a GForge project, but it is now included in the standard distribution of OpenSim. To run your OpenSim instance in hypergrid mode, please see [[Hypergrid#Installing_and_Running_Hypergrid|Installing and Running]].<br />
<br />
=== Virtual World Hyperlinks ===<br />
[[image:hghyperlink.jpg|250px|thumb|A Virtual World Hyperlink]]<br />
<br />
We're all familiar with hypertext links on the Web. But what is a virtual world hyperlink?<br />
<br />
In the hypergrid model, we consider the 2D map of the virtual world as the equivalent of a web page. As such, a VW hyperlink is simply a region on that map. <br />
<br />
The default model of opensim-based virtual worlds already supports this concept of hyperlink, to some extent. When you teleport from one region to another via the map, chances are you are migrating your agent into a different opensim server. This migration is a glorified "agent transfer" that also exists, in rudimentary form, on the web when hypertext links are followed. The default model, however, imposes two very strong constraints on these hyperlinks: <br />
# The entire map of regions is controlled by a central service known as the grid service, whose job is to provide a uniform view of the world to all of its regions.<br />
# The only agents that can be transferred are those pertaining to users known to another central service, the user service; if the incoming user is not on that service's database, the agent transfer doesn't go through.<br />
<br />
The hypergrid simply removes these two constraints. <br />
<br />
First, it allows individual opensim instances to add "neighbors" to their local map, shifting the control of the map down from the grid server to individual opensim instances (although hyperlinks can also be served by grid servers if grid admins so wish). In doing so, the world becomes a lot more interesting and varied. The map that you see in one opensim instance may be completely different from the map that you see after you teleport via an hyperlink. As an opensim administrator, you are free to define what other opensims you want to see on your map.<br />
<br />
Second, it allows the transfer of agents pertaining to foreigner users, i.e. users who are registered elsewhere. Instead of assuming one central user service, the hypergrid assumes an arbitrarily large number of such services distributed all over the world. As such, when agents are transferred among hypergrided opensims, a lot more information is passed about the corresponding user. That information includes the collection of servers that the transferring user needs.<br />
<br />
=== Usage Scenarios ===<br />
<br />
The following are some usage scenarios. There isn't a clear separation between these scenarios, there's a large overlap between them. This is also not an exhaustive list. The purpose of these descriptions is to give you some starting ideas for how to use the hypergrid in practice. Please feel free to add other interesting scenarios to this list.<br />
<br />
{| {{Prettytable}}<br />
|-<br />
|<br />
[[image:topoA.jpg|400px|left]]<br />
|<br />
'''Personal Worlds'''<br />
<br />
This first scenario pertains to standalone opensims. Normally, standalones are completely disconnected from the internet. However, when run in hypergrid mode, standalones become network-able. As such, you can run your own world in your own computer, and link your world to whoever you want. For example, you can link to your friends' hypergrided opensims and to hypergrid gateways in open grids such as OSGrid. <br />
<br />
The great thing about this scenario is that all of your assets are stored on your computer, and not on somebody else's server. You can back them up using ordinary backend tools. The not so great thing about this scenario is that all of your assets are stored on your computer! If your disk goes berserk, you loose them. (so make sure you make external backups regularly)<br />
<br />
|-<br />
|<br />
[[image:topoB.jpg|400px|left]]<br />
|<br />
'''Communities'''<br />
<br />
This second scenario is about communities, broadly construed. The idea here is that a group of people come together to support a small community grid, i.e. a common world where shared activities take place. But at the same time, the members of the community maintain their own standalone worlds. The standalones link to the community grid, and the community grid may link back to the individual members' worlds and other places of interest.<br />
<br />
The members' identities are probably the identities they have on their standalones, and their assets are also probably stored there. The assets present in the community regions, however, are stored on the grid asset server.<br />
<br />
|-<br />
|<br />
[[image:topoC.jpg|400px|left]]<br />
|<br />
'''Grid Public Regions'''<br />
<br />
Walled-gardens are here to stay, and they serve many useful purposes. There is a hybrid mode for the hypergrid that some walled-garden grid operators may be interested in supporting. In this hybrid mode, most opensim instances on the grid run in normal, wall-garden mode, so no foreign visitors are allowed there - technically it is impossible to reach them. However, a few opensim instances on that grid can run in hypergrid mode, so that foreign visitors are allowed. This way, there is a gateway for grid-local users and arbitrary visitors to meet. This is also a good strategy for attracting new users to the grid, since random users are able to visit those gateway regions without having to sign up for an account upfront.<br />
<br />
This hybrid mode is very similar to what happens on the web. For example, anyone can visit Facebook's public pages without having to sign up for a Facebook account. However, only Facebook users can go further inside.<br />
<br />
|-<br />
|<br />
[[image:topoD.jpg|400px|left]]<br />
|<br />
'''Level Games'''<br />
<br />
The normal version of OpenSim enforces a common map for all the regions on a grid. The hypergrid removes that constraint. As such, it becomes easy to design VW games where the world looks different depending of where the player is. <br />
<br />
|-<br />
|}<br />
<br />
== Security Concerns ==<br />
<br />
There is a wide-spread assumption that open grids such as OSGrid and new forms of grids such as the hypergrid are inherently insecure, and that it will be impossible to develop a "goods-based" economy on top of them; only walled-gardens can be secured. This is both true and false. While it is true with the current state of things, open grids, whatever their form, can be made as secure as the web. The first step towards that is to define exactly what the security threats are, and how they affect (or not) open and closed grids. So, let's spell them out, and face them head-on. This will help put our feet on the ground so that we start developing appropriate solutions.<br />
<br />
=== Malicious Clients ===<br />
<br />
==== CopyBots ====<br />
<br />
Everyone knows about the infamous [http://en.wikipedia.org/wiki/CopyBot CopyBot]. Using libraries such as [http://www.libsecondlife.org/wiki/Main_Page LibSL] (now known as OpenMetaverse) it is possible to develop clients for opensim servers that do unorthodox things such as bypassing the permissions system to copy people's assets. Bots written by griefers can do lots of other nasty things.<br />
<br />
Malicious bots are a problem for all opensim administrators, including walled-garden grids. They can be prevented, to a certain extent, by exo-technical solutions such as Terms of Service and real-world lawsuits. Technically speaking, the only way to keep intruders out is to run opensim inside a firewall, pretty much like all other pieces of client/server software out there. If that's an acceptable solution for your case, you should do it.<br />
<br />
Unfortunately firewalls also keep the public out, and most opensim operators, even the ones running walled-garden grids, want to reach out to the public. In this case, opensim operators may develop additional technical obstacles for bots, similar to those we see on the Web. For example, make sure agents are being run by real people by giving them a human-challenge during the login/TP process, etc.<br />
<br />
Every obstacle to malicious clients lowers the risk of an intruder attack. However keep this in mind: no matter how many obstacles one builds, a sufficiently skilled and motivated attacker will be able to overcome them to penetrate opensims connected to the public internet. This affects hypergrid nodes as much as walled-garden grids. In fact, it's more pervasive than that: it affects '''all''' servers (opensim, web, etc.) connected to the public internet. Fighting malicious intruders is a fact of a connected world. Fortunately, those attacks don't happen very often, or the Web would have been dead by now.<br />
<br />
==== Web Clients ====<br />
<br />
CopyBots are the most well-known bots for opensim-based virtual worlds, but these virtual worlds are also susceptible to attacks by regular web clients. With the current state of things, it is actually easier to copy assets with a web-based client than with a libsl-based one. The weakness is that asset servers are connected to the public internet, and the protocol for interacting with them is public. <br />
<br />
OpenSim has some minimal guards in place to fence against these kinds of attacks. Specifically, when the inventory server receives a request for an item, it checks the session identifier of the requester. Web clients aren't logged in, so they are refused service. I don't want to expand much more on this, so not to make life easy for attackers, but let's just say that opensim has the necessary mechanisms in place to fence off web-based attackers.<br />
<br />
=== Malicious Hosts ===<br />
<br />
==== Actively Malicious Hosts ====<br />
<br />
The new security threat introduced by openness, one that does not exist in closed grids, is the possibility of a user to visit a region that is running malicious code. In the current state of opensim, a malicious host can do serious damage to the user's assets. Let's see how.<br />
<br />
Assume you have your assets in your hypergrided-standalone opensim, and you go visit another opensim that happens to be running malicious code. Here is a non-exhaustive list of vulnerabilities that you are exposed to:<br />
<br />
* The host has your session id, so it can request your inventory items on your behalf and store copies in its local asset server. To add insult to injury, a malicious host could simply wipe out your inventory after having copied it.<br />
* Even if the malicious host doesn't access your items by itself, every time you access items in your inventory while you are in that region, those items are cached in the region's local cache, and can be stored persistently by the malicious host.<br />
<br />
Malicious hosts can do a lot more damage, but those two are enough to illustrate this new kind of vulnerability affecting open grids. Note that this affects all open grids, i.e. those where arbitrary people can plug-in their opensims, and not just the hypergrid.<br />
<br />
Fortunately, there is a family of simple solutions to this problem that can be summarized as "protecting you from yourself." That proposal is described [[Hypergrid Inventory Access|here]].<br />
<br />
==== Piracy ====<br />
<br />
A second new security threat affecting open grids is one pertaining to commerce of virtual goods. Suppose you put something out for sale on your hypergrided opensim. A foreign user comes and buys it. What that really means is that that user will physically get a copy of the assets moved to his/her asset server, which is different from your asset server. The permissions will be whatever you define them to be, and using the regular VW client, that user can only do what you defined he/she should could do with the object, as usual. However, if the user has direct backend access to the asset and inventory servers, that person can simply modify the permissions on his/her copy. This is commonly known as '''piracy'''. (This is also a problem with programmers who have direct access to the cache that their client keeps; in this case, the only thing that needs to be done to enable piracy is for the user to actually see a texture/animation/in-world object. This does NOT allow scripts to be copied, though, since the script is only interpreted on the server and is never sent for interpretation by the client.)<br />
<br />
This situation is the kernel of the belief that open grids are hopeless for a virtual-goods economy. DRM discussion aside, maybe they are hopeless. But then, everyone thought the web was hopeless for selling music, and look at the success of iTunes in spite of all the piracy that still exists out there. Who will be the equivalent of iTunes for virtual hair, skin and clothes?<br />
<br />
== Hypergrid Implementation ==<br />
<br />
=== Hyperlinks and Agent Transfers ===<br />
<br />
When you establish a link between your opensim and another, a message is sent out to that other opensim requesting information about it; the required information includes the network information of that opensim host, and the coordinates of its first region on its local grid in the form of a region handle. For example, suppose you are linking node X.com:9000, placing it in your local map at 900, 900. That opensim runs one or more regions that likely are not in 900, 900 on their own map; suppose the first region of that opensim is at 1100, 1100. From your point of view, it doesn't matter what those other coordinates are, and you don't need to know -- that's the key to being able to decentralize the "world" as given by a 2D map; you want to place it in your map at 900, 900. The "true" position of that simulator only matters for the LL viewer, when there are teleports between your world and that other opensim. This mapping between coordinate systems is the essence of hyperlinks for opensim; it's one simple but critical thing that the hypergrid implementation does. The mapping happens on the TeleportFinish event; instead of sending the local coordinates to the viewer, the hypergrid teleport wrapper sends the remote coordinates.<br />
<br />
When an agent teleports through that hyperlink the following happens. First, before InformRegionOfChildAgent, the local opensim notifies the remote opensim of this foreign user via the "expect_hg_user" method. That message sends along the addresses of all the servers that this user uses, i.e. user, inventory and asset servers. The remote opensim places an entry for that user in its local user profile cache but not in its user database; the foreign user information is non-persistent. After that, the teleport process is exactly the same as the normal teleport process; the only difference is that the region handles are switched between the remote region's hyperlink position on the local grid and its actual position on its grid. <br />
<br />
In summary, the two new concepts introduced by the hypergrid are the concept of an hyperlink and the concept of a "local user" vs. "foreign user".<br />
<br />
=== Inventory Access ===<br />
<br />
Inventory access from abroad is done by wrapping the existing scene-inventory interactions with additional code that gets or posts inventory assets from/to the user's asset server. When inventory is accessed, the hypergrid wrapper checks if the user is foreign and, if she is, the wrapper simply brings the necessary assets from the user's asset server to the local asset cache and server; from then on, the wrapper passes the control to the existing inventory access functions. When something is added to inventory, the hypergrid wrapper is notified via an event, and posts the assets to the user's asset server. A cache of the exchanged item identifiers is maintained so that they aren't brought back over and over again.<br />
<br />
The result is that hypergrided opensim instances end up interacting with several asset servers, instead of just one. That interaction is implemented in a straightforward manner by instantiating several GridAssetClient objects, instead of just one.<br />
<br />
=== The Hypergrid Classes ===<br />
<br />
Currently, the hypergrid is implemented outside of the OpenSim namespace, so that there is complete separation between what already exists and this new behavior. It has its own namespace, HyperGrid. In it, there are 4 sub-namespaces that follow directly the software architecture of OpenSim, namely:<br />
<br />
* '''OpenSim.Framework''':<br />
** ForeignUserProfileData extends UserProfileData by introducing information about the user's "home", namely the home address, port and remoting port. The user's home is not that user's user service; it's the opensim that the user has defined to be her home. This is necessary for supporting the home jump (Ctrl-Shift-H).<br />
** HGNetworkServersInfo follows the spirit of NetworkServersInfo, although it neither extends it nor uses it. For now, it's a utility class whose two main functions are to convert domain names of servers to IP addresses, and to uniformly provide the answer to the question bool IsLocalUser(...).<br />
<br />
* '''OpenSim.Region.Framework.Scenes.Hypergrid''':<br />
** HGSceneCommunicationService extends SceneCommunicationService, overriding RequestTeleportToLocation. There are two very small but critical changes to the base method: (a) on the TeleportFinish event, we switch the region handles when the destination region is an hyperlink; (b) the connections at the end are always closed for hyperlink TPs.<br />
** HGScene extends Scene, overriding TeleportClientHome(...). The only change to the base method is to stay away from the user server, for now, because the user service is still not completely wrapped up for foreign users. Once the user service is properly wrapped up, this class will become unnecessary.<br />
** HGScene.Inventory is a partial class of HGScene, just like what happens in the OpenSim framework. This part of HGScene overrides some inventory-scene interaction methods, so that assets are fetched/posted from/to the user's asset server. Once that extra fetching/posting is done, these methods simply pass the ball to the base methods.<br />
** HGAssetMapper: this is a new class specific to the hypergrid that manages the fetching and posting of assets between foreign regions where the user is and the user's asset server.<br />
<br />
* '''OpenSim.Region.Communications.HyperGrid''' is a mashup of OpenSim.Region.Communications.*. This is the place where most of the hypergrid extension lies. One of the reasons for this is that the hypergrid communications part is doing one additional thing: it is making standalones network-able.<br />
** HGCommunicationsStandalone extends CommuniationsLocal. Just as its base, it is a hub for the several network services available in standalone mode. The main difference is that those services are extensions of what's in OpenSim.<br />
** HGCommunicationsGridMode extends CommunicationsManager directly. Again, it's a hub for the network services available in grid mode, those services being extensions of OpenSim.<br />
** The cluster HGGridServices (superclass), HGGridServicesStandalone and HGGridServicesGridMode (subclasses) implements the OpenSim interfaces IGridServices and IInterRegionCommunications. The 2 subclasses are wrappers for LocalBackEndServices and OGS1GridServices, respectively. There is one common pattern throughout these classes: check if the region to talk to is an hyperlink; if it's not, simply delegate the work to LocalBackEndServices/OGS1GridServices; if it is, push the work to the base class HGGridServices. HGGridServices, in turn, does the management of hyperlink regions, and defines two additional pieces of inter-region protocol:<br />
*** region_uuid: for linking regions<br />
*** expect_hg_user: similar to the existing expect_user interface, but with a lot more information about the user being passed around, namely all the user's servers (inventory, asset, user, home, etc.)<br />
** HGInventoryService extends LocalInventoryService and implements ISecureInventoryService. This class is the most obvious mashup of the pack, mixing local service access for standalone users and remote inventory access for when users are out and about. Right now, there is a fair amount of selective copy-and-paste, to stay away from the ugliness coming from OGS1InventoryService and OGS1SecureInventoryService. HGInventoryService is always a ISecureInventoryService. Its methods all follow the same pattern: check if the user is a local standalone user; if it is, pass the work to the base method (in LocalInventoryService); if it's not perform secure remote access.<br />
** HGUserServices wraps OSG1UserServices, but it's not functional yet.<br />
<br />
* '''OpenSim.Region.CoreModules.HyperGrid''' is a collection of 3 region modules:<br />
** HGWorldMapModule extends WorldMapModule. It reuses almost everything from the base class. The only small change is in RequestMapBlocks, where it tries to send Offline mapblocks to the client.<br />
** HGStandaloneInventoryService and HGStandaloneAssetService do what their names say. They are region modules that allow access to inventory and assets for standalones, when the standalone user is out and about. In spirit, there is a lot in common between these modules and the REST inventory/asset plugin. Unfortunately, that plugin could not be used because it defines a completely different interface than that used by existing inventory and asset servers, and the access for the hypergrid must use a consistent interface.<br />
<br />
<br />
== Installing and Running Hypergrid ==<br />
<br />
=== Installing ===<br />
<br />
# Checkout OpenSim, prebuild and build as normal.<br />
# <br />
#* If you're running your opensim in grid mode with the UGAIM servers on other machines, you're done. If you're running in standalone and you want it to be network-able, or if you have your grid on loopback (127.0.0.1) change all the [Network] server addresses to <nowiki>"http://<external_host_name>:<http_port>"</nowiki>. See below.<br />
# Run opensim like this: <nowiki>[mono] OpenSim.exe -hypergrid=true</nowiki>. To make sure the hypergrid is running type this on your console: '''link-region'''. If you don't hear anything back, the hypergrid is not properly installed.<br />
'''[mono] OpenSim.exe -hypergrid=true'''<br />
<br />
Here is an example of the Network settings for a standalone:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:9300<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:9300<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:9300<br />
inventory_server_url = http://example.com:9300<br />
messaging_server_url = http://example.com:9300<br />
<br />
<br />
Here is an example of the Network settings for a grided opensim:<br />
<br />
[Network]<br />
http_listener_port = 9300<br />
remoting_listener_port = 9895<br />
<br />
grid_server_url = http://example.com:8001<br />
grid_send_key = null<br />
grid_recv_key = null<br />
<br />
user_server_url = http://example.com:8002<br />
user_send_key = null<br />
user_recv_key = null<br />
<br />
asset_server_url = http://example.com:8003<br />
inventory_server_url = http://example.com:8004<br />
; Port 8005 reserved<br />
messaging_server_url = http://example.com:8006<br />
<br />
<br />
'''Important Note'''<br />
<br />
Make sure you have a 'home' set. If your home region doesn't exist, the hyperlink TPs may not work. To set your home, go to one of your local regions and "Set Home" from the viewer.<br />
<br />
=== Linking regions ===<br />
<br />
==== Method 1 ====<br />
<br />
On the console, type for example:<br />
<br />
link-region <Xloc> <Yloc> osl2.nac.uci.edu:9006<br />
<br />
* Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.<br />
* replace osl2.nac.uci.edu and 9006 with the domain name / ip address and the http_listener_port of the simulator where the region is running you want to link to<br />
<br />
You can link to a specific region within an instance, by using the name of the region at the end, for example:<br />
<br />
link-region 997 997 osl2.nac.uci.edu:9006:UCI Welcome<br />
<br />
==== Method 2 ====<br />
<br />
There is also some initial support for reading the links from a xml file.<br />
<br />
Use the console command: link-region <URI> [<excludeList>]<br />
<br />
The uri can be either the path of a local xml file or a xml document on a http server.<br />
<br />
The format of the xml file is:<br />
<br />
<Nini><br />
<Section Name="Region1"> <!-- can be any name but each section should have a different name and have no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
<Key Name="real-xloc" Value="10222"/> //optional field that gives the region's real location on its home grid<br />
<Key Name="real-yloc" Value="10265" /> //optional field that gives the region's real location on its home grid<br />
</Section><br />
<Section Name="Region2"> <br />
...<br />
</Section><br />
...<br />
</Nini><br />
<br />
[Note] The section names can be anything you want, but they all should be different and have no spaces in the name.<br />
<br />
<br />
ExcludeList:<br />
<br />
The exclude list is a single string paramater with the format: excludeList:<SectionName>[;<SectionName>]<br />
<br />
This means that while reading from the xml file any sections that are listed in the excludeList will be ignored and no HyperGrid link created for them.<br />
<br />
This could allow, link lists to be created on a webserver that everyone could add their own regions to, and then they just make sure they add their own section name(s) to the exclude list on their own region(s). <br />
<br />
So for example, someone might create a editable online list for the up coming OpenSimulator's 2nd birthday. Which might look something like:<br />
<br />
<Nini><br />
<Section Name="OSGrid-Party"> <!-- can be any name but each section should have a different name and no spaces --><br />
<Key Name="xloc" Value="1002"/><br />
<Key Name="yloc" Value="1006" /><br />
<Key Name="externalPort" Value="9006" /><br />
<Key Name="externalHostName" Value="osl2.nac.uci.edu" /><br />
<Key Name="localName" Value="OSGrid-Gateway" /><br />
</Section><br />
<Section Name="UCIGrid-Party"> <br />
...<br />
</Section><br />
</Nini><br />
<br />
I could then add my own region to the list with the section name "MW-Party". Then when I startup that region that I want to be part of this hypergrid, I use the command: "link-region <URI of xml file> excludeList:MW-Party" <br />
<br />
This is so that my region doesn't try to create a hyper link to itself.<br />
<br />
==== Method 3 (dynamic) ====<br />
<br />
Starting in r8193, if you're in an HG-enabled region, you'll be able <br />
to dynamically link sims, and TP there, in any one of these ways (and <br />
probably more). All you need to know is the target addresse, e.g. from the<br />
list below.<br />
<br />
1) Type for example secondlife://ucigrid04.nacs.uci.edu:9007/ in the <br />
chat box, pull up the chat history and click on that link<br />
<br />
2) Pull up the map and search for things like <br />
ucigrid04.nacs.uci.edu:9007<br />
<br />
3) Using the embedded browser visit pages that have links like <br />
secondlife://ucigrid04.nacs.uci.edu:9007/ (there's one up at<br />
http://www.ics.uci.edu/~lopes/hypergrid/test.html)<br />
<br />
Again, you can link to a specific region within an instance by adding the name of that region at the end, like this:<br />
secondlife://ucigrid04.nacs.uci.edu:9007:Gateway 7000/<br />
<br />
'''Important Note'''<br />
<br />
Due to a viewer [https://jira.secondlife.com/browse/SVC-2941 bug], you can only TP between regions that are no more than 4096 cells apart in any dimension. What this means in practice is that if you want to link to OSGrid, you must have your own regions reachable from the (10,000; 10,000) point on the map, which is where OSGrid is centered. Place your regions somewhere in the 8,000s or the 12,000s.<br />
<br />
<br />
=== Banning Foreign Users ===<br />
<br />
Even though the current viewers are incapable of dealing with foreign users, it is possible to ban specific foreign users from your estates. For now, you have to do it on the backend, i.e. directly editing the database and reviewing the log. Not easy for the faint of heart, but any sys admin should be able to do this with their eyes shut. What follows are instructions for adding a foreign user to the estate's ban list. <br />
<br />
The first thing you need to do is to find out the UUID and IP address of the user you want to ban. For that you need to look at OpenSim.log. Search for log messages like this:<br />
<br />
2009-01-23 03:45:11,995 INFO - OpenSim.Region.Communications.Hypergrid.HGGridServicesGridMode [HGrid]: Incoming HGrid Agent<br />
Annoying.Person http://problematic.domain.org:9002<br />
2009-01-23 03:45:11,995 DEBUG - OpenSim.Region.Environment.Scenes.Scene [CONNECTION BEGIN]: Region Gateway 3000 told of incoming client<br />
Annoying.Person http://problematic.domain.org:9002 c3c9ecbf-bfb3-43eb-8dce-140afad7995f (circuit code 1896255323)<br />
<br />
In this case, the information you need is: UUID = c3c9ecbf-bfb3-43eb-8dce-140afad7995f and IPAddress = problematic.domain.org<br />
<br />
Next, let's add this foreign user to the ban list. Note that the estate information and ban lists are kept at the region server, not in the UGAIM. If you are using local storage for your regions, this information is stored in bin/OpenSim.db. So, open that DB with whatever tool you use to access your DBs. The instructions here assume a local sqlite database; if you're using MySql or other DB technologies for the regions' storage, the instructions are almost identical, but may need adjustments.<br />
<br />
SqlLite usually comes with a common Linux installation. In Linux, just type:<br />
<br />
$ sqlite3 OpenSim.db<br />
<br />
In Windows, you need to get it from [http://www.sqlite.org/download.html here]. Once installed, run it on your OpenSim.db, like this, for example (on a command shell):<br />
<br />
$ C:/Opt/SQLite3/sqlite3.exe OpenSim.db<br />
<br />
Once you are connected to the database, you can explore as much as you want. What follows are the concrete interactions you need for adding that foreign user into an estate ban list. Change the data for your situation.<br />
<br />
[opensim@ucigrid04 bin]$ sqlite3 OpenSim.db<br />
SQLite version 3.3.6<br />
Enter ".help" for instructions<br />
sqlite> .tables<br />
estate_groups estate_users migrations regionban<br />
estate_managers estateban primitems regionsettings<br />
estate_map land prims terrain<br />
estate_settings landaccesslist primshapes<br />
sqlite> .schema estateban<br />
CREATE TABLE estateban (<br />
EstateID int(10) NOT NULL,<br />
bannedUUID varchar(36) NOT NULL,<br />
bannedIp varchar(16) NOT NULL,<br />
bannedIpHostMask varchar(16) NOT NULL,<br />
bannedNameMask varchar(64) default NULL<br />
);<br />
CREATE INDEX estate_ban_estate_id on estateban(EstateID);<br />
sqlite> select EstateID, EstateName from estate_settings;<br />
100|My Estate<br />
101|My Estate<br />
102|My Estate<br />
103|My Estate<br />
sqlite> insert into estateban values (100, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> insert into estateban values (101, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> insert into estateban values (102, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> insert into estateban values (103, 'c3c9ecbf-bfb3-43eb-8dce-140afad7995f', 'problematic.domain.org', ' ', ' ');<br />
sqlite> select * from estateban;<br />
100|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
101|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
102|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
103|c3c9ecbf-bfb3-43eb-8dce-140afad7995f|mecatreco.game-host.org||<br />
sqlite> .quit<br />
<br />
Once this data is entered you need to restart OpenSim, so that it gets loaded.<br />
<br />
<br />
== Public Hypergrid Nodes ==<br />
<br />
Please see [[Public Hypergrid Nodes]].<br />
<br />
<br />
== Hypergrid Lists ==<br />
Please see [[Hypergrid Lists]].<br />
<br />
== Manuals and Tutorials ==<br />
<br />
* '''Unofficial Hypernauta's Basic Manual''': If you are a real beginner it can be for you. Talking about "personal" worlds created using domestic computers. [http://www.dmu.com/opensime LINK]<br />
<br />
== Development Meetings ==<br />
<br />
[[Hypergrid Meetings]]<br />
[[Category:Hypergrid]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Category:HypergridCategory:Hypergrid2009-02-13T18:50:13Z<p>Rtkwebman: New page: Everything Hypergrid related!</p>
<hr />
<div>Everything Hypergrid related!</div>Rtkwebmanhttp://opensimulator.org/wiki/Streaming_Media_in_OpenSimStreaming Media in OpenSim2009-02-08T17:05:33Z<p>Rtkwebman: /* Basic Usage of Freeview */</p>
<hr />
<div>== Introduction ==<br />
<br />
Streaming media in OpenSim works the same way as in SL. One of the most frequent misconceptions about streaming content in OpenSim is the simulator or regions server is actually doing the streaming. This is not true, all streaming happens outside of the metaverse on a seperate dedicated server. The streaming content is fed directly to Quicktime from the viewer. Generally anything able to be played in Quicktime can be viewed in OpenSim through your viewer. Streaming does not impact the performance of the simulator since all content is sent to the viewer and Quicktime player. <br />
<br />
== QuickTime 7 Supported Audio/Video Formats ==<br />
Current supported formats as listed by Apple are:<br />
<br />
=== Supported Video Formats ===<br />
*Animation <br />
*Apple BMP <br />
*Apple Pixlet (Mac OS X v10.3 only) <br />
*Apple Video <br />
*Cinepak <br />
*Component video <br />
*DV and DVC Pro NTSC <br />
*DV PAL <br />
*DVC Pro PAL <br />
*Graphics <br />
*H.261 <br />
*H.263 <br />
*H.264 <br />
*JPEG 2000 <br />
*Microsoft OLE (decode only) <br />
*Microsoft Video 1 (decode only) <br />
*Motion JPEG A <br />
*Motion JPEG B <br />
*MPEG-4 (Part 2) <br />
*Photo JPEG <br />
*Planar RGB <br />
*PNG <br />
*Sorenson Video 2 <br />
*Sorenson Video 3 <br />
*TGA <br />
*TIFF <br />
=== Supported Audio Formats ===<br />
*24-bit integer <br />
*32-bit floating point <br />
*32-bit integer <br />
*64-bit floating point <br />
*AAC (MPEG-4 Audio) <br />
*ALaw 2:1 <br />
*AMR Narrowband <br />
*Apple Lossless Encoder <br />
*IMA 4:1 <br />
*MACE 3:1 <br />
*MACE 6:1 <br />
*MS ADPCM (decode only) <br />
*QDesign Music 2 <br />
*Qualcomm PureVoice (QCELP) <br />
*ULaw 2:1<br />
<br />
== Creating a Media Screen in OpenSim ==<br />
<br />
Now that you understand some of the fundamentals of what is going on with media content in OpenSim you are probably wanting to get started creating a video area so you and your friends can enjoy watching or listening to some media together. The best free script that I have come across is Freeview. The code for this script is listed below and you can simply copy and paste it into a script window to get you started.<br />
<br />
=== General Steps ===<br />
#Make sure you have a texture picked out to use as a media texture. Streaming media has to be displayed on a texture and unless you want to see your media playing all over the place make sure the texture is unique to just the prim you want to use as a view screen.<br />
#Create a prim that will display the media. <br />
#For a good looking display choose a blank texture with a black color for all sides.<br />
#Select just the prim face for the screen and make the texture your media texture from Step 1 and choose white for the color.<br />
#Drop the Freeview script into the Contents tab.<br />
#In the About Land window Media tab change your Replace Texture to the one in Step 1.<br />
#In the About Land window General tab make sure the Allow Deed To Group item is checked.<br />
<br />
At this point if your script compiled correctly then you should be able to click on the media view screen and a menu will pop up. A good test would be to choose the Video button and then the Set URL button. In the chat window type /1 and then a URL to a video that you know exists on a streaming server. The video should begin playing within a minute or so.<br />
<br />
=== Tips for Using Freeview ===<br />
Need some info here.<br />
<br />
=== Freeview Code ===<br />
<pre><br />
//XEngine:<br />
//FreeView 1.2 WebGuide (revision 3) - By CrystalShard Foo<br />
//Multifunctional Picture viewer and Video control script with webguide support<br />
//This script is distributed for free and must stay that way. <br />
<br />
// *** DO NOT SELL THIS SCRIPT UNDER ANY CIRCUMSTANCE. ***<br />
<br />
//Help for using this script can be obtained at: http://www.slguide.com/help<br />
<br />
//Feel free to modify this script and post your improvement. Leave the credits intact but feel free to add your name at its bottom.<br />
<br />
//Whats new:<br />
//- Now using FULL_BRIGHT instead of PRIM_MATERIAL_LIGHT for the screen display<br />
//- Added an ownership-change code to handle cases where FreeView gets deeded to group post Video Init.<br />
//- Renamed WebGuide to TV-Guide to reflect what this thing does better.<br />
//- Added a 'Fix Scale' button to Picture mode to help against user texture-scale changes.<br />
//- Additional minor help-tips and code improvements<br />
<br />
//Enjoy!<br />
<br />
<br />
//Constants<br />
integer PICTURE_ROTATION_TIMER = 60; //In whole seconds<br />
<br />
integer DISPLAY_ON_SIDE = ALL_SIDES; //Change this to change where the image will be displayed<br />
<br />
key VIDEO_DEFAULT = "71b8ff26-087d-5f44-285b-d38df2e11a81"; //Test pattern - Used as default video texture when one is missing in parcel media<br />
key BLANK = "5748decc-f629-461c-9a36-a35a221fe21f"; //Blank texture - Used when there are no textures to display in Picture mode<br />
string NOTECARD = "bookmarks"; //Used to host URL bookmarks for video streams<br />
<br />
integer VIDEO_BRIGHT = TRUE; //FULL_BRIGHT status for Video<br />
integer PICTURE_BRIGHT = TRUE; //FULL_BRIGHT status for Picture<br />
<br />
integer REMOTE_CHANNEL = 9238742;<br />
<br />
integer mode = 0; //Freeview mode.<br />
//Mode 0 - Power off<br />
//Mode 1 - Picture viewer<br />
//Mode 2 - Video<br />
<br />
integer listenHandle = -1; //Dialog menu listen handler<br />
integer listenUrl = -1; //listen handler for channel 1 for when a URL is being added<br />
integer listenTimer = -1; //Timer variable for removing all listeners after 2 minutes of listener inactivity<br />
integer listenRemote = -1; //listen handler for the remote during initial setup<br />
integer encryption = 0;<br />
integer numberofnotecardlines = 0; //Stores the current number of detected notecard lines.<br />
integer notecardline = 0; //Current notecard line<br />
<br />
integer loop_image = FALSE; //Are we looping pictures with a timer? (picture mode)<br />
integer current_texture = 0; //Current texture number in inventory being displayed (picture mode)<br />
integer chan; //llDialog listen channel<br />
integer notecardcheck = 0;<br />
key video_texture; //Currently used video display texture for parcel media stream<br />
<br />
string moviename;<br />
string tempmoviename;<br />
key notecardkey = NULL_KEY;<br />
key tempuser; //Temp key storge variable<br />
string tempurl; //Temp string storge variable<br />
<br />
integer isGroup = TRUE;<br />
key groupcheck = NULL_KEY;<br />
key last_owner;<br />
key XML_channel;<br />
<br />
pictures() //Change mode to Picture Viewer<br />
{<br />
//Initilize variables<br />
<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, PICTURE_BRIGHT]);<br />
<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
<br />
if(check == 0)<br />
{<br />
report("No pictures found.");<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
else <br />
if(current_texture > check)<br />
//Set to first texture if available<br />
current_texture = 0;<br />
<br />
display_texture(current_texture);<br />
}<br />
<br />
video() //Change mode to Video<br />
{<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, VIDEO_BRIGHT, PRIM_TEXTURE, DISPLAY_ON_SIDE, "62dc73ca-265f-7ca0-0453-e2a6aa60bb6f", llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
<br />
report("Video mode"+moviename+": Stopped");<br />
if(finditem(NOTECARD) != -1)<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD);<br />
video_texture = llList2Key(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_TEXTURE]),0);<br />
if(video_texture == NULL_KEY)<br />
{<br />
video_texture = VIDEO_DEFAULT;<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_TEXTURE,VIDEO_DEFAULT]);<br />
llSay(0,"No parcel media texture found. Setting texture to default: "+(string)VIDEO_DEFAULT);<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner())<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
}<br />
<br />
llSetTexture(video_texture,DISPLAY_ON_SIDE);<br />
}<br />
<br />
off()<br />
{<br />
report("Click to power on.");<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_LOW, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <0.1,0.1,0.1>, 1.0,PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, FALSE, PRIM_TEXTURE, DISPLAY_ON_SIDE, BLANK, llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
}<br />
<br />
integer finditem(string name) //Finds and returns an item's inventory number<br />
{<br />
integer i;<br />
for(i=0;i<llGetInventoryNumber(INVENTORY_NOTECARD);i++)<br />
if(llGetInventoryName(INVENTORY_NOTECARD,i) == NOTECARD)<br />
return i;<br />
return -1;<br />
}<br />
<br />
seturl(string url, key id) //Set parcel media URL<br />
{<br />
if(mode != 2)<br />
{<br />
video();<br />
mode = 2;<br />
}<br />
moviename = tempmoviename;<br />
if(moviename)<br />
moviename = " ["+moviename+"]";<br />
tempmoviename = "";<br />
string oldurl = llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0);<br />
if(oldurl != "")<br />
llOwnerSay("Setting new media URL. The old URL was: "+oldurl);<br />
<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_URL,url]);<br />
if(id!=NULL_KEY)<br />
menu(id);<br />
else<br />
{<br />
report("Video mode"+moviename+": Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
}<br />
<br />
if(isGroup)<br />
llSay(0,"New media URL set.");<br />
else<br />
llOwnerSay("New media URL set: "+url);<br />
}<br />
<br />
string mediatype(string ext) //Returns a string stating the filetype of a file based on file extension<br />
{<br />
ext = llToLower(ext);<br />
if(ext == "swf")<br />
return "Flash";<br />
if(ext == "mov" || ext == "avi" || ext == "mpg" || ext == "mpeg" || ext == "smil")<br />
return "Video";<br />
if(ext == "jpg" || ext == "mpeg" || ext == "gif" || ext == "png" || ext == "pict" || ext == "tga" || ext == "tiff" || ext == "sgi" || ext == "bmp")<br />
return "Image";<br />
if(ext == "txt")<br />
return "Text";<br />
if(ext == "mp3" || ext == "wav")<br />
return "Audio";<br />
return "Unknown";<br />
}<br />
<br />
browse(key id) //Image browser function for picture viewer mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
string header;<br />
if(check > 0)<br />
header = "("+(string)(current_texture+1)+"/"+(string)check+") "+llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
else<br />
header = "No pictures found.";<br />
llDialog(id,"** Monitor Control **\n Picture Viewer mode\n- Image browser\n- "+header,["Back","Next","Menu"],chan);<br />
extendtimer();<br />
}<br />
<br />
report(string str)<br />
{<br />
llSetObjectDesc(str);<br />
}<br />
<br />
extendtimer() //Add another 2 minute to the Listen Removal timer (use when a Listen event is triggered)<br />
{<br />
if(listenHandle == -1)<br />
listenHandle = llListen(chan,"","","");<br />
listenTimer = (integer)llGetTime() + 120;<br />
if(loop_image == FALSE)<br />
llSetTimerEvent(45);<br />
}<br />
<br />
config(key id) //Configuration menu<br />
{<br />
extendtimer();<br />
llDialog(id,"Current media URL:\n"+llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0)+"\nTip: If the picture is abit off, try 'Align ON'",["Set URL","Align ON","Align OFF","Menu","Set Remote"],chan);<br />
}<br />
<br />
tell_remote(string str)<br />
{<br />
llShout(REMOTE_CHANNEL,llXorBase64Strings(llStringToBase64((string)encryption + str), llStringToBase64((string)encryption)));<br />
}<br />
<br />
menu(key id) //Dialog menus for all 3 modes<br />
{<br />
list buttons = [];<br />
string title = "** Monitor control **";<br />
<br />
extendtimer();<br />
<br />
if(mode != 0)<br />
{<br />
if(mode == 1) //Pictures menu<br />
{<br />
title+="\n Picture Viewer mode";<br />
buttons+=["Browse"];<br />
if(loop_image == FALSE)<br />
buttons+=["Loop"];<br />
else<br />
buttons+=["Unloop"];<br />
buttons+=["Video","Power off","Help","Fix scale"];<br />
}<br />
else //Video menu<br />
{<br />
title+="\n Video display mode\n"+moviename+"\nTip:\nClick 'TV Guide' to view the Online bookmarks.";<br />
buttons+=["Pictures","Configure","Power off","Loop","Unload","Help","Play","Stop","Pause","TV Guide","Bookmarks","Set URL"];<br />
}<br />
}<br />
else<br />
buttons += ["Pictures","Video","Help"];<br />
<br />
llDialog(id,title,buttons,chan);<br />
}<br />
<br />
display_texture(integer check) //Display texture and set name in description (picture mode)<br />
{ //"Check" holds the number of textures in contents. The function uses "current_texture" to display.<br />
string name = llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
llSetTexture(name,DISPLAY_ON_SIDE);<br />
report("Showing picture: "+name+" ("+(string)(current_texture+1)+"/"+(string)check+")");<br />
}<br />
<br />
<br />
next() //Change to next texture (picture mode)<br />
{ //This function is used twice - by the menu and timer. Therefor, it is a dedicated function.<br />
current_texture++;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(check == current_texture)<br />
current_texture = 0;<br />
<br />
display_texture(check);<br />
return;<br />
}<br />
<br />
default<br />
{<br />
state_entry()<br />
{<br />
chan = (integer)llFrand(1000) + 1000; //Pick a random listen channel for the listener<br />
if(PICTURE_ROTATION_TIMER <= 0) //Ensure the value is no less or equal 0<br />
PICTURE_ROTATION_TIMER = 1;<br />
llListenRemove(listenHandle);<br />
listenHandle = -1;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
off();<br />
llOpenRemoteDataChannel();<br />
}<br />
<br />
on_rez(integer i)<br />
{<br />
llResetScript();<br />
}<br />
<br />
touch_start(integer total_number)<br />
{<br />
//-------------------------------------------------------------------------------<br />
//Listen only to owner or group member. Edit this code to change access controls.<br />
if(llDetectedKey(0) != llGetOwner() && llDetectedGroup(0) == FALSE)<br />
return;<br />
//-------------------------------------------------------------------------------<br />
<br />
if(llGetOwnerKey(llGetKey()) != last_owner) //Sense if object has been deeded to group for Web Guide function<br />
{<br />
isGroup = TRUE;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
<br />
if(mode == 2)<br />
{<br />
llSay(0,"Detected change in ownership. Attempting to obtain current parcel media texture...");<br />
video();<br />
}<br />
}<br />
<br />
menu(llDetectedKey(0));<br />
}<br />
<br />
changed(integer change)<br />
{<br />
if(change == CHANGED_INVENTORY) //If inventory change<br />
if(mode == 1) //If picture mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check != 0)<br />
{<br />
current_texture = 0;<br />
display_texture(check);<br />
}<br />
else<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
report("No pictures found.");<br />
}<br />
}<br />
else<br />
if(mode == 2) //If video mode<br />
if(finditem(NOTECARD) != -1) //And bookmarks notecard present<br />
if(notecardkey != llGetInventoryKey(NOTECARD))<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD); //Reload number of lines<br />
}<br />
<br />
listen(integer channel, string name, key id, string message)<br />
{<br />
if(message == "Pictures")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
pictures();<br />
mode = 1;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Video")<br />
{<br />
video();<br />
mode = 2;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Power off")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
off();<br />
mode = 0;<br />
return;<br />
}<br />
if(message == "Help")<br />
{<br />
llSay(0,"Help documentation is available at: http://www.slguide.com/help");<br />
if(isGroup)<br />
{<br />
if(id == NULL_KEY)<br />
{<br />
llSay(0,"FreeView cannot load help pages while set to group without the remote.");<br />
llSay(0,"For further assistance, please consult: http://slguide.com/help");<br />
}<br />
else<br />
tell_remote("HELP"+(string)id+(string)XML_channel);<br />
}<br />
else<br />
llLoadURL(id,"Help pages for FreeView","http://www.slguide.com?c="+(string)XML_channel+"&help=1");<br />
}<br />
if(mode == 1)<br />
{<br />
if(message == "Browse")<br />
{<br />
loop_image = FALSE;<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Next")<br />
{<br />
extendtimer();<br />
next();<br />
browse(id);<br />
}<br />
if(message == "Back")<br />
{<br />
extendtimer();<br />
current_texture--;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(current_texture < 0)<br />
current_texture = check - 1;<br />
<br />
display_texture(check);<br />
<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llSetTimerEvent(PICTURE_ROTATION_TIMER);<br />
loop_image = TRUE;<br />
llOwnerSay("Picture will change every "+(string)PICTURE_ROTATION_TIMER+" seconds.");<br />
return;<br />
}<br />
if(message == "Unloop")<br />
{<br />
loop_image = FALSE;<br />
llOwnerSay("Picture loop disabled.");<br />
return;<br />
}<br />
if(message == "Fix scale")<br />
{<br />
llSay(0,"Setting display texture to 1,1 repeats and 0,0 offset.");<br />
llScaleTexture(1, 1, DISPLAY_ON_SIDE);<br />
llOffsetTexture(0, 0, DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
}<br />
if(mode == 2)<br />
{<br />
if(channel == REMOTE_CHANNEL)<br />
{<br />
if(encryption == 0)<br />
encryption = (integer)message;<br />
llListenRemove(listenRemote);<br />
listenRemote = -1;<br />
llSay(0,"Remote configured ("+(string)id+")");<br />
}<br />
<br />
if(message == "TV Guide")<br />
{<br />
if(isGroup)<br />
{<br />
if(!encryption)<br />
{<br />
llSay(0,"** Error - This FreeView object has been deeded to group. You must use a Remote control to open the TV Guide.");<br />
llSay(0,"You can set up the remote control from the Video -> Configuration menu. Please refer to the notecard for further assistance.");<br />
return;<br />
}<br />
tell_remote((string)id+(string)XML_channel+(string)llGetOwner());<br />
}<br />
else<br />
llLoadURL(id, "Come to the Guide to Start Your Viewer Playing!", "http://slguide.com/index.php?v=" + (string)llGetKey() + "&c=" + (string)XML_channel + "&o=" + (string)llGetOwner() + "&");<br />
return;<br />
}<br />
<br />
string header = "Video mode"+moviename+": ";<br />
<br />
if(message == "<< Prev")<br />
{<br />
notecardline--;<br />
if(notecardline < 0)<br />
notecardline = numberofnotecardlines - 1;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Next >>")<br />
{<br />
notecardline++;<br />
if(notecardline >= numberofnotecardlines)<br />
notecardline = 0;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Use")<br />
{<br />
if(tempurl == "** No URL specified! **")<br />
tempurl = "";<br />
seturl(tempurl,id);<br />
return;<br />
}<br />
<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Configure")<br />
{<br />
config(id);<br />
return;<br />
}<br />
if(message == "Bookmarks")<br />
{<br />
if(notecardcheck != -1)<br />
{<br />
llDialog(id,"Error: No valid bookmark data found in notecard '"+NOTECARD+"'.",["Menu"],chan);<br />
return;<br />
}<br />
if(finditem(NOTECARD) != -1) <br />
{<br />
tempuser = id;<br />
if(numberofnotecardlines < notecardline)<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
}<br />
else<br />
llDialog(id,"Error: No notecard named "+NOTECARD+" found in contents.",["Menu"],chan);<br />
return;<br />
}<br />
<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner()) //If we do not have permissions to actually do the following functions<br />
{<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
menu(id);<br />
return; //Abort<br />
}<br />
<br />
if(listenUrl != -1 && channel == 1) //Incoming data from "Set URL" command (user spoke on channel 1)<br />
{<br />
llListenRemove(listenUrl);<br />
listenUrl = -1;<br />
tempmoviename = "";<br />
seturl(message,id);<br />
}<br />
if(message == "Play")<br />
{<br />
report(header+"Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
return;<br />
}<br />
if(message == "Stop")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
return;<br />
}<br />
if(message == "Pause")<br />
{<br />
report(header+"Paused");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PAUSE]);<br />
return;<br />
}<br />
if(message == "Unload")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_LOOP]);<br />
return;<br />
}<br />
//URL , Auto-Scale, <br />
if(message == "Set URL")<br />
{<br />
report(header+"Stopped");<br />
listenUrl = llListen(1,"",id,"");<br />
llDialog(id,"Please type the URL of your choice with /1 in thebegining. For example, /1 www.google.com",["Ok"],938);<br />
return;<br />
}<br />
if(message == "Align ON")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,TRUE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Align OFF")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,FALSE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Set Remote")<br />
{<br />
llSay(0,"Configuring remote...");<br />
encryption = 0;<br />
llListenRemove(listenRemote);<br />
listenRemote = llListen(REMOTE_CHANNEL,"","","");<br />
llSay(REMOTE_CHANNEL,"SETUP");<br />
}<br />
}<br />
}<br />
<br />
dataserver(key queryid, string data)<br />
{<br />
if(queryid == groupcheck) //Test if object is deeded to group<br />
{<br />
groupcheck = NULL_KEY;<br />
isGroup = FALSE;<br />
return;<br />
}<br />
<br />
if(queryid == tempuser) //If just checking number of notecard lines<br />
{<br />
numberofnotecardlines = (integer)data;<br />
notecardkey = llGetInventoryKey(NOTECARD);<br />
notecardcheck = 0;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
return;<br />
}<br />
if(notecardcheck != -1)<br />
{<br />
if(data != EOF)<br />
{<br />
if(data == "")<br />
{<br />
notecardcheck++;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
}<br />
else<br />
{<br />
notecardcheck = -1;<br />
return;<br />
}<br />
}<br />
else<br />
return;<br />
}<br />
<br />
if(data == "" && notecardline < numberofnotecardlines) //If user just pressed "enter" in bookmarks, skip<br />
{<br />
notecardline++;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
<br />
if(data == EOF)<br />
{<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
list parsed = llParseString2List(data,["|","| "," |"," | "],[]); //Ensure no blank spaces before "http://".<br />
string name = llList2String(parsed,0);<br />
tempurl = llList2String(parsed,1);<br />
if(tempurl == "")<br />
tempurl = "** No URL specified! **";<br />
<br />
tempmoviename = name;<br />
<br />
llDialog(tempuser,"Bookmarks notecard ("+(string)(notecardline+1)+"/"+(string)numberofnotecardlines+")\n"+name+" ("+mediatype(llList2String(llParseString2List(tempurl,["."],[]),-1))+")\n"+tempurl,["<< Prev","Use","Next >>","Menu"],chan);<br />
}<br />
<br />
remote_data(integer type, key channel, key message_id, string sender, integer ival, string sval)<br />
{<br />
if (type == REMOTE_DATA_CHANNEL)<br />
{<br />
XML_channel = channel;<br />
} <br />
else if(type == REMOTE_DATA_REQUEST)<br />
{<br />
list media_info = llParseString2List(sval, ["|"], []);<br />
tempmoviename = llList2String(media_info,0);<br />
seturl(llList2String(media_info,1),NULL_KEY);<br />
llRemoteDataReply(channel, message_id, sval, 1);<br />
}<br />
}<br />
<br />
timer()<br />
{<br />
if(llGetTime() > listenTimer) //If listener time expired...<br />
{<br />
llListenRemove(listenHandle); //Remove listeneres.<br />
llListenRemove(listenUrl);<br />
llListenRemove(listenRemote);<br />
listenHandle = -1;<br />
listenUrl = -1;<br />
listenRemote = -1;<br />
listenTimer = -1;<br />
if(loop_image == FALSE || mode != 1) //If we're not looping pictures or are in picture mode at all<br />
llSetTimerEvent(0.0); //Remove timer<br />
}<br />
<br />
if(loop_image == TRUE && mode == 1) //If we're looping pictures and and we're in picture mode...<br />
next(); //Next picture<br />
}<br />
}<br />
</pre><br />
== Additional Information ==<br />
<br />
[[Category:Media]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Streaming_Media_in_OpenSimStreaming Media in OpenSim2009-02-08T04:37:36Z<p>Rtkwebman: /* General Steps */</p>
<hr />
<div>== Introduction ==<br />
<br />
Streaming media in OpenSim works the same way as in SL. One of the most frequent misconceptions about streaming content in OpenSim is the simulator or regions server is actually doing the streaming. This is not true, all streaming happens outside of the metaverse on a seperate dedicated server. The streaming content is fed directly to Quicktime from the viewer. Generally anything able to be played in Quicktime can be viewed in OpenSim through your viewer. Streaming does not impact the performance of the simulator since all content is sent to the viewer and Quicktime player. <br />
<br />
== QuickTime 7 Supported Audio/Video Formats ==<br />
Current supported formats as listed by Apple are:<br />
<br />
=== Supported Video Formats ===<br />
*Animation <br />
*Apple BMP <br />
*Apple Pixlet (Mac OS X v10.3 only) <br />
*Apple Video <br />
*Cinepak <br />
*Component video <br />
*DV and DVC Pro NTSC <br />
*DV PAL <br />
*DVC Pro PAL <br />
*Graphics <br />
*H.261 <br />
*H.263 <br />
*H.264 <br />
*JPEG 2000 <br />
*Microsoft OLE (decode only) <br />
*Microsoft Video 1 (decode only) <br />
*Motion JPEG A <br />
*Motion JPEG B <br />
*MPEG-4 (Part 2) <br />
*Photo JPEG <br />
*Planar RGB <br />
*PNG <br />
*Sorenson Video 2 <br />
*Sorenson Video 3 <br />
*TGA <br />
*TIFF <br />
=== Supported Audio Formats ===<br />
*24-bit integer <br />
*32-bit floating point <br />
*32-bit integer <br />
*64-bit floating point <br />
*AAC (MPEG-4 Audio) <br />
*ALaw 2:1 <br />
*AMR Narrowband <br />
*Apple Lossless Encoder <br />
*IMA 4:1 <br />
*MACE 3:1 <br />
*MACE 6:1 <br />
*MS ADPCM (decode only) <br />
*QDesign Music 2 <br />
*Qualcomm PureVoice (QCELP) <br />
*ULaw 2:1<br />
<br />
== Creating a Media Screen in OpenSim ==<br />
<br />
Now that you understand some of the fundamentals of what is going on with media content in OpenSim you are probably wanting to get started creating a video area so you and your friends can enjoy watching or listening to some media together. The best free script that I have come across is Freeview. The code for this script is listed below and you can simply copy and paste it into a script window to get you started.<br />
<br />
=== General Steps ===<br />
#Make sure you have a texture picked out to use as a media texture. Streaming media has to be displayed on a texture and unless you want to see your media playing all over the place make sure the texture is unique to just the prim you want to use as a view screen.<br />
#Create a prim that will display the media. <br />
#For a good looking display choose a blank texture with a black color for all sides.<br />
#Select just the prim face for the screen and make the texture your media texture from Step 1 and choose white for the color.<br />
#Drop the Freeview script into the Contents tab.<br />
#In the About Land window Media tab change your Replace Texture to the one in Step 1.<br />
#In the About Land window General tab make sure the Allow Deed To Group item is checked.<br />
<br />
At this point if your script compiled correctly then you should be able to click on the media view screen and a menu will pop up. A good test would be to choose the Video button and then the Set URL button. In the chat window type /1 and then a URL to a video that you know exists on a streaming server. The video should begin playing within a minute or so.<br />
<br />
=== Basic Usage of Freeview ===<br />
Need some info here.<br />
<br />
=== Freeview Code ===<br />
<pre><br />
//XEngine:<br />
//FreeView 1.2 WebGuide (revision 3) - By CrystalShard Foo<br />
//Multifunctional Picture viewer and Video control script with webguide support<br />
//This script is distributed for free and must stay that way. <br />
<br />
// *** DO NOT SELL THIS SCRIPT UNDER ANY CIRCUMSTANCE. ***<br />
<br />
//Help for using this script can be obtained at: http://www.slguide.com/help<br />
<br />
//Feel free to modify this script and post your improvement. Leave the credits intact but feel free to add your name at its bottom.<br />
<br />
//Whats new:<br />
//- Now using FULL_BRIGHT instead of PRIM_MATERIAL_LIGHT for the screen display<br />
//- Added an ownership-change code to handle cases where FreeView gets deeded to group post Video Init.<br />
//- Renamed WebGuide to TV-Guide to reflect what this thing does better.<br />
//- Added a 'Fix Scale' button to Picture mode to help against user texture-scale changes.<br />
//- Additional minor help-tips and code improvements<br />
<br />
//Enjoy!<br />
<br />
<br />
//Constants<br />
integer PICTURE_ROTATION_TIMER = 60; //In whole seconds<br />
<br />
integer DISPLAY_ON_SIDE = ALL_SIDES; //Change this to change where the image will be displayed<br />
<br />
key VIDEO_DEFAULT = "71b8ff26-087d-5f44-285b-d38df2e11a81"; //Test pattern - Used as default video texture when one is missing in parcel media<br />
key BLANK = "5748decc-f629-461c-9a36-a35a221fe21f"; //Blank texture - Used when there are no textures to display in Picture mode<br />
string NOTECARD = "bookmarks"; //Used to host URL bookmarks for video streams<br />
<br />
integer VIDEO_BRIGHT = TRUE; //FULL_BRIGHT status for Video<br />
integer PICTURE_BRIGHT = TRUE; //FULL_BRIGHT status for Picture<br />
<br />
integer REMOTE_CHANNEL = 9238742;<br />
<br />
integer mode = 0; //Freeview mode.<br />
//Mode 0 - Power off<br />
//Mode 1 - Picture viewer<br />
//Mode 2 - Video<br />
<br />
integer listenHandle = -1; //Dialog menu listen handler<br />
integer listenUrl = -1; //listen handler for channel 1 for when a URL is being added<br />
integer listenTimer = -1; //Timer variable for removing all listeners after 2 minutes of listener inactivity<br />
integer listenRemote = -1; //listen handler for the remote during initial setup<br />
integer encryption = 0;<br />
integer numberofnotecardlines = 0; //Stores the current number of detected notecard lines.<br />
integer notecardline = 0; //Current notecard line<br />
<br />
integer loop_image = FALSE; //Are we looping pictures with a timer? (picture mode)<br />
integer current_texture = 0; //Current texture number in inventory being displayed (picture mode)<br />
integer chan; //llDialog listen channel<br />
integer notecardcheck = 0;<br />
key video_texture; //Currently used video display texture for parcel media stream<br />
<br />
string moviename;<br />
string tempmoviename;<br />
key notecardkey = NULL_KEY;<br />
key tempuser; //Temp key storge variable<br />
string tempurl; //Temp string storge variable<br />
<br />
integer isGroup = TRUE;<br />
key groupcheck = NULL_KEY;<br />
key last_owner;<br />
key XML_channel;<br />
<br />
pictures() //Change mode to Picture Viewer<br />
{<br />
//Initilize variables<br />
<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, PICTURE_BRIGHT]);<br />
<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
<br />
if(check == 0)<br />
{<br />
report("No pictures found.");<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
else <br />
if(current_texture > check)<br />
//Set to first texture if available<br />
current_texture = 0;<br />
<br />
display_texture(current_texture);<br />
}<br />
<br />
video() //Change mode to Video<br />
{<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, VIDEO_BRIGHT, PRIM_TEXTURE, DISPLAY_ON_SIDE, "62dc73ca-265f-7ca0-0453-e2a6aa60bb6f", llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
<br />
report("Video mode"+moviename+": Stopped");<br />
if(finditem(NOTECARD) != -1)<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD);<br />
video_texture = llList2Key(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_TEXTURE]),0);<br />
if(video_texture == NULL_KEY)<br />
{<br />
video_texture = VIDEO_DEFAULT;<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_TEXTURE,VIDEO_DEFAULT]);<br />
llSay(0,"No parcel media texture found. Setting texture to default: "+(string)VIDEO_DEFAULT);<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner())<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
}<br />
<br />
llSetTexture(video_texture,DISPLAY_ON_SIDE);<br />
}<br />
<br />
off()<br />
{<br />
report("Click to power on.");<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_LOW, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <0.1,0.1,0.1>, 1.0,PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, FALSE, PRIM_TEXTURE, DISPLAY_ON_SIDE, BLANK, llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
}<br />
<br />
integer finditem(string name) //Finds and returns an item's inventory number<br />
{<br />
integer i;<br />
for(i=0;i<llGetInventoryNumber(INVENTORY_NOTECARD);i++)<br />
if(llGetInventoryName(INVENTORY_NOTECARD,i) == NOTECARD)<br />
return i;<br />
return -1;<br />
}<br />
<br />
seturl(string url, key id) //Set parcel media URL<br />
{<br />
if(mode != 2)<br />
{<br />
video();<br />
mode = 2;<br />
}<br />
moviename = tempmoviename;<br />
if(moviename)<br />
moviename = " ["+moviename+"]";<br />
tempmoviename = "";<br />
string oldurl = llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0);<br />
if(oldurl != "")<br />
llOwnerSay("Setting new media URL. The old URL was: "+oldurl);<br />
<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_URL,url]);<br />
if(id!=NULL_KEY)<br />
menu(id);<br />
else<br />
{<br />
report("Video mode"+moviename+": Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
}<br />
<br />
if(isGroup)<br />
llSay(0,"New media URL set.");<br />
else<br />
llOwnerSay("New media URL set: "+url);<br />
}<br />
<br />
string mediatype(string ext) //Returns a string stating the filetype of a file based on file extension<br />
{<br />
ext = llToLower(ext);<br />
if(ext == "swf")<br />
return "Flash";<br />
if(ext == "mov" || ext == "avi" || ext == "mpg" || ext == "mpeg" || ext == "smil")<br />
return "Video";<br />
if(ext == "jpg" || ext == "mpeg" || ext == "gif" || ext == "png" || ext == "pict" || ext == "tga" || ext == "tiff" || ext == "sgi" || ext == "bmp")<br />
return "Image";<br />
if(ext == "txt")<br />
return "Text";<br />
if(ext == "mp3" || ext == "wav")<br />
return "Audio";<br />
return "Unknown";<br />
}<br />
<br />
browse(key id) //Image browser function for picture viewer mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
string header;<br />
if(check > 0)<br />
header = "("+(string)(current_texture+1)+"/"+(string)check+") "+llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
else<br />
header = "No pictures found.";<br />
llDialog(id,"** Monitor Control **\n Picture Viewer mode\n- Image browser\n- "+header,["Back","Next","Menu"],chan);<br />
extendtimer();<br />
}<br />
<br />
report(string str)<br />
{<br />
llSetObjectDesc(str);<br />
}<br />
<br />
extendtimer() //Add another 2 minute to the Listen Removal timer (use when a Listen event is triggered)<br />
{<br />
if(listenHandle == -1)<br />
listenHandle = llListen(chan,"","","");<br />
listenTimer = (integer)llGetTime() + 120;<br />
if(loop_image == FALSE)<br />
llSetTimerEvent(45);<br />
}<br />
<br />
config(key id) //Configuration menu<br />
{<br />
extendtimer();<br />
llDialog(id,"Current media URL:\n"+llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0)+"\nTip: If the picture is abit off, try 'Align ON'",["Set URL","Align ON","Align OFF","Menu","Set Remote"],chan);<br />
}<br />
<br />
tell_remote(string str)<br />
{<br />
llShout(REMOTE_CHANNEL,llXorBase64Strings(llStringToBase64((string)encryption + str), llStringToBase64((string)encryption)));<br />
}<br />
<br />
menu(key id) //Dialog menus for all 3 modes<br />
{<br />
list buttons = [];<br />
string title = "** Monitor control **";<br />
<br />
extendtimer();<br />
<br />
if(mode != 0)<br />
{<br />
if(mode == 1) //Pictures menu<br />
{<br />
title+="\n Picture Viewer mode";<br />
buttons+=["Browse"];<br />
if(loop_image == FALSE)<br />
buttons+=["Loop"];<br />
else<br />
buttons+=["Unloop"];<br />
buttons+=["Video","Power off","Help","Fix scale"];<br />
}<br />
else //Video menu<br />
{<br />
title+="\n Video display mode\n"+moviename+"\nTip:\nClick 'TV Guide' to view the Online bookmarks.";<br />
buttons+=["Pictures","Configure","Power off","Loop","Unload","Help","Play","Stop","Pause","TV Guide","Bookmarks","Set URL"];<br />
}<br />
}<br />
else<br />
buttons += ["Pictures","Video","Help"];<br />
<br />
llDialog(id,title,buttons,chan);<br />
}<br />
<br />
display_texture(integer check) //Display texture and set name in description (picture mode)<br />
{ //"Check" holds the number of textures in contents. The function uses "current_texture" to display.<br />
string name = llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
llSetTexture(name,DISPLAY_ON_SIDE);<br />
report("Showing picture: "+name+" ("+(string)(current_texture+1)+"/"+(string)check+")");<br />
}<br />
<br />
<br />
next() //Change to next texture (picture mode)<br />
{ //This function is used twice - by the menu and timer. Therefor, it is a dedicated function.<br />
current_texture++;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(check == current_texture)<br />
current_texture = 0;<br />
<br />
display_texture(check);<br />
return;<br />
}<br />
<br />
default<br />
{<br />
state_entry()<br />
{<br />
chan = (integer)llFrand(1000) + 1000; //Pick a random listen channel for the listener<br />
if(PICTURE_ROTATION_TIMER <= 0) //Ensure the value is no less or equal 0<br />
PICTURE_ROTATION_TIMER = 1;<br />
llListenRemove(listenHandle);<br />
listenHandle = -1;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
off();<br />
llOpenRemoteDataChannel();<br />
}<br />
<br />
on_rez(integer i)<br />
{<br />
llResetScript();<br />
}<br />
<br />
touch_start(integer total_number)<br />
{<br />
//-------------------------------------------------------------------------------<br />
//Listen only to owner or group member. Edit this code to change access controls.<br />
if(llDetectedKey(0) != llGetOwner() && llDetectedGroup(0) == FALSE)<br />
return;<br />
//-------------------------------------------------------------------------------<br />
<br />
if(llGetOwnerKey(llGetKey()) != last_owner) //Sense if object has been deeded to group for Web Guide function<br />
{<br />
isGroup = TRUE;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
<br />
if(mode == 2)<br />
{<br />
llSay(0,"Detected change in ownership. Attempting to obtain current parcel media texture...");<br />
video();<br />
}<br />
}<br />
<br />
menu(llDetectedKey(0));<br />
}<br />
<br />
changed(integer change)<br />
{<br />
if(change == CHANGED_INVENTORY) //If inventory change<br />
if(mode == 1) //If picture mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check != 0)<br />
{<br />
current_texture = 0;<br />
display_texture(check);<br />
}<br />
else<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
report("No pictures found.");<br />
}<br />
}<br />
else<br />
if(mode == 2) //If video mode<br />
if(finditem(NOTECARD) != -1) //And bookmarks notecard present<br />
if(notecardkey != llGetInventoryKey(NOTECARD))<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD); //Reload number of lines<br />
}<br />
<br />
listen(integer channel, string name, key id, string message)<br />
{<br />
if(message == "Pictures")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
pictures();<br />
mode = 1;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Video")<br />
{<br />
video();<br />
mode = 2;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Power off")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
off();<br />
mode = 0;<br />
return;<br />
}<br />
if(message == "Help")<br />
{<br />
llSay(0,"Help documentation is available at: http://www.slguide.com/help");<br />
if(isGroup)<br />
{<br />
if(id == NULL_KEY)<br />
{<br />
llSay(0,"FreeView cannot load help pages while set to group without the remote.");<br />
llSay(0,"For further assistance, please consult: http://slguide.com/help");<br />
}<br />
else<br />
tell_remote("HELP"+(string)id+(string)XML_channel);<br />
}<br />
else<br />
llLoadURL(id,"Help pages for FreeView","http://www.slguide.com?c="+(string)XML_channel+"&help=1");<br />
}<br />
if(mode == 1)<br />
{<br />
if(message == "Browse")<br />
{<br />
loop_image = FALSE;<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Next")<br />
{<br />
extendtimer();<br />
next();<br />
browse(id);<br />
}<br />
if(message == "Back")<br />
{<br />
extendtimer();<br />
current_texture--;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(current_texture < 0)<br />
current_texture = check - 1;<br />
<br />
display_texture(check);<br />
<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llSetTimerEvent(PICTURE_ROTATION_TIMER);<br />
loop_image = TRUE;<br />
llOwnerSay("Picture will change every "+(string)PICTURE_ROTATION_TIMER+" seconds.");<br />
return;<br />
}<br />
if(message == "Unloop")<br />
{<br />
loop_image = FALSE;<br />
llOwnerSay("Picture loop disabled.");<br />
return;<br />
}<br />
if(message == "Fix scale")<br />
{<br />
llSay(0,"Setting display texture to 1,1 repeats and 0,0 offset.");<br />
llScaleTexture(1, 1, DISPLAY_ON_SIDE);<br />
llOffsetTexture(0, 0, DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
}<br />
if(mode == 2)<br />
{<br />
if(channel == REMOTE_CHANNEL)<br />
{<br />
if(encryption == 0)<br />
encryption = (integer)message;<br />
llListenRemove(listenRemote);<br />
listenRemote = -1;<br />
llSay(0,"Remote configured ("+(string)id+")");<br />
}<br />
<br />
if(message == "TV Guide")<br />
{<br />
if(isGroup)<br />
{<br />
if(!encryption)<br />
{<br />
llSay(0,"** Error - This FreeView object has been deeded to group. You must use a Remote control to open the TV Guide.");<br />
llSay(0,"You can set up the remote control from the Video -> Configuration menu. Please refer to the notecard for further assistance.");<br />
return;<br />
}<br />
tell_remote((string)id+(string)XML_channel+(string)llGetOwner());<br />
}<br />
else<br />
llLoadURL(id, "Come to the Guide to Start Your Viewer Playing!", "http://slguide.com/index.php?v=" + (string)llGetKey() + "&c=" + (string)XML_channel + "&o=" + (string)llGetOwner() + "&");<br />
return;<br />
}<br />
<br />
string header = "Video mode"+moviename+": ";<br />
<br />
if(message == "<< Prev")<br />
{<br />
notecardline--;<br />
if(notecardline < 0)<br />
notecardline = numberofnotecardlines - 1;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Next >>")<br />
{<br />
notecardline++;<br />
if(notecardline >= numberofnotecardlines)<br />
notecardline = 0;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Use")<br />
{<br />
if(tempurl == "** No URL specified! **")<br />
tempurl = "";<br />
seturl(tempurl,id);<br />
return;<br />
}<br />
<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Configure")<br />
{<br />
config(id);<br />
return;<br />
}<br />
if(message == "Bookmarks")<br />
{<br />
if(notecardcheck != -1)<br />
{<br />
llDialog(id,"Error: No valid bookmark data found in notecard '"+NOTECARD+"'.",["Menu"],chan);<br />
return;<br />
}<br />
if(finditem(NOTECARD) != -1) <br />
{<br />
tempuser = id;<br />
if(numberofnotecardlines < notecardline)<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
}<br />
else<br />
llDialog(id,"Error: No notecard named "+NOTECARD+" found in contents.",["Menu"],chan);<br />
return;<br />
}<br />
<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner()) //If we do not have permissions to actually do the following functions<br />
{<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
menu(id);<br />
return; //Abort<br />
}<br />
<br />
if(listenUrl != -1 && channel == 1) //Incoming data from "Set URL" command (user spoke on channel 1)<br />
{<br />
llListenRemove(listenUrl);<br />
listenUrl = -1;<br />
tempmoviename = "";<br />
seturl(message,id);<br />
}<br />
if(message == "Play")<br />
{<br />
report(header+"Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
return;<br />
}<br />
if(message == "Stop")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
return;<br />
}<br />
if(message == "Pause")<br />
{<br />
report(header+"Paused");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PAUSE]);<br />
return;<br />
}<br />
if(message == "Unload")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_LOOP]);<br />
return;<br />
}<br />
//URL , Auto-Scale, <br />
if(message == "Set URL")<br />
{<br />
report(header+"Stopped");<br />
listenUrl = llListen(1,"",id,"");<br />
llDialog(id,"Please type the URL of your choice with /1 in thebegining. For example, /1 www.google.com",["Ok"],938);<br />
return;<br />
}<br />
if(message == "Align ON")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,TRUE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Align OFF")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,FALSE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Set Remote")<br />
{<br />
llSay(0,"Configuring remote...");<br />
encryption = 0;<br />
llListenRemove(listenRemote);<br />
listenRemote = llListen(REMOTE_CHANNEL,"","","");<br />
llSay(REMOTE_CHANNEL,"SETUP");<br />
}<br />
}<br />
}<br />
<br />
dataserver(key queryid, string data)<br />
{<br />
if(queryid == groupcheck) //Test if object is deeded to group<br />
{<br />
groupcheck = NULL_KEY;<br />
isGroup = FALSE;<br />
return;<br />
}<br />
<br />
if(queryid == tempuser) //If just checking number of notecard lines<br />
{<br />
numberofnotecardlines = (integer)data;<br />
notecardkey = llGetInventoryKey(NOTECARD);<br />
notecardcheck = 0;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
return;<br />
}<br />
if(notecardcheck != -1)<br />
{<br />
if(data != EOF)<br />
{<br />
if(data == "")<br />
{<br />
notecardcheck++;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
}<br />
else<br />
{<br />
notecardcheck = -1;<br />
return;<br />
}<br />
}<br />
else<br />
return;<br />
}<br />
<br />
if(data == "" && notecardline < numberofnotecardlines) //If user just pressed "enter" in bookmarks, skip<br />
{<br />
notecardline++;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
<br />
if(data == EOF)<br />
{<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
list parsed = llParseString2List(data,["|","| "," |"," | "],[]); //Ensure no blank spaces before "http://".<br />
string name = llList2String(parsed,0);<br />
tempurl = llList2String(parsed,1);<br />
if(tempurl == "")<br />
tempurl = "** No URL specified! **";<br />
<br />
tempmoviename = name;<br />
<br />
llDialog(tempuser,"Bookmarks notecard ("+(string)(notecardline+1)+"/"+(string)numberofnotecardlines+")\n"+name+" ("+mediatype(llList2String(llParseString2List(tempurl,["."],[]),-1))+")\n"+tempurl,["<< Prev","Use","Next >>","Menu"],chan);<br />
}<br />
<br />
remote_data(integer type, key channel, key message_id, string sender, integer ival, string sval)<br />
{<br />
if (type == REMOTE_DATA_CHANNEL)<br />
{<br />
XML_channel = channel;<br />
} <br />
else if(type == REMOTE_DATA_REQUEST)<br />
{<br />
list media_info = llParseString2List(sval, ["|"], []);<br />
tempmoviename = llList2String(media_info,0);<br />
seturl(llList2String(media_info,1),NULL_KEY);<br />
llRemoteDataReply(channel, message_id, sval, 1);<br />
}<br />
}<br />
<br />
timer()<br />
{<br />
if(llGetTime() > listenTimer) //If listener time expired...<br />
{<br />
llListenRemove(listenHandle); //Remove listeneres.<br />
llListenRemove(listenUrl);<br />
llListenRemove(listenRemote);<br />
listenHandle = -1;<br />
listenUrl = -1;<br />
listenRemote = -1;<br />
listenTimer = -1;<br />
if(loop_image == FALSE || mode != 1) //If we're not looping pictures or are in picture mode at all<br />
llSetTimerEvent(0.0); //Remove timer<br />
}<br />
<br />
if(loop_image == TRUE && mode == 1) //If we're looping pictures and and we're in picture mode...<br />
next(); //Next picture<br />
}<br />
}<br />
</pre><br />
== Additional Information ==<br />
<br />
[[Category:Media]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Category:MediaCategory:Media2009-02-08T04:33:00Z<p>Rtkwebman: New page: This category contains items related to using various media functions in OpenSim.</p>
<hr />
<div>This category contains items related to using various media functions in OpenSim.</div>Rtkwebmanhttp://opensimulator.org/wiki/Streaming_Media_in_OpenSimStreaming Media in OpenSim2009-02-08T04:31:37Z<p>Rtkwebman: </p>
<hr />
<div>== Introduction ==<br />
<br />
Streaming media in OpenSim works the same way as in SL. One of the most frequent misconceptions about streaming content in OpenSim is the simulator or regions server is actually doing the streaming. This is not true, all streaming happens outside of the metaverse on a seperate dedicated server. The streaming content is fed directly to Quicktime from the viewer. Generally anything able to be played in Quicktime can be viewed in OpenSim through your viewer. Streaming does not impact the performance of the simulator since all content is sent to the viewer and Quicktime player. <br />
<br />
== QuickTime 7 Supported Audio/Video Formats ==<br />
Current supported formats as listed by Apple are:<br />
<br />
=== Supported Video Formats ===<br />
*Animation <br />
*Apple BMP <br />
*Apple Pixlet (Mac OS X v10.3 only) <br />
*Apple Video <br />
*Cinepak <br />
*Component video <br />
*DV and DVC Pro NTSC <br />
*DV PAL <br />
*DVC Pro PAL <br />
*Graphics <br />
*H.261 <br />
*H.263 <br />
*H.264 <br />
*JPEG 2000 <br />
*Microsoft OLE (decode only) <br />
*Microsoft Video 1 (decode only) <br />
*Motion JPEG A <br />
*Motion JPEG B <br />
*MPEG-4 (Part 2) <br />
*Photo JPEG <br />
*Planar RGB <br />
*PNG <br />
*Sorenson Video 2 <br />
*Sorenson Video 3 <br />
*TGA <br />
*TIFF <br />
=== Supported Audio Formats ===<br />
*24-bit integer <br />
*32-bit floating point <br />
*32-bit integer <br />
*64-bit floating point <br />
*AAC (MPEG-4 Audio) <br />
*ALaw 2:1 <br />
*AMR Narrowband <br />
*Apple Lossless Encoder <br />
*IMA 4:1 <br />
*MACE 3:1 <br />
*MACE 6:1 <br />
*MS ADPCM (decode only) <br />
*QDesign Music 2 <br />
*Qualcomm PureVoice (QCELP) <br />
*ULaw 2:1<br />
<br />
== Creating a Media Screen in OpenSim ==<br />
<br />
Now that you understand some of the fundamentals of what is going on with media content in OpenSim you are probably wanting to get started creating a video area so you and your friends can enjoy watching or listening to some media together. The best free script that I have come across is Freeview. The code for this script is listed below and you can simply copy and paste it into a script window to get you started.<br />
<br />
=== General Steps ===<br />
#Make sure you have a texture picked out to use as a media texture. Streaming media has to be displayed on a texture and unless you want to see your media playing all over the place make sure the texture is unique to just the prim you want to use as a view screen.<br />
#Create a prim that will display the media. <br />
#For a good looking display choose a blank texture with a black color for all sides.<br />
#Select just the prim face for the screen and make the texture your media texture from Step 1 and choose white for the color.<br />
#Drop the Freeview script into the Contents tab.<br />
#In the About Land window Media tab change your Replace Texture to the one in Step 1.<br />
#In the About Land window General tab make sure the Allow Deed To Group item is checked.<br />
<br />
At this point if your script compiled correctly then you should be able to click on the media view screen and a menu will pop up. A good test would be to choose the Video button and then the Set URL button. In the chat window type /1 and then a URL to a video that you know exists on a streaming server. The video should begin playing within a minute or so.<br />
<br />
=== Freeview Code ===<br />
<pre><br />
//XEngine:<br />
//FreeView 1.2 WebGuide (revision 3) - By CrystalShard Foo<br />
//Multifunctional Picture viewer and Video control script with webguide support<br />
//This script is distributed for free and must stay that way. <br />
<br />
// *** DO NOT SELL THIS SCRIPT UNDER ANY CIRCUMSTANCE. ***<br />
<br />
//Help for using this script can be obtained at: http://www.slguide.com/help<br />
<br />
//Feel free to modify this script and post your improvement. Leave the credits intact but feel free to add your name at its bottom.<br />
<br />
//Whats new:<br />
//- Now using FULL_BRIGHT instead of PRIM_MATERIAL_LIGHT for the screen display<br />
//- Added an ownership-change code to handle cases where FreeView gets deeded to group post Video Init.<br />
//- Renamed WebGuide to TV-Guide to reflect what this thing does better.<br />
//- Added a 'Fix Scale' button to Picture mode to help against user texture-scale changes.<br />
//- Additional minor help-tips and code improvements<br />
<br />
//Enjoy!<br />
<br />
<br />
//Constants<br />
integer PICTURE_ROTATION_TIMER = 60; //In whole seconds<br />
<br />
integer DISPLAY_ON_SIDE = ALL_SIDES; //Change this to change where the image will be displayed<br />
<br />
key VIDEO_DEFAULT = "71b8ff26-087d-5f44-285b-d38df2e11a81"; //Test pattern - Used as default video texture when one is missing in parcel media<br />
key BLANK = "5748decc-f629-461c-9a36-a35a221fe21f"; //Blank texture - Used when there are no textures to display in Picture mode<br />
string NOTECARD = "bookmarks"; //Used to host URL bookmarks for video streams<br />
<br />
integer VIDEO_BRIGHT = TRUE; //FULL_BRIGHT status for Video<br />
integer PICTURE_BRIGHT = TRUE; //FULL_BRIGHT status for Picture<br />
<br />
integer REMOTE_CHANNEL = 9238742;<br />
<br />
integer mode = 0; //Freeview mode.<br />
//Mode 0 - Power off<br />
//Mode 1 - Picture viewer<br />
//Mode 2 - Video<br />
<br />
integer listenHandle = -1; //Dialog menu listen handler<br />
integer listenUrl = -1; //listen handler for channel 1 for when a URL is being added<br />
integer listenTimer = -1; //Timer variable for removing all listeners after 2 minutes of listener inactivity<br />
integer listenRemote = -1; //listen handler for the remote during initial setup<br />
integer encryption = 0;<br />
integer numberofnotecardlines = 0; //Stores the current number of detected notecard lines.<br />
integer notecardline = 0; //Current notecard line<br />
<br />
integer loop_image = FALSE; //Are we looping pictures with a timer? (picture mode)<br />
integer current_texture = 0; //Current texture number in inventory being displayed (picture mode)<br />
integer chan; //llDialog listen channel<br />
integer notecardcheck = 0;<br />
key video_texture; //Currently used video display texture for parcel media stream<br />
<br />
string moviename;<br />
string tempmoviename;<br />
key notecardkey = NULL_KEY;<br />
key tempuser; //Temp key storge variable<br />
string tempurl; //Temp string storge variable<br />
<br />
integer isGroup = TRUE;<br />
key groupcheck = NULL_KEY;<br />
key last_owner;<br />
key XML_channel;<br />
<br />
pictures() //Change mode to Picture Viewer<br />
{<br />
//Initilize variables<br />
<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, PICTURE_BRIGHT]);<br />
<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
<br />
if(check == 0)<br />
{<br />
report("No pictures found.");<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
else <br />
if(current_texture > check)<br />
//Set to first texture if available<br />
current_texture = 0;<br />
<br />
display_texture(current_texture);<br />
}<br />
<br />
video() //Change mode to Video<br />
{<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, VIDEO_BRIGHT, PRIM_TEXTURE, DISPLAY_ON_SIDE, "62dc73ca-265f-7ca0-0453-e2a6aa60bb6f", llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
<br />
report("Video mode"+moviename+": Stopped");<br />
if(finditem(NOTECARD) != -1)<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD);<br />
video_texture = llList2Key(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_TEXTURE]),0);<br />
if(video_texture == NULL_KEY)<br />
{<br />
video_texture = VIDEO_DEFAULT;<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_TEXTURE,VIDEO_DEFAULT]);<br />
llSay(0,"No parcel media texture found. Setting texture to default: "+(string)VIDEO_DEFAULT);<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner())<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
}<br />
<br />
llSetTexture(video_texture,DISPLAY_ON_SIDE);<br />
}<br />
<br />
off()<br />
{<br />
report("Click to power on.");<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_LOW, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <0.1,0.1,0.1>, 1.0,PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, FALSE, PRIM_TEXTURE, DISPLAY_ON_SIDE, BLANK, llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
}<br />
<br />
integer finditem(string name) //Finds and returns an item's inventory number<br />
{<br />
integer i;<br />
for(i=0;i<llGetInventoryNumber(INVENTORY_NOTECARD);i++)<br />
if(llGetInventoryName(INVENTORY_NOTECARD,i) == NOTECARD)<br />
return i;<br />
return -1;<br />
}<br />
<br />
seturl(string url, key id) //Set parcel media URL<br />
{<br />
if(mode != 2)<br />
{<br />
video();<br />
mode = 2;<br />
}<br />
moviename = tempmoviename;<br />
if(moviename)<br />
moviename = " ["+moviename+"]";<br />
tempmoviename = "";<br />
string oldurl = llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0);<br />
if(oldurl != "")<br />
llOwnerSay("Setting new media URL. The old URL was: "+oldurl);<br />
<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_URL,url]);<br />
if(id!=NULL_KEY)<br />
menu(id);<br />
else<br />
{<br />
report("Video mode"+moviename+": Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
}<br />
<br />
if(isGroup)<br />
llSay(0,"New media URL set.");<br />
else<br />
llOwnerSay("New media URL set: "+url);<br />
}<br />
<br />
string mediatype(string ext) //Returns a string stating the filetype of a file based on file extension<br />
{<br />
ext = llToLower(ext);<br />
if(ext == "swf")<br />
return "Flash";<br />
if(ext == "mov" || ext == "avi" || ext == "mpg" || ext == "mpeg" || ext == "smil")<br />
return "Video";<br />
if(ext == "jpg" || ext == "mpeg" || ext == "gif" || ext == "png" || ext == "pict" || ext == "tga" || ext == "tiff" || ext == "sgi" || ext == "bmp")<br />
return "Image";<br />
if(ext == "txt")<br />
return "Text";<br />
if(ext == "mp3" || ext == "wav")<br />
return "Audio";<br />
return "Unknown";<br />
}<br />
<br />
browse(key id) //Image browser function for picture viewer mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
string header;<br />
if(check > 0)<br />
header = "("+(string)(current_texture+1)+"/"+(string)check+") "+llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
else<br />
header = "No pictures found.";<br />
llDialog(id,"** Monitor Control **\n Picture Viewer mode\n- Image browser\n- "+header,["Back","Next","Menu"],chan);<br />
extendtimer();<br />
}<br />
<br />
report(string str)<br />
{<br />
llSetObjectDesc(str);<br />
}<br />
<br />
extendtimer() //Add another 2 minute to the Listen Removal timer (use when a Listen event is triggered)<br />
{<br />
if(listenHandle == -1)<br />
listenHandle = llListen(chan,"","","");<br />
listenTimer = (integer)llGetTime() + 120;<br />
if(loop_image == FALSE)<br />
llSetTimerEvent(45);<br />
}<br />
<br />
config(key id) //Configuration menu<br />
{<br />
extendtimer();<br />
llDialog(id,"Current media URL:\n"+llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0)+"\nTip: If the picture is abit off, try 'Align ON'",["Set URL","Align ON","Align OFF","Menu","Set Remote"],chan);<br />
}<br />
<br />
tell_remote(string str)<br />
{<br />
llShout(REMOTE_CHANNEL,llXorBase64Strings(llStringToBase64((string)encryption + str), llStringToBase64((string)encryption)));<br />
}<br />
<br />
menu(key id) //Dialog menus for all 3 modes<br />
{<br />
list buttons = [];<br />
string title = "** Monitor control **";<br />
<br />
extendtimer();<br />
<br />
if(mode != 0)<br />
{<br />
if(mode == 1) //Pictures menu<br />
{<br />
title+="\n Picture Viewer mode";<br />
buttons+=["Browse"];<br />
if(loop_image == FALSE)<br />
buttons+=["Loop"];<br />
else<br />
buttons+=["Unloop"];<br />
buttons+=["Video","Power off","Help","Fix scale"];<br />
}<br />
else //Video menu<br />
{<br />
title+="\n Video display mode\n"+moviename+"\nTip:\nClick 'TV Guide' to view the Online bookmarks.";<br />
buttons+=["Pictures","Configure","Power off","Loop","Unload","Help","Play","Stop","Pause","TV Guide","Bookmarks","Set URL"];<br />
}<br />
}<br />
else<br />
buttons += ["Pictures","Video","Help"];<br />
<br />
llDialog(id,title,buttons,chan);<br />
}<br />
<br />
display_texture(integer check) //Display texture and set name in description (picture mode)<br />
{ //"Check" holds the number of textures in contents. The function uses "current_texture" to display.<br />
string name = llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
llSetTexture(name,DISPLAY_ON_SIDE);<br />
report("Showing picture: "+name+" ("+(string)(current_texture+1)+"/"+(string)check+")");<br />
}<br />
<br />
<br />
next() //Change to next texture (picture mode)<br />
{ //This function is used twice - by the menu and timer. Therefor, it is a dedicated function.<br />
current_texture++;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(check == current_texture)<br />
current_texture = 0;<br />
<br />
display_texture(check);<br />
return;<br />
}<br />
<br />
default<br />
{<br />
state_entry()<br />
{<br />
chan = (integer)llFrand(1000) + 1000; //Pick a random listen channel for the listener<br />
if(PICTURE_ROTATION_TIMER <= 0) //Ensure the value is no less or equal 0<br />
PICTURE_ROTATION_TIMER = 1;<br />
llListenRemove(listenHandle);<br />
listenHandle = -1;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
off();<br />
llOpenRemoteDataChannel();<br />
}<br />
<br />
on_rez(integer i)<br />
{<br />
llResetScript();<br />
}<br />
<br />
touch_start(integer total_number)<br />
{<br />
//-------------------------------------------------------------------------------<br />
//Listen only to owner or group member. Edit this code to change access controls.<br />
if(llDetectedKey(0) != llGetOwner() && llDetectedGroup(0) == FALSE)<br />
return;<br />
//-------------------------------------------------------------------------------<br />
<br />
if(llGetOwnerKey(llGetKey()) != last_owner) //Sense if object has been deeded to group for Web Guide function<br />
{<br />
isGroup = TRUE;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
<br />
if(mode == 2)<br />
{<br />
llSay(0,"Detected change in ownership. Attempting to obtain current parcel media texture...");<br />
video();<br />
}<br />
}<br />
<br />
menu(llDetectedKey(0));<br />
}<br />
<br />
changed(integer change)<br />
{<br />
if(change == CHANGED_INVENTORY) //If inventory change<br />
if(mode == 1) //If picture mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check != 0)<br />
{<br />
current_texture = 0;<br />
display_texture(check);<br />
}<br />
else<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
report("No pictures found.");<br />
}<br />
}<br />
else<br />
if(mode == 2) //If video mode<br />
if(finditem(NOTECARD) != -1) //And bookmarks notecard present<br />
if(notecardkey != llGetInventoryKey(NOTECARD))<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD); //Reload number of lines<br />
}<br />
<br />
listen(integer channel, string name, key id, string message)<br />
{<br />
if(message == "Pictures")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
pictures();<br />
mode = 1;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Video")<br />
{<br />
video();<br />
mode = 2;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Power off")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
off();<br />
mode = 0;<br />
return;<br />
}<br />
if(message == "Help")<br />
{<br />
llSay(0,"Help documentation is available at: http://www.slguide.com/help");<br />
if(isGroup)<br />
{<br />
if(id == NULL_KEY)<br />
{<br />
llSay(0,"FreeView cannot load help pages while set to group without the remote.");<br />
llSay(0,"For further assistance, please consult: http://slguide.com/help");<br />
}<br />
else<br />
tell_remote("HELP"+(string)id+(string)XML_channel);<br />
}<br />
else<br />
llLoadURL(id,"Help pages for FreeView","http://www.slguide.com?c="+(string)XML_channel+"&help=1");<br />
}<br />
if(mode == 1)<br />
{<br />
if(message == "Browse")<br />
{<br />
loop_image = FALSE;<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Next")<br />
{<br />
extendtimer();<br />
next();<br />
browse(id);<br />
}<br />
if(message == "Back")<br />
{<br />
extendtimer();<br />
current_texture--;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(current_texture < 0)<br />
current_texture = check - 1;<br />
<br />
display_texture(check);<br />
<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llSetTimerEvent(PICTURE_ROTATION_TIMER);<br />
loop_image = TRUE;<br />
llOwnerSay("Picture will change every "+(string)PICTURE_ROTATION_TIMER+" seconds.");<br />
return;<br />
}<br />
if(message == "Unloop")<br />
{<br />
loop_image = FALSE;<br />
llOwnerSay("Picture loop disabled.");<br />
return;<br />
}<br />
if(message == "Fix scale")<br />
{<br />
llSay(0,"Setting display texture to 1,1 repeats and 0,0 offset.");<br />
llScaleTexture(1, 1, DISPLAY_ON_SIDE);<br />
llOffsetTexture(0, 0, DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
}<br />
if(mode == 2)<br />
{<br />
if(channel == REMOTE_CHANNEL)<br />
{<br />
if(encryption == 0)<br />
encryption = (integer)message;<br />
llListenRemove(listenRemote);<br />
listenRemote = -1;<br />
llSay(0,"Remote configured ("+(string)id+")");<br />
}<br />
<br />
if(message == "TV Guide")<br />
{<br />
if(isGroup)<br />
{<br />
if(!encryption)<br />
{<br />
llSay(0,"** Error - This FreeView object has been deeded to group. You must use a Remote control to open the TV Guide.");<br />
llSay(0,"You can set up the remote control from the Video -> Configuration menu. Please refer to the notecard for further assistance.");<br />
return;<br />
}<br />
tell_remote((string)id+(string)XML_channel+(string)llGetOwner());<br />
}<br />
else<br />
llLoadURL(id, "Come to the Guide to Start Your Viewer Playing!", "http://slguide.com/index.php?v=" + (string)llGetKey() + "&c=" + (string)XML_channel + "&o=" + (string)llGetOwner() + "&");<br />
return;<br />
}<br />
<br />
string header = "Video mode"+moviename+": ";<br />
<br />
if(message == "<< Prev")<br />
{<br />
notecardline--;<br />
if(notecardline < 0)<br />
notecardline = numberofnotecardlines - 1;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Next >>")<br />
{<br />
notecardline++;<br />
if(notecardline >= numberofnotecardlines)<br />
notecardline = 0;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Use")<br />
{<br />
if(tempurl == "** No URL specified! **")<br />
tempurl = "";<br />
seturl(tempurl,id);<br />
return;<br />
}<br />
<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Configure")<br />
{<br />
config(id);<br />
return;<br />
}<br />
if(message == "Bookmarks")<br />
{<br />
if(notecardcheck != -1)<br />
{<br />
llDialog(id,"Error: No valid bookmark data found in notecard '"+NOTECARD+"'.",["Menu"],chan);<br />
return;<br />
}<br />
if(finditem(NOTECARD) != -1) <br />
{<br />
tempuser = id;<br />
if(numberofnotecardlines < notecardline)<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
}<br />
else<br />
llDialog(id,"Error: No notecard named "+NOTECARD+" found in contents.",["Menu"],chan);<br />
return;<br />
}<br />
<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner()) //If we do not have permissions to actually do the following functions<br />
{<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
menu(id);<br />
return; //Abort<br />
}<br />
<br />
if(listenUrl != -1 && channel == 1) //Incoming data from "Set URL" command (user spoke on channel 1)<br />
{<br />
llListenRemove(listenUrl);<br />
listenUrl = -1;<br />
tempmoviename = "";<br />
seturl(message,id);<br />
}<br />
if(message == "Play")<br />
{<br />
report(header+"Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
return;<br />
}<br />
if(message == "Stop")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
return;<br />
}<br />
if(message == "Pause")<br />
{<br />
report(header+"Paused");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PAUSE]);<br />
return;<br />
}<br />
if(message == "Unload")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_LOOP]);<br />
return;<br />
}<br />
//URL , Auto-Scale, <br />
if(message == "Set URL")<br />
{<br />
report(header+"Stopped");<br />
listenUrl = llListen(1,"",id,"");<br />
llDialog(id,"Please type the URL of your choice with /1 in thebegining. For example, /1 www.google.com",["Ok"],938);<br />
return;<br />
}<br />
if(message == "Align ON")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,TRUE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Align OFF")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,FALSE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Set Remote")<br />
{<br />
llSay(0,"Configuring remote...");<br />
encryption = 0;<br />
llListenRemove(listenRemote);<br />
listenRemote = llListen(REMOTE_CHANNEL,"","","");<br />
llSay(REMOTE_CHANNEL,"SETUP");<br />
}<br />
}<br />
}<br />
<br />
dataserver(key queryid, string data)<br />
{<br />
if(queryid == groupcheck) //Test if object is deeded to group<br />
{<br />
groupcheck = NULL_KEY;<br />
isGroup = FALSE;<br />
return;<br />
}<br />
<br />
if(queryid == tempuser) //If just checking number of notecard lines<br />
{<br />
numberofnotecardlines = (integer)data;<br />
notecardkey = llGetInventoryKey(NOTECARD);<br />
notecardcheck = 0;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
return;<br />
}<br />
if(notecardcheck != -1)<br />
{<br />
if(data != EOF)<br />
{<br />
if(data == "")<br />
{<br />
notecardcheck++;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
}<br />
else<br />
{<br />
notecardcheck = -1;<br />
return;<br />
}<br />
}<br />
else<br />
return;<br />
}<br />
<br />
if(data == "" && notecardline < numberofnotecardlines) //If user just pressed "enter" in bookmarks, skip<br />
{<br />
notecardline++;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
<br />
if(data == EOF)<br />
{<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
list parsed = llParseString2List(data,["|","| "," |"," | "],[]); //Ensure no blank spaces before "http://".<br />
string name = llList2String(parsed,0);<br />
tempurl = llList2String(parsed,1);<br />
if(tempurl == "")<br />
tempurl = "** No URL specified! **";<br />
<br />
tempmoviename = name;<br />
<br />
llDialog(tempuser,"Bookmarks notecard ("+(string)(notecardline+1)+"/"+(string)numberofnotecardlines+")\n"+name+" ("+mediatype(llList2String(llParseString2List(tempurl,["."],[]),-1))+")\n"+tempurl,["<< Prev","Use","Next >>","Menu"],chan);<br />
}<br />
<br />
remote_data(integer type, key channel, key message_id, string sender, integer ival, string sval)<br />
{<br />
if (type == REMOTE_DATA_CHANNEL)<br />
{<br />
XML_channel = channel;<br />
} <br />
else if(type == REMOTE_DATA_REQUEST)<br />
{<br />
list media_info = llParseString2List(sval, ["|"], []);<br />
tempmoviename = llList2String(media_info,0);<br />
seturl(llList2String(media_info,1),NULL_KEY);<br />
llRemoteDataReply(channel, message_id, sval, 1);<br />
}<br />
}<br />
<br />
timer()<br />
{<br />
if(llGetTime() > listenTimer) //If listener time expired...<br />
{<br />
llListenRemove(listenHandle); //Remove listeneres.<br />
llListenRemove(listenUrl);<br />
llListenRemove(listenRemote);<br />
listenHandle = -1;<br />
listenUrl = -1;<br />
listenRemote = -1;<br />
listenTimer = -1;<br />
if(loop_image == FALSE || mode != 1) //If we're not looping pictures or are in picture mode at all<br />
llSetTimerEvent(0.0); //Remove timer<br />
}<br />
<br />
if(loop_image == TRUE && mode == 1) //If we're looping pictures and and we're in picture mode...<br />
next(); //Next picture<br />
}<br />
}<br />
</pre><br />
== Additional Information ==<br />
<br />
[[Category:Media]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Streaming_Media_in_OpenSimStreaming Media in OpenSim2009-02-08T04:26:50Z<p>Rtkwebman: </p>
<hr />
<div>== Introduction ==<br />
<br />
Streaming media in OpenSim works the same way as in SL. One of the most frequent misconceptions about streaming content in OpenSim is the simulator or regions server is actually doing the streaming. This is not true, all streaming happens outside of the metaverse on a seperate dedicated server. The streaming content is fed directly to Quicktime from the viewer. Generally anything able to be played in Quicktime can be viewed in OpenSim through your viewer. Streaming does not impact the performance of the simulator since all content is sent to the viewer and Quicktime player. <br />
<br />
== QuickTime 7 Supported Audio/Video Formats ==<br />
Current supported formats as listed by Apple are:<br />
<br />
=== Supported Video Formats ===<br />
*Animation <br />
*Apple BMP <br />
*Apple Pixlet (Mac OS X v10.3 only) <br />
*Apple Video <br />
*Cinepak <br />
*Component video <br />
*DV and DVC Pro NTSC <br />
*DV PAL <br />
*DVC Pro PAL <br />
*Graphics <br />
*H.261 <br />
*H.263 <br />
*H.264 <br />
*JPEG 2000 <br />
*Microsoft OLE (decode only) <br />
*Microsoft Video 1 (decode only) <br />
*Motion JPEG A <br />
*Motion JPEG B <br />
*MPEG-4 (Part 2) <br />
*Photo JPEG <br />
*Planar RGB <br />
*PNG <br />
*Sorenson Video 2 <br />
*Sorenson Video 3 <br />
*TGA <br />
*TIFF <br />
=== Supported Audio Formats ===<br />
*24-bit integer <br />
*32-bit floating point <br />
*32-bit integer <br />
*64-bit floating point <br />
*AAC (MPEG-4 Audio) <br />
*ALaw 2:1 <br />
*AMR Narrowband <br />
*Apple Lossless Encoder <br />
*IMA 4:1 <br />
*MACE 3:1 <br />
*MACE 6:1 <br />
*MS ADPCM (decode only) <br />
*QDesign Music 2 <br />
*Qualcomm PureVoice (QCELP) <br />
*ULaw 2:1<br />
<br />
== Creating a Media Screen in OpenSim ==<br />
<br />
Now that you understand some of the fundamentals of what is going on with media content in OpenSim you are probably wanting to get started creating a video area so you and your friends can enjoy watching or listening to some media together. The best free script that I have come across is Freeview. The code for this script is listed below and you can simply copy and paste it into a script window to get you started.<br />
<br />
=== General Steps ===<br />
#Make sure you have a texture picked out to use as a media texture. Streaming media has to be displayed on a texture and unless you want to see your media playing all over the place make sure the texture is unique to just the prim you want to use as a view screen.<br />
#Create a prim that will display the media. <br />
#For a good looking display choose a blank texture with a black color for all sides.<br />
#Select just the prim face for the screen and make the texture your media texture from Step 1 and choose white for the color.<br />
#Drop the Freeview script into the Contents tab.<br />
#In the About Land window Media tab change your Replace Texture to the one in Step 1.<br />
#In the About Land window General tab make sure the Allow Deed To Group item is checked.<br />
<br />
At this point if your script compiled correctly then you should be able to click on the media view screen and a menu will pop up. A good test would be to choose the Video button and then the Set URL button. In the chat window type /1 and then a URL to a video that you know exists on a streaming server. The video should begin playing within a minute or so.<br />
<br />
=== Freeview Code ===<br />
<pre><br />
//XEngine:<br />
//FreeView 1.2 WebGuide (revision 3) - By CrystalShard Foo<br />
//Multifunctional Picture viewer and Video control script with webguide support<br />
//This script is distributed for free and must stay that way. <br />
<br />
// *** DO NOT SELL THIS SCRIPT UNDER ANY CIRCUMSTANCE. ***<br />
<br />
//Help for using this script can be obtained at: http://www.slguide.com/help<br />
<br />
//Feel free to modify this script and post your improvement. Leave the credits intact but feel free to add your name at its bottom.<br />
<br />
//Whats new:<br />
//- Now using FULL_BRIGHT instead of PRIM_MATERIAL_LIGHT for the screen display<br />
//- Added an ownership-change code to handle cases where FreeView gets deeded to group post Video Init.<br />
//- Renamed WebGuide to TV-Guide to reflect what this thing does better.<br />
//- Added a 'Fix Scale' button to Picture mode to help against user texture-scale changes.<br />
//- Additional minor help-tips and code improvements<br />
<br />
//Enjoy!<br />
<br />
<br />
//Constants<br />
integer PICTURE_ROTATION_TIMER = 60; //In whole seconds<br />
<br />
integer DISPLAY_ON_SIDE = ALL_SIDES; //Change this to change where the image will be displayed<br />
<br />
key VIDEO_DEFAULT = "71b8ff26-087d-5f44-285b-d38df2e11a81"; //Test pattern - Used as default video texture when one is missing in parcel media<br />
key BLANK = "5748decc-f629-461c-9a36-a35a221fe21f"; //Blank texture - Used when there are no textures to display in Picture mode<br />
string NOTECARD = "bookmarks"; //Used to host URL bookmarks for video streams<br />
<br />
integer VIDEO_BRIGHT = TRUE; //FULL_BRIGHT status for Video<br />
integer PICTURE_BRIGHT = TRUE; //FULL_BRIGHT status for Picture<br />
<br />
integer REMOTE_CHANNEL = 9238742;<br />
<br />
integer mode = 0; //Freeview mode.<br />
//Mode 0 - Power off<br />
//Mode 1 - Picture viewer<br />
//Mode 2 - Video<br />
<br />
integer listenHandle = -1; //Dialog menu listen handler<br />
integer listenUrl = -1; //listen handler for channel 1 for when a URL is being added<br />
integer listenTimer = -1; //Timer variable for removing all listeners after 2 minutes of listener inactivity<br />
integer listenRemote = -1; //listen handler for the remote during initial setup<br />
integer encryption = 0;<br />
integer numberofnotecardlines = 0; //Stores the current number of detected notecard lines.<br />
integer notecardline = 0; //Current notecard line<br />
<br />
integer loop_image = FALSE; //Are we looping pictures with a timer? (picture mode)<br />
integer current_texture = 0; //Current texture number in inventory being displayed (picture mode)<br />
integer chan; //llDialog listen channel<br />
integer notecardcheck = 0;<br />
key video_texture; //Currently used video display texture for parcel media stream<br />
<br />
string moviename;<br />
string tempmoviename;<br />
key notecardkey = NULL_KEY;<br />
key tempuser; //Temp key storge variable<br />
string tempurl; //Temp string storge variable<br />
<br />
integer isGroup = TRUE;<br />
key groupcheck = NULL_KEY;<br />
key last_owner;<br />
key XML_channel;<br />
<br />
pictures() //Change mode to Picture Viewer<br />
{<br />
//Initilize variables<br />
<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, PICTURE_BRIGHT]);<br />
<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
<br />
if(check == 0)<br />
{<br />
report("No pictures found.");<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
else <br />
if(current_texture > check)<br />
//Set to first texture if available<br />
current_texture = 0;<br />
<br />
display_texture(current_texture);<br />
}<br />
<br />
video() //Change mode to Video<br />
{<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, VIDEO_BRIGHT, PRIM_TEXTURE, DISPLAY_ON_SIDE, "62dc73ca-265f-7ca0-0453-e2a6aa60bb6f", llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
<br />
report("Video mode"+moviename+": Stopped");<br />
if(finditem(NOTECARD) != -1)<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD);<br />
video_texture = llList2Key(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_TEXTURE]),0);<br />
if(video_texture == NULL_KEY)<br />
{<br />
video_texture = VIDEO_DEFAULT;<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_TEXTURE,VIDEO_DEFAULT]);<br />
llSay(0,"No parcel media texture found. Setting texture to default: "+(string)VIDEO_DEFAULT);<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner())<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
}<br />
<br />
llSetTexture(video_texture,DISPLAY_ON_SIDE);<br />
}<br />
<br />
off()<br />
{<br />
report("Click to power on.");<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_LOW, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <0.1,0.1,0.1>, 1.0,PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, FALSE, PRIM_TEXTURE, DISPLAY_ON_SIDE, BLANK, llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
}<br />
<br />
integer finditem(string name) //Finds and returns an item's inventory number<br />
{<br />
integer i;<br />
for(i=0;i<llGetInventoryNumber(INVENTORY_NOTECARD);i++)<br />
if(llGetInventoryName(INVENTORY_NOTECARD,i) == NOTECARD)<br />
return i;<br />
return -1;<br />
}<br />
<br />
seturl(string url, key id) //Set parcel media URL<br />
{<br />
if(mode != 2)<br />
{<br />
video();<br />
mode = 2;<br />
}<br />
moviename = tempmoviename;<br />
if(moviename)<br />
moviename = " ["+moviename+"]";<br />
tempmoviename = "";<br />
string oldurl = llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0);<br />
if(oldurl != "")<br />
llOwnerSay("Setting new media URL. The old URL was: "+oldurl);<br />
<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_URL,url]);<br />
if(id!=NULL_KEY)<br />
menu(id);<br />
else<br />
{<br />
report("Video mode"+moviename+": Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
}<br />
<br />
if(isGroup)<br />
llSay(0,"New media URL set.");<br />
else<br />
llOwnerSay("New media URL set: "+url);<br />
}<br />
<br />
string mediatype(string ext) //Returns a string stating the filetype of a file based on file extension<br />
{<br />
ext = llToLower(ext);<br />
if(ext == "swf")<br />
return "Flash";<br />
if(ext == "mov" || ext == "avi" || ext == "mpg" || ext == "mpeg" || ext == "smil")<br />
return "Video";<br />
if(ext == "jpg" || ext == "mpeg" || ext == "gif" || ext == "png" || ext == "pict" || ext == "tga" || ext == "tiff" || ext == "sgi" || ext == "bmp")<br />
return "Image";<br />
if(ext == "txt")<br />
return "Text";<br />
if(ext == "mp3" || ext == "wav")<br />
return "Audio";<br />
return "Unknown";<br />
}<br />
<br />
browse(key id) //Image browser function for picture viewer mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
string header;<br />
if(check > 0)<br />
header = "("+(string)(current_texture+1)+"/"+(string)check+") "+llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
else<br />
header = "No pictures found.";<br />
llDialog(id,"** Monitor Control **\n Picture Viewer mode\n- Image browser\n- "+header,["Back","Next","Menu"],chan);<br />
extendtimer();<br />
}<br />
<br />
report(string str)<br />
{<br />
llSetObjectDesc(str);<br />
}<br />
<br />
extendtimer() //Add another 2 minute to the Listen Removal timer (use when a Listen event is triggered)<br />
{<br />
if(listenHandle == -1)<br />
listenHandle = llListen(chan,"","","");<br />
listenTimer = (integer)llGetTime() + 120;<br />
if(loop_image == FALSE)<br />
llSetTimerEvent(45);<br />
}<br />
<br />
config(key id) //Configuration menu<br />
{<br />
extendtimer();<br />
llDialog(id,"Current media URL:\n"+llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0)+"\nTip: If the picture is abit off, try 'Align ON'",["Set URL","Align ON","Align OFF","Menu","Set Remote"],chan);<br />
}<br />
<br />
tell_remote(string str)<br />
{<br />
llShout(REMOTE_CHANNEL,llXorBase64Strings(llStringToBase64((string)encryption + str), llStringToBase64((string)encryption)));<br />
}<br />
<br />
menu(key id) //Dialog menus for all 3 modes<br />
{<br />
list buttons = [];<br />
string title = "** Monitor control **";<br />
<br />
extendtimer();<br />
<br />
if(mode != 0)<br />
{<br />
if(mode == 1) //Pictures menu<br />
{<br />
title+="\n Picture Viewer mode";<br />
buttons+=["Browse"];<br />
if(loop_image == FALSE)<br />
buttons+=["Loop"];<br />
else<br />
buttons+=["Unloop"];<br />
buttons+=["Video","Power off","Help","Fix scale"];<br />
}<br />
else //Video menu<br />
{<br />
title+="\n Video display mode\n"+moviename+"\nTip:\nClick 'TV Guide' to view the Online bookmarks.";<br />
buttons+=["Pictures","Configure","Power off","Loop","Unload","Help","Play","Stop","Pause","TV Guide","Bookmarks","Set URL"];<br />
}<br />
}<br />
else<br />
buttons += ["Pictures","Video","Help"];<br />
<br />
llDialog(id,title,buttons,chan);<br />
}<br />
<br />
display_texture(integer check) //Display texture and set name in description (picture mode)<br />
{ //"Check" holds the number of textures in contents. The function uses "current_texture" to display.<br />
string name = llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
llSetTexture(name,DISPLAY_ON_SIDE);<br />
report("Showing picture: "+name+" ("+(string)(current_texture+1)+"/"+(string)check+")");<br />
}<br />
<br />
<br />
next() //Change to next texture (picture mode)<br />
{ //This function is used twice - by the menu and timer. Therefor, it is a dedicated function.<br />
current_texture++;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(check == current_texture)<br />
current_texture = 0;<br />
<br />
display_texture(check);<br />
return;<br />
}<br />
<br />
default<br />
{<br />
state_entry()<br />
{<br />
chan = (integer)llFrand(1000) + 1000; //Pick a random listen channel for the listener<br />
if(PICTURE_ROTATION_TIMER <= 0) //Ensure the value is no less or equal 0<br />
PICTURE_ROTATION_TIMER = 1;<br />
llListenRemove(listenHandle);<br />
listenHandle = -1;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
off();<br />
llOpenRemoteDataChannel();<br />
}<br />
<br />
on_rez(integer i)<br />
{<br />
llResetScript();<br />
}<br />
<br />
touch_start(integer total_number)<br />
{<br />
//-------------------------------------------------------------------------------<br />
//Listen only to owner or group member. Edit this code to change access controls.<br />
if(llDetectedKey(0) != llGetOwner() && llDetectedGroup(0) == FALSE)<br />
return;<br />
//-------------------------------------------------------------------------------<br />
<br />
if(llGetOwnerKey(llGetKey()) != last_owner) //Sense if object has been deeded to group for Web Guide function<br />
{<br />
isGroup = TRUE;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
<br />
if(mode == 2)<br />
{<br />
llSay(0,"Detected change in ownership. Attempting to obtain current parcel media texture...");<br />
video();<br />
}<br />
}<br />
<br />
menu(llDetectedKey(0));<br />
}<br />
<br />
changed(integer change)<br />
{<br />
if(change == CHANGED_INVENTORY) //If inventory change<br />
if(mode == 1) //If picture mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check != 0)<br />
{<br />
current_texture = 0;<br />
display_texture(check);<br />
}<br />
else<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
report("No pictures found.");<br />
}<br />
}<br />
else<br />
if(mode == 2) //If video mode<br />
if(finditem(NOTECARD) != -1) //And bookmarks notecard present<br />
if(notecardkey != llGetInventoryKey(NOTECARD))<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD); //Reload number of lines<br />
}<br />
<br />
listen(integer channel, string name, key id, string message)<br />
{<br />
if(message == "Pictures")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
pictures();<br />
mode = 1;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Video")<br />
{<br />
video();<br />
mode = 2;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Power off")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
off();<br />
mode = 0;<br />
return;<br />
}<br />
if(message == "Help")<br />
{<br />
llSay(0,"Help documentation is available at: http://www.slguide.com/help");<br />
if(isGroup)<br />
{<br />
if(id == NULL_KEY)<br />
{<br />
llSay(0,"FreeView cannot load help pages while set to group without the remote.");<br />
llSay(0,"For further assistance, please consult: http://slguide.com/help");<br />
}<br />
else<br />
tell_remote("HELP"+(string)id+(string)XML_channel);<br />
}<br />
else<br />
llLoadURL(id,"Help pages for FreeView","http://www.slguide.com?c="+(string)XML_channel+"&help=1");<br />
}<br />
if(mode == 1)<br />
{<br />
if(message == "Browse")<br />
{<br />
loop_image = FALSE;<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Next")<br />
{<br />
extendtimer();<br />
next();<br />
browse(id);<br />
}<br />
if(message == "Back")<br />
{<br />
extendtimer();<br />
current_texture--;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(current_texture < 0)<br />
current_texture = check - 1;<br />
<br />
display_texture(check);<br />
<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llSetTimerEvent(PICTURE_ROTATION_TIMER);<br />
loop_image = TRUE;<br />
llOwnerSay("Picture will change every "+(string)PICTURE_ROTATION_TIMER+" seconds.");<br />
return;<br />
}<br />
if(message == "Unloop")<br />
{<br />
loop_image = FALSE;<br />
llOwnerSay("Picture loop disabled.");<br />
return;<br />
}<br />
if(message == "Fix scale")<br />
{<br />
llSay(0,"Setting display texture to 1,1 repeats and 0,0 offset.");<br />
llScaleTexture(1, 1, DISPLAY_ON_SIDE);<br />
llOffsetTexture(0, 0, DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
}<br />
if(mode == 2)<br />
{<br />
if(channel == REMOTE_CHANNEL)<br />
{<br />
if(encryption == 0)<br />
encryption = (integer)message;<br />
llListenRemove(listenRemote);<br />
listenRemote = -1;<br />
llSay(0,"Remote configured ("+(string)id+")");<br />
}<br />
<br />
if(message == "TV Guide")<br />
{<br />
if(isGroup)<br />
{<br />
if(!encryption)<br />
{<br />
llSay(0,"** Error - This FreeView object has been deeded to group. You must use a Remote control to open the TV Guide.");<br />
llSay(0,"You can set up the remote control from the Video -> Configuration menu. Please refer to the notecard for further assistance.");<br />
return;<br />
}<br />
tell_remote((string)id+(string)XML_channel+(string)llGetOwner());<br />
}<br />
else<br />
llLoadURL(id, "Come to the Guide to Start Your Viewer Playing!", "http://slguide.com/index.php?v=" + (string)llGetKey() + "&c=" + (string)XML_channel + "&o=" + (string)llGetOwner() + "&");<br />
return;<br />
}<br />
<br />
string header = "Video mode"+moviename+": ";<br />
<br />
if(message == "<< Prev")<br />
{<br />
notecardline--;<br />
if(notecardline < 0)<br />
notecardline = numberofnotecardlines - 1;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Next >>")<br />
{<br />
notecardline++;<br />
if(notecardline >= numberofnotecardlines)<br />
notecardline = 0;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Use")<br />
{<br />
if(tempurl == "** No URL specified! **")<br />
tempurl = "";<br />
seturl(tempurl,id);<br />
return;<br />
}<br />
<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Configure")<br />
{<br />
config(id);<br />
return;<br />
}<br />
if(message == "Bookmarks")<br />
{<br />
if(notecardcheck != -1)<br />
{<br />
llDialog(id,"Error: No valid bookmark data found in notecard '"+NOTECARD+"'.",["Menu"],chan);<br />
return;<br />
}<br />
if(finditem(NOTECARD) != -1) <br />
{<br />
tempuser = id;<br />
if(numberofnotecardlines < notecardline)<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
}<br />
else<br />
llDialog(id,"Error: No notecard named "+NOTECARD+" found in contents.",["Menu"],chan);<br />
return;<br />
}<br />
<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner()) //If we do not have permissions to actually do the following functions<br />
{<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
menu(id);<br />
return; //Abort<br />
}<br />
<br />
if(listenUrl != -1 && channel == 1) //Incoming data from "Set URL" command (user spoke on channel 1)<br />
{<br />
llListenRemove(listenUrl);<br />
listenUrl = -1;<br />
tempmoviename = "";<br />
seturl(message,id);<br />
}<br />
if(message == "Play")<br />
{<br />
report(header+"Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
return;<br />
}<br />
if(message == "Stop")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
return;<br />
}<br />
if(message == "Pause")<br />
{<br />
report(header+"Paused");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PAUSE]);<br />
return;<br />
}<br />
if(message == "Unload")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_LOOP]);<br />
return;<br />
}<br />
//URL , Auto-Scale, <br />
if(message == "Set URL")<br />
{<br />
report(header+"Stopped");<br />
listenUrl = llListen(1,"",id,"");<br />
llDialog(id,"Please type the URL of your choice with /1 in thebegining. For example, /1 www.google.com",["Ok"],938);<br />
return;<br />
}<br />
if(message == "Align ON")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,TRUE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Align OFF")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,FALSE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Set Remote")<br />
{<br />
llSay(0,"Configuring remote...");<br />
encryption = 0;<br />
llListenRemove(listenRemote);<br />
listenRemote = llListen(REMOTE_CHANNEL,"","","");<br />
llSay(REMOTE_CHANNEL,"SETUP");<br />
}<br />
}<br />
}<br />
<br />
dataserver(key queryid, string data)<br />
{<br />
if(queryid == groupcheck) //Test if object is deeded to group<br />
{<br />
groupcheck = NULL_KEY;<br />
isGroup = FALSE;<br />
return;<br />
}<br />
<br />
if(queryid == tempuser) //If just checking number of notecard lines<br />
{<br />
numberofnotecardlines = (integer)data;<br />
notecardkey = llGetInventoryKey(NOTECARD);<br />
notecardcheck = 0;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
return;<br />
}<br />
if(notecardcheck != -1)<br />
{<br />
if(data != EOF)<br />
{<br />
if(data == "")<br />
{<br />
notecardcheck++;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
}<br />
else<br />
{<br />
notecardcheck = -1;<br />
return;<br />
}<br />
}<br />
else<br />
return;<br />
}<br />
<br />
if(data == "" && notecardline < numberofnotecardlines) //If user just pressed "enter" in bookmarks, skip<br />
{<br />
notecardline++;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
<br />
if(data == EOF)<br />
{<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
list parsed = llParseString2List(data,["|","| "," |"," | "],[]); //Ensure no blank spaces before "http://".<br />
string name = llList2String(parsed,0);<br />
tempurl = llList2String(parsed,1);<br />
if(tempurl == "")<br />
tempurl = "** No URL specified! **";<br />
<br />
tempmoviename = name;<br />
<br />
llDialog(tempuser,"Bookmarks notecard ("+(string)(notecardline+1)+"/"+(string)numberofnotecardlines+")\n"+name+" ("+mediatype(llList2String(llParseString2List(tempurl,["."],[]),-1))+")\n"+tempurl,["<< Prev","Use","Next >>","Menu"],chan);<br />
}<br />
<br />
remote_data(integer type, key channel, key message_id, string sender, integer ival, string sval)<br />
{<br />
if (type == REMOTE_DATA_CHANNEL)<br />
{<br />
XML_channel = channel;<br />
} <br />
else if(type == REMOTE_DATA_REQUEST)<br />
{<br />
list media_info = llParseString2List(sval, ["|"], []);<br />
tempmoviename = llList2String(media_info,0);<br />
seturl(llList2String(media_info,1),NULL_KEY);<br />
llRemoteDataReply(channel, message_id, sval, 1);<br />
}<br />
}<br />
<br />
timer()<br />
{<br />
if(llGetTime() > listenTimer) //If listener time expired...<br />
{<br />
llListenRemove(listenHandle); //Remove listeneres.<br />
llListenRemove(listenUrl);<br />
llListenRemove(listenRemote);<br />
listenHandle = -1;<br />
listenUrl = -1;<br />
listenRemote = -1;<br />
listenTimer = -1;<br />
if(loop_image == FALSE || mode != 1) //If we're not looping pictures or are in picture mode at all<br />
llSetTimerEvent(0.0); //Remove timer<br />
}<br />
<br />
if(loop_image == TRUE && mode == 1) //If we're looping pictures and and we're in picture mode...<br />
next(); //Next picture<br />
}<br />
}<br />
</pre><br />
<br />
[[Categories:Media]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Streaming_Media_in_OpenSimStreaming Media in OpenSim2009-02-08T04:26:17Z<p>Rtkwebman: /* Supported Audio Formats */</p>
<hr />
<div>Streaming media in OpenSim works the same way as in SL. One of the most frequent misconceptions about streaming content in OpenSim is the simulator or regions server is actually doing the streaming. This is not true, all streaming happens outside of the metaverse on a seperate dedicated server. The streaming content is fed directly to Quicktime from the viewer. Generally anything able to be played in Quicktime can be viewed in OpenSim through your viewer. Streaming does not impact the performance of the simulator since all content is sent to the viewer and Quicktime player. <br />
<br />
== QuickTime 7 Supported Audio/Video Formats ==<br />
Current supported formats as listed by Apple are:<br />
<br />
=== Supported Video Formats ===<br />
*Animation <br />
*Apple BMP <br />
*Apple Pixlet (Mac OS X v10.3 only) <br />
*Apple Video <br />
*Cinepak <br />
*Component video <br />
*DV and DVC Pro NTSC <br />
*DV PAL <br />
*DVC Pro PAL <br />
*Graphics <br />
*H.261 <br />
*H.263 <br />
*H.264 <br />
*JPEG 2000 <br />
*Microsoft OLE (decode only) <br />
*Microsoft Video 1 (decode only) <br />
*Motion JPEG A <br />
*Motion JPEG B <br />
*MPEG-4 (Part 2) <br />
*Photo JPEG <br />
*Planar RGB <br />
*PNG <br />
*Sorenson Video 2 <br />
*Sorenson Video 3 <br />
*TGA <br />
*TIFF <br />
=== Supported Audio Formats ===<br />
*24-bit integer <br />
*32-bit floating point <br />
*32-bit integer <br />
*64-bit floating point <br />
*AAC (MPEG-4 Audio) <br />
*ALaw 2:1 <br />
*AMR Narrowband <br />
*Apple Lossless Encoder <br />
*IMA 4:1 <br />
*MACE 3:1 <br />
*MACE 6:1 <br />
*MS ADPCM (decode only) <br />
*QDesign Music 2 <br />
*Qualcomm PureVoice (QCELP) <br />
*ULaw 2:1<br />
<br />
== Creating a Media Screen in OpenSim ==<br />
<br />
Now that you understand some of the fundamentals of what is going on with media content in OpenSim you are probably wanting to get started creating a video area so you and your friends can enjoy watching or listening to some media together. The best free script that I have come across is Freeview. The code for this script is listed below and you can simply copy and paste it into a script window to get you started.<br />
<br />
=== General Steps ===<br />
#Make sure you have a texture picked out to use as a media texture. Streaming media has to be displayed on a texture and unless you want to see your media playing all over the place make sure the texture is unique to just the prim you want to use as a view screen.<br />
#Create a prim that will display the media. <br />
#For a good looking display choose a blank texture with a black color for all sides.<br />
#Select just the prim face for the screen and make the texture your media texture from Step 1 and choose white for the color.<br />
#Drop the Freeview script into the Contents tab.<br />
#In the About Land window Media tab change your Replace Texture to the one in Step 1.<br />
#In the About Land window General tab make sure the Allow Deed To Group item is checked.<br />
<br />
At this point if your script compiled correctly then you should be able to click on the media view screen and a menu will pop up. A good test would be to choose the Video button and then the Set URL button. In the chat window type /1 and then a URL to a video that you know exists on a streaming server. The video should begin playing within a minute or so.<br />
<br />
=== Freeview Code ===<br />
<pre><br />
//XEngine:<br />
//FreeView 1.2 WebGuide (revision 3) - By CrystalShard Foo<br />
//Multifunctional Picture viewer and Video control script with webguide support<br />
//This script is distributed for free and must stay that way. <br />
<br />
// *** DO NOT SELL THIS SCRIPT UNDER ANY CIRCUMSTANCE. ***<br />
<br />
//Help for using this script can be obtained at: http://www.slguide.com/help<br />
<br />
//Feel free to modify this script and post your improvement. Leave the credits intact but feel free to add your name at its bottom.<br />
<br />
//Whats new:<br />
//- Now using FULL_BRIGHT instead of PRIM_MATERIAL_LIGHT for the screen display<br />
//- Added an ownership-change code to handle cases where FreeView gets deeded to group post Video Init.<br />
//- Renamed WebGuide to TV-Guide to reflect what this thing does better.<br />
//- Added a 'Fix Scale' button to Picture mode to help against user texture-scale changes.<br />
//- Additional minor help-tips and code improvements<br />
<br />
//Enjoy!<br />
<br />
<br />
//Constants<br />
integer PICTURE_ROTATION_TIMER = 60; //In whole seconds<br />
<br />
integer DISPLAY_ON_SIDE = ALL_SIDES; //Change this to change where the image will be displayed<br />
<br />
key VIDEO_DEFAULT = "71b8ff26-087d-5f44-285b-d38df2e11a81"; //Test pattern - Used as default video texture when one is missing in parcel media<br />
key BLANK = "5748decc-f629-461c-9a36-a35a221fe21f"; //Blank texture - Used when there are no textures to display in Picture mode<br />
string NOTECARD = "bookmarks"; //Used to host URL bookmarks for video streams<br />
<br />
integer VIDEO_BRIGHT = TRUE; //FULL_BRIGHT status for Video<br />
integer PICTURE_BRIGHT = TRUE; //FULL_BRIGHT status for Picture<br />
<br />
integer REMOTE_CHANNEL = 9238742;<br />
<br />
integer mode = 0; //Freeview mode.<br />
//Mode 0 - Power off<br />
//Mode 1 - Picture viewer<br />
//Mode 2 - Video<br />
<br />
integer listenHandle = -1; //Dialog menu listen handler<br />
integer listenUrl = -1; //listen handler for channel 1 for when a URL is being added<br />
integer listenTimer = -1; //Timer variable for removing all listeners after 2 minutes of listener inactivity<br />
integer listenRemote = -1; //listen handler for the remote during initial setup<br />
integer encryption = 0;<br />
integer numberofnotecardlines = 0; //Stores the current number of detected notecard lines.<br />
integer notecardline = 0; //Current notecard line<br />
<br />
integer loop_image = FALSE; //Are we looping pictures with a timer? (picture mode)<br />
integer current_texture = 0; //Current texture number in inventory being displayed (picture mode)<br />
integer chan; //llDialog listen channel<br />
integer notecardcheck = 0;<br />
key video_texture; //Currently used video display texture for parcel media stream<br />
<br />
string moviename;<br />
string tempmoviename;<br />
key notecardkey = NULL_KEY;<br />
key tempuser; //Temp key storge variable<br />
string tempurl; //Temp string storge variable<br />
<br />
integer isGroup = TRUE;<br />
key groupcheck = NULL_KEY;<br />
key last_owner;<br />
key XML_channel;<br />
<br />
pictures() //Change mode to Picture Viewer<br />
{<br />
//Initilize variables<br />
<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, PICTURE_BRIGHT]);<br />
<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
<br />
if(check == 0)<br />
{<br />
report("No pictures found.");<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
else <br />
if(current_texture > check)<br />
//Set to first texture if available<br />
current_texture = 0;<br />
<br />
display_texture(current_texture);<br />
}<br />
<br />
video() //Change mode to Video<br />
{<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, VIDEO_BRIGHT, PRIM_TEXTURE, DISPLAY_ON_SIDE, "62dc73ca-265f-7ca0-0453-e2a6aa60bb6f", llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
<br />
report("Video mode"+moviename+": Stopped");<br />
if(finditem(NOTECARD) != -1)<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD);<br />
video_texture = llList2Key(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_TEXTURE]),0);<br />
if(video_texture == NULL_KEY)<br />
{<br />
video_texture = VIDEO_DEFAULT;<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_TEXTURE,VIDEO_DEFAULT]);<br />
llSay(0,"No parcel media texture found. Setting texture to default: "+(string)VIDEO_DEFAULT);<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner())<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
}<br />
<br />
llSetTexture(video_texture,DISPLAY_ON_SIDE);<br />
}<br />
<br />
off()<br />
{<br />
report("Click to power on.");<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_LOW, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <0.1,0.1,0.1>, 1.0,PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, FALSE, PRIM_TEXTURE, DISPLAY_ON_SIDE, BLANK, llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
}<br />
<br />
integer finditem(string name) //Finds and returns an item's inventory number<br />
{<br />
integer i;<br />
for(i=0;i<llGetInventoryNumber(INVENTORY_NOTECARD);i++)<br />
if(llGetInventoryName(INVENTORY_NOTECARD,i) == NOTECARD)<br />
return i;<br />
return -1;<br />
}<br />
<br />
seturl(string url, key id) //Set parcel media URL<br />
{<br />
if(mode != 2)<br />
{<br />
video();<br />
mode = 2;<br />
}<br />
moviename = tempmoviename;<br />
if(moviename)<br />
moviename = " ["+moviename+"]";<br />
tempmoviename = "";<br />
string oldurl = llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0);<br />
if(oldurl != "")<br />
llOwnerSay("Setting new media URL. The old URL was: "+oldurl);<br />
<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_URL,url]);<br />
if(id!=NULL_KEY)<br />
menu(id);<br />
else<br />
{<br />
report("Video mode"+moviename+": Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
}<br />
<br />
if(isGroup)<br />
llSay(0,"New media URL set.");<br />
else<br />
llOwnerSay("New media URL set: "+url);<br />
}<br />
<br />
string mediatype(string ext) //Returns a string stating the filetype of a file based on file extension<br />
{<br />
ext = llToLower(ext);<br />
if(ext == "swf")<br />
return "Flash";<br />
if(ext == "mov" || ext == "avi" || ext == "mpg" || ext == "mpeg" || ext == "smil")<br />
return "Video";<br />
if(ext == "jpg" || ext == "mpeg" || ext == "gif" || ext == "png" || ext == "pict" || ext == "tga" || ext == "tiff" || ext == "sgi" || ext == "bmp")<br />
return "Image";<br />
if(ext == "txt")<br />
return "Text";<br />
if(ext == "mp3" || ext == "wav")<br />
return "Audio";<br />
return "Unknown";<br />
}<br />
<br />
browse(key id) //Image browser function for picture viewer mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
string header;<br />
if(check > 0)<br />
header = "("+(string)(current_texture+1)+"/"+(string)check+") "+llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
else<br />
header = "No pictures found.";<br />
llDialog(id,"** Monitor Control **\n Picture Viewer mode\n- Image browser\n- "+header,["Back","Next","Menu"],chan);<br />
extendtimer();<br />
}<br />
<br />
report(string str)<br />
{<br />
llSetObjectDesc(str);<br />
}<br />
<br />
extendtimer() //Add another 2 minute to the Listen Removal timer (use when a Listen event is triggered)<br />
{<br />
if(listenHandle == -1)<br />
listenHandle = llListen(chan,"","","");<br />
listenTimer = (integer)llGetTime() + 120;<br />
if(loop_image == FALSE)<br />
llSetTimerEvent(45);<br />
}<br />
<br />
config(key id) //Configuration menu<br />
{<br />
extendtimer();<br />
llDialog(id,"Current media URL:\n"+llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0)+"\nTip: If the picture is abit off, try 'Align ON'",["Set URL","Align ON","Align OFF","Menu","Set Remote"],chan);<br />
}<br />
<br />
tell_remote(string str)<br />
{<br />
llShout(REMOTE_CHANNEL,llXorBase64Strings(llStringToBase64((string)encryption + str), llStringToBase64((string)encryption)));<br />
}<br />
<br />
menu(key id) //Dialog menus for all 3 modes<br />
{<br />
list buttons = [];<br />
string title = "** Monitor control **";<br />
<br />
extendtimer();<br />
<br />
if(mode != 0)<br />
{<br />
if(mode == 1) //Pictures menu<br />
{<br />
title+="\n Picture Viewer mode";<br />
buttons+=["Browse"];<br />
if(loop_image == FALSE)<br />
buttons+=["Loop"];<br />
else<br />
buttons+=["Unloop"];<br />
buttons+=["Video","Power off","Help","Fix scale"];<br />
}<br />
else //Video menu<br />
{<br />
title+="\n Video display mode\n"+moviename+"\nTip:\nClick 'TV Guide' to view the Online bookmarks.";<br />
buttons+=["Pictures","Configure","Power off","Loop","Unload","Help","Play","Stop","Pause","TV Guide","Bookmarks","Set URL"];<br />
}<br />
}<br />
else<br />
buttons += ["Pictures","Video","Help"];<br />
<br />
llDialog(id,title,buttons,chan);<br />
}<br />
<br />
display_texture(integer check) //Display texture and set name in description (picture mode)<br />
{ //"Check" holds the number of textures in contents. The function uses "current_texture" to display.<br />
string name = llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
llSetTexture(name,DISPLAY_ON_SIDE);<br />
report("Showing picture: "+name+" ("+(string)(current_texture+1)+"/"+(string)check+")");<br />
}<br />
<br />
<br />
next() //Change to next texture (picture mode)<br />
{ //This function is used twice - by the menu and timer. Therefor, it is a dedicated function.<br />
current_texture++;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(check == current_texture)<br />
current_texture = 0;<br />
<br />
display_texture(check);<br />
return;<br />
}<br />
<br />
default<br />
{<br />
state_entry()<br />
{<br />
chan = (integer)llFrand(1000) + 1000; //Pick a random listen channel for the listener<br />
if(PICTURE_ROTATION_TIMER <= 0) //Ensure the value is no less or equal 0<br />
PICTURE_ROTATION_TIMER = 1;<br />
llListenRemove(listenHandle);<br />
listenHandle = -1;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
off();<br />
llOpenRemoteDataChannel();<br />
}<br />
<br />
on_rez(integer i)<br />
{<br />
llResetScript();<br />
}<br />
<br />
touch_start(integer total_number)<br />
{<br />
//-------------------------------------------------------------------------------<br />
//Listen only to owner or group member. Edit this code to change access controls.<br />
if(llDetectedKey(0) != llGetOwner() && llDetectedGroup(0) == FALSE)<br />
return;<br />
//-------------------------------------------------------------------------------<br />
<br />
if(llGetOwnerKey(llGetKey()) != last_owner) //Sense if object has been deeded to group for Web Guide function<br />
{<br />
isGroup = TRUE;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
<br />
if(mode == 2)<br />
{<br />
llSay(0,"Detected change in ownership. Attempting to obtain current parcel media texture...");<br />
video();<br />
}<br />
}<br />
<br />
menu(llDetectedKey(0));<br />
}<br />
<br />
changed(integer change)<br />
{<br />
if(change == CHANGED_INVENTORY) //If inventory change<br />
if(mode == 1) //If picture mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check != 0)<br />
{<br />
current_texture = 0;<br />
display_texture(check);<br />
}<br />
else<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
report("No pictures found.");<br />
}<br />
}<br />
else<br />
if(mode == 2) //If video mode<br />
if(finditem(NOTECARD) != -1) //And bookmarks notecard present<br />
if(notecardkey != llGetInventoryKey(NOTECARD))<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD); //Reload number of lines<br />
}<br />
<br />
listen(integer channel, string name, key id, string message)<br />
{<br />
if(message == "Pictures")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
pictures();<br />
mode = 1;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Video")<br />
{<br />
video();<br />
mode = 2;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Power off")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
off();<br />
mode = 0;<br />
return;<br />
}<br />
if(message == "Help")<br />
{<br />
llSay(0,"Help documentation is available at: http://www.slguide.com/help");<br />
if(isGroup)<br />
{<br />
if(id == NULL_KEY)<br />
{<br />
llSay(0,"FreeView cannot load help pages while set to group without the remote.");<br />
llSay(0,"For further assistance, please consult: http://slguide.com/help");<br />
}<br />
else<br />
tell_remote("HELP"+(string)id+(string)XML_channel);<br />
}<br />
else<br />
llLoadURL(id,"Help pages for FreeView","http://www.slguide.com?c="+(string)XML_channel+"&help=1");<br />
}<br />
if(mode == 1)<br />
{<br />
if(message == "Browse")<br />
{<br />
loop_image = FALSE;<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Next")<br />
{<br />
extendtimer();<br />
next();<br />
browse(id);<br />
}<br />
if(message == "Back")<br />
{<br />
extendtimer();<br />
current_texture--;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(current_texture < 0)<br />
current_texture = check - 1;<br />
<br />
display_texture(check);<br />
<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llSetTimerEvent(PICTURE_ROTATION_TIMER);<br />
loop_image = TRUE;<br />
llOwnerSay("Picture will change every "+(string)PICTURE_ROTATION_TIMER+" seconds.");<br />
return;<br />
}<br />
if(message == "Unloop")<br />
{<br />
loop_image = FALSE;<br />
llOwnerSay("Picture loop disabled.");<br />
return;<br />
}<br />
if(message == "Fix scale")<br />
{<br />
llSay(0,"Setting display texture to 1,1 repeats and 0,0 offset.");<br />
llScaleTexture(1, 1, DISPLAY_ON_SIDE);<br />
llOffsetTexture(0, 0, DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
}<br />
if(mode == 2)<br />
{<br />
if(channel == REMOTE_CHANNEL)<br />
{<br />
if(encryption == 0)<br />
encryption = (integer)message;<br />
llListenRemove(listenRemote);<br />
listenRemote = -1;<br />
llSay(0,"Remote configured ("+(string)id+")");<br />
}<br />
<br />
if(message == "TV Guide")<br />
{<br />
if(isGroup)<br />
{<br />
if(!encryption)<br />
{<br />
llSay(0,"** Error - This FreeView object has been deeded to group. You must use a Remote control to open the TV Guide.");<br />
llSay(0,"You can set up the remote control from the Video -> Configuration menu. Please refer to the notecard for further assistance.");<br />
return;<br />
}<br />
tell_remote((string)id+(string)XML_channel+(string)llGetOwner());<br />
}<br />
else<br />
llLoadURL(id, "Come to the Guide to Start Your Viewer Playing!", "http://slguide.com/index.php?v=" + (string)llGetKey() + "&c=" + (string)XML_channel + "&o=" + (string)llGetOwner() + "&");<br />
return;<br />
}<br />
<br />
string header = "Video mode"+moviename+": ";<br />
<br />
if(message == "<< Prev")<br />
{<br />
notecardline--;<br />
if(notecardline < 0)<br />
notecardline = numberofnotecardlines - 1;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Next >>")<br />
{<br />
notecardline++;<br />
if(notecardline >= numberofnotecardlines)<br />
notecardline = 0;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Use")<br />
{<br />
if(tempurl == "** No URL specified! **")<br />
tempurl = "";<br />
seturl(tempurl,id);<br />
return;<br />
}<br />
<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Configure")<br />
{<br />
config(id);<br />
return;<br />
}<br />
if(message == "Bookmarks")<br />
{<br />
if(notecardcheck != -1)<br />
{<br />
llDialog(id,"Error: No valid bookmark data found in notecard '"+NOTECARD+"'.",["Menu"],chan);<br />
return;<br />
}<br />
if(finditem(NOTECARD) != -1) <br />
{<br />
tempuser = id;<br />
if(numberofnotecardlines < notecardline)<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
}<br />
else<br />
llDialog(id,"Error: No notecard named "+NOTECARD+" found in contents.",["Menu"],chan);<br />
return;<br />
}<br />
<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner()) //If we do not have permissions to actually do the following functions<br />
{<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
menu(id);<br />
return; //Abort<br />
}<br />
<br />
if(listenUrl != -1 && channel == 1) //Incoming data from "Set URL" command (user spoke on channel 1)<br />
{<br />
llListenRemove(listenUrl);<br />
listenUrl = -1;<br />
tempmoviename = "";<br />
seturl(message,id);<br />
}<br />
if(message == "Play")<br />
{<br />
report(header+"Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
return;<br />
}<br />
if(message == "Stop")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
return;<br />
}<br />
if(message == "Pause")<br />
{<br />
report(header+"Paused");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PAUSE]);<br />
return;<br />
}<br />
if(message == "Unload")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_LOOP]);<br />
return;<br />
}<br />
//URL , Auto-Scale, <br />
if(message == "Set URL")<br />
{<br />
report(header+"Stopped");<br />
listenUrl = llListen(1,"",id,"");<br />
llDialog(id,"Please type the URL of your choice with /1 in thebegining. For example, /1 www.google.com",["Ok"],938);<br />
return;<br />
}<br />
if(message == "Align ON")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,TRUE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Align OFF")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,FALSE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Set Remote")<br />
{<br />
llSay(0,"Configuring remote...");<br />
encryption = 0;<br />
llListenRemove(listenRemote);<br />
listenRemote = llListen(REMOTE_CHANNEL,"","","");<br />
llSay(REMOTE_CHANNEL,"SETUP");<br />
}<br />
}<br />
}<br />
<br />
dataserver(key queryid, string data)<br />
{<br />
if(queryid == groupcheck) //Test if object is deeded to group<br />
{<br />
groupcheck = NULL_KEY;<br />
isGroup = FALSE;<br />
return;<br />
}<br />
<br />
if(queryid == tempuser) //If just checking number of notecard lines<br />
{<br />
numberofnotecardlines = (integer)data;<br />
notecardkey = llGetInventoryKey(NOTECARD);<br />
notecardcheck = 0;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
return;<br />
}<br />
if(notecardcheck != -1)<br />
{<br />
if(data != EOF)<br />
{<br />
if(data == "")<br />
{<br />
notecardcheck++;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
}<br />
else<br />
{<br />
notecardcheck = -1;<br />
return;<br />
}<br />
}<br />
else<br />
return;<br />
}<br />
<br />
if(data == "" && notecardline < numberofnotecardlines) //If user just pressed "enter" in bookmarks, skip<br />
{<br />
notecardline++;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
<br />
if(data == EOF)<br />
{<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
list parsed = llParseString2List(data,["|","| "," |"," | "],[]); //Ensure no blank spaces before "http://".<br />
string name = llList2String(parsed,0);<br />
tempurl = llList2String(parsed,1);<br />
if(tempurl == "")<br />
tempurl = "** No URL specified! **";<br />
<br />
tempmoviename = name;<br />
<br />
llDialog(tempuser,"Bookmarks notecard ("+(string)(notecardline+1)+"/"+(string)numberofnotecardlines+")\n"+name+" ("+mediatype(llList2String(llParseString2List(tempurl,["."],[]),-1))+")\n"+tempurl,["<< Prev","Use","Next >>","Menu"],chan);<br />
}<br />
<br />
remote_data(integer type, key channel, key message_id, string sender, integer ival, string sval)<br />
{<br />
if (type == REMOTE_DATA_CHANNEL)<br />
{<br />
XML_channel = channel;<br />
} <br />
else if(type == REMOTE_DATA_REQUEST)<br />
{<br />
list media_info = llParseString2List(sval, ["|"], []);<br />
tempmoviename = llList2String(media_info,0);<br />
seturl(llList2String(media_info,1),NULL_KEY);<br />
llRemoteDataReply(channel, message_id, sval, 1);<br />
}<br />
}<br />
<br />
timer()<br />
{<br />
if(llGetTime() > listenTimer) //If listener time expired...<br />
{<br />
llListenRemove(listenHandle); //Remove listeneres.<br />
llListenRemove(listenUrl);<br />
llListenRemove(listenRemote);<br />
listenHandle = -1;<br />
listenUrl = -1;<br />
listenRemote = -1;<br />
listenTimer = -1;<br />
if(loop_image == FALSE || mode != 1) //If we're not looping pictures or are in picture mode at all<br />
llSetTimerEvent(0.0); //Remove timer<br />
}<br />
<br />
if(loop_image == TRUE && mode == 1) //If we're looping pictures and and we're in picture mode...<br />
next(); //Next picture<br />
}<br />
}<br />
</pre><br />
<br />
[[Categories:Media]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Streaming_Media_in_OpenSimStreaming Media in OpenSim2009-02-08T04:24:54Z<p>Rtkwebman: </p>
<hr />
<div>Streaming media in OpenSim works the same way as in SL. One of the most frequent misconceptions about streaming content in OpenSim is the simulator or regions server is actually doing the streaming. This is not true, all streaming happens outside of the metaverse on a seperate dedicated server. The streaming content is fed directly to Quicktime from the viewer. Generally anything able to be played in Quicktime can be viewed in OpenSim through your viewer. Streaming does not impact the performance of the simulator since all content is sent to the viewer and Quicktime player. <br />
<br />
== QuickTime 7 Supported Audio/Video Formats ==<br />
Current supported formats as listed by Apple are:<br />
<br />
=== Supported Video Formats ===<br />
*Animation <br />
*Apple BMP <br />
*Apple Pixlet (Mac OS X v10.3 only) <br />
*Apple Video <br />
*Cinepak <br />
*Component video <br />
*DV and DVC Pro NTSC <br />
*DV PAL <br />
*DVC Pro PAL <br />
*Graphics <br />
*H.261 <br />
*H.263 <br />
*H.264 <br />
*JPEG 2000 <br />
*Microsoft OLE (decode only) <br />
*Microsoft Video 1 (decode only) <br />
*Motion JPEG A <br />
*Motion JPEG B <br />
*MPEG-4 (Part 2) <br />
*Photo JPEG <br />
*Planar RGB <br />
*PNG <br />
*Sorenson Video 2 <br />
*Sorenson Video 3 <br />
*TGA <br />
*TIFF <br />
=== Supported Audio Formats ===<br />
*24-bit integer <br />
*32-bit floating point <br />
*32-bit integer <br />
*64-bit floating point <br />
*AAC (MPEG-4 Audio) <br />
*ALaw 2:1 <br />
*AMR Narrowband <br />
*Apple Lossless Encoder <br />
*IMA 4:1 <br />
*MACE 3:1 <br />
*MACE 6:1 <br />
*MS ADPCM (decode only) <br />
*QDesign Music 2 <br />
*Qualcomm PureVoice (QCELP) <br />
*ULaw 2:1<br />
<br />
Creating a Media Screen in OpenSim<br />
<br />
Now that you understand some of the fundamentals of what is going on with media content in OpenSim you are probably wanting to get started creating a video area so you and your friends can enjoy watching or listening to some media together. The best free script that I have come across is Freeview. The code for this script is listed below and you can simply copy and paste it into a script window to get you started.<br />
<br />
General Steps<br />
#Make sure you have a texture picked out to use as a media texture. Streaming media has to be displayed on a texture and unless you want to see your media playing all over the place make sure the texture is unique to just the prim you want to use as a view screen.<br />
#Create a prim that will display the media. <br />
#For a good looking display choose a blank texture with a black color for all sides.<br />
#Select just the prim face for the screen and make the texture your media texture from Step 1 and choose white for the color.<br />
#Drop the Freeview script into the Contents tab.<br />
#In the About Land window Media tab change your Replace Texture to the one in Step 1.<br />
#In the About Land window General tab make sure the Allow Deed To Group item is checked.<br />
<br />
At this point if your script compiled correctly then you should be able to click on the media view screen and a menu will pop up. A good test would be to choose the Video button and then the Set URL button. In the chat window type /1 and then a URL to a video that you know exists on a streaming server. The video should begin playing within a minute or so.<br />
<br />
=== Freeview Code ===<br />
<pre><br />
//XEngine:<br />
//FreeView 1.2 WebGuide (revision 3) - By CrystalShard Foo<br />
//Multifunctional Picture viewer and Video control script with webguide support<br />
//This script is distributed for free and must stay that way. <br />
<br />
// *** DO NOT SELL THIS SCRIPT UNDER ANY CIRCUMSTANCE. ***<br />
<br />
//Help for using this script can be obtained at: http://www.slguide.com/help<br />
<br />
//Feel free to modify this script and post your improvement. Leave the credits intact but feel free to add your name at its bottom.<br />
<br />
//Whats new:<br />
//- Now using FULL_BRIGHT instead of PRIM_MATERIAL_LIGHT for the screen display<br />
//- Added an ownership-change code to handle cases where FreeView gets deeded to group post Video Init.<br />
//- Renamed WebGuide to TV-Guide to reflect what this thing does better.<br />
//- Added a 'Fix Scale' button to Picture mode to help against user texture-scale changes.<br />
//- Additional minor help-tips and code improvements<br />
<br />
//Enjoy!<br />
<br />
<br />
//Constants<br />
integer PICTURE_ROTATION_TIMER = 60; //In whole seconds<br />
<br />
integer DISPLAY_ON_SIDE = ALL_SIDES; //Change this to change where the image will be displayed<br />
<br />
key VIDEO_DEFAULT = "71b8ff26-087d-5f44-285b-d38df2e11a81"; //Test pattern - Used as default video texture when one is missing in parcel media<br />
key BLANK = "5748decc-f629-461c-9a36-a35a221fe21f"; //Blank texture - Used when there are no textures to display in Picture mode<br />
string NOTECARD = "bookmarks"; //Used to host URL bookmarks for video streams<br />
<br />
integer VIDEO_BRIGHT = TRUE; //FULL_BRIGHT status for Video<br />
integer PICTURE_BRIGHT = TRUE; //FULL_BRIGHT status for Picture<br />
<br />
integer REMOTE_CHANNEL = 9238742;<br />
<br />
integer mode = 0; //Freeview mode.<br />
//Mode 0 - Power off<br />
//Mode 1 - Picture viewer<br />
//Mode 2 - Video<br />
<br />
integer listenHandle = -1; //Dialog menu listen handler<br />
integer listenUrl = -1; //listen handler for channel 1 for when a URL is being added<br />
integer listenTimer = -1; //Timer variable for removing all listeners after 2 minutes of listener inactivity<br />
integer listenRemote = -1; //listen handler for the remote during initial setup<br />
integer encryption = 0;<br />
integer numberofnotecardlines = 0; //Stores the current number of detected notecard lines.<br />
integer notecardline = 0; //Current notecard line<br />
<br />
integer loop_image = FALSE; //Are we looping pictures with a timer? (picture mode)<br />
integer current_texture = 0; //Current texture number in inventory being displayed (picture mode)<br />
integer chan; //llDialog listen channel<br />
integer notecardcheck = 0;<br />
key video_texture; //Currently used video display texture for parcel media stream<br />
<br />
string moviename;<br />
string tempmoviename;<br />
key notecardkey = NULL_KEY;<br />
key tempuser; //Temp key storge variable<br />
string tempurl; //Temp string storge variable<br />
<br />
integer isGroup = TRUE;<br />
key groupcheck = NULL_KEY;<br />
key last_owner;<br />
key XML_channel;<br />
<br />
pictures() //Change mode to Picture Viewer<br />
{<br />
//Initilize variables<br />
<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, PICTURE_BRIGHT]);<br />
<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
<br />
if(check == 0)<br />
{<br />
report("No pictures found.");<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
else <br />
if(current_texture > check)<br />
//Set to first texture if available<br />
current_texture = 0;<br />
<br />
display_texture(current_texture);<br />
}<br />
<br />
video() //Change mode to Video<br />
{<br />
//Change prim to Light material while coloring face 0 black to prevent light-lag generation.<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_NONE, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <1,1,1>, 1.0, PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, VIDEO_BRIGHT, PRIM_TEXTURE, DISPLAY_ON_SIDE, "62dc73ca-265f-7ca0-0453-e2a6aa60bb6f", llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
<br />
report("Video mode"+moviename+": Stopped");<br />
if(finditem(NOTECARD) != -1)<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD);<br />
video_texture = llList2Key(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_TEXTURE]),0);<br />
if(video_texture == NULL_KEY)<br />
{<br />
video_texture = VIDEO_DEFAULT;<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_TEXTURE,VIDEO_DEFAULT]);<br />
llSay(0,"No parcel media texture found. Setting texture to default: "+(string)VIDEO_DEFAULT);<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner())<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
}<br />
<br />
llSetTexture(video_texture,DISPLAY_ON_SIDE);<br />
}<br />
<br />
off()<br />
{<br />
report("Click to power on.");<br />
llSetPrimitiveParams([PRIM_BUMP_SHINY, DISPLAY_ON_SIDE, PRIM_SHINY_LOW, PRIM_BUMP_NONE, PRIM_COLOR, DISPLAY_ON_SIDE, <0.1,0.1,0.1>, 1.0,PRIM_MATERIAL, PRIM_MATERIAL_PLASTIC, PRIM_FULLBRIGHT, DISPLAY_ON_SIDE, FALSE, PRIM_TEXTURE, DISPLAY_ON_SIDE, BLANK, llGetTextureScale(DISPLAY_ON_SIDE), llGetTextureOffset(DISPLAY_ON_SIDE), llGetTextureRot(DISPLAY_ON_SIDE)]);<br />
}<br />
<br />
integer finditem(string name) //Finds and returns an item's inventory number<br />
{<br />
integer i;<br />
for(i=0;i<llGetInventoryNumber(INVENTORY_NOTECARD);i++)<br />
if(llGetInventoryName(INVENTORY_NOTECARD,i) == NOTECARD)<br />
return i;<br />
return -1;<br />
}<br />
<br />
seturl(string url, key id) //Set parcel media URL<br />
{<br />
if(mode != 2)<br />
{<br />
video();<br />
mode = 2;<br />
}<br />
moviename = tempmoviename;<br />
if(moviename)<br />
moviename = " ["+moviename+"]";<br />
tempmoviename = "";<br />
string oldurl = llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0);<br />
if(oldurl != "")<br />
llOwnerSay("Setting new media URL. The old URL was: "+oldurl);<br />
<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_URL,url]);<br />
if(id!=NULL_KEY)<br />
menu(id);<br />
else<br />
{<br />
report("Video mode"+moviename+": Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
}<br />
<br />
if(isGroup)<br />
llSay(0,"New media URL set.");<br />
else<br />
llOwnerSay("New media URL set: "+url);<br />
}<br />
<br />
string mediatype(string ext) //Returns a string stating the filetype of a file based on file extension<br />
{<br />
ext = llToLower(ext);<br />
if(ext == "swf")<br />
return "Flash";<br />
if(ext == "mov" || ext == "avi" || ext == "mpg" || ext == "mpeg" || ext == "smil")<br />
return "Video";<br />
if(ext == "jpg" || ext == "mpeg" || ext == "gif" || ext == "png" || ext == "pict" || ext == "tga" || ext == "tiff" || ext == "sgi" || ext == "bmp")<br />
return "Image";<br />
if(ext == "txt")<br />
return "Text";<br />
if(ext == "mp3" || ext == "wav")<br />
return "Audio";<br />
return "Unknown";<br />
}<br />
<br />
browse(key id) //Image browser function for picture viewer mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
string header;<br />
if(check > 0)<br />
header = "("+(string)(current_texture+1)+"/"+(string)check+") "+llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
else<br />
header = "No pictures found.";<br />
llDialog(id,"** Monitor Control **\n Picture Viewer mode\n- Image browser\n- "+header,["Back","Next","Menu"],chan);<br />
extendtimer();<br />
}<br />
<br />
report(string str)<br />
{<br />
llSetObjectDesc(str);<br />
}<br />
<br />
extendtimer() //Add another 2 minute to the Listen Removal timer (use when a Listen event is triggered)<br />
{<br />
if(listenHandle == -1)<br />
listenHandle = llListen(chan,"","","");<br />
listenTimer = (integer)llGetTime() + 120;<br />
if(loop_image == FALSE)<br />
llSetTimerEvent(45);<br />
}<br />
<br />
config(key id) //Configuration menu<br />
{<br />
extendtimer();<br />
llDialog(id,"Current media URL:\n"+llList2String(llParcelMediaQuery([PARCEL_MEDIA_COMMAND_URL]),0)+"\nTip: If the picture is abit off, try 'Align ON'",["Set URL","Align ON","Align OFF","Menu","Set Remote"],chan);<br />
}<br />
<br />
tell_remote(string str)<br />
{<br />
llShout(REMOTE_CHANNEL,llXorBase64Strings(llStringToBase64((string)encryption + str), llStringToBase64((string)encryption)));<br />
}<br />
<br />
menu(key id) //Dialog menus for all 3 modes<br />
{<br />
list buttons = [];<br />
string title = "** Monitor control **";<br />
<br />
extendtimer();<br />
<br />
if(mode != 0)<br />
{<br />
if(mode == 1) //Pictures menu<br />
{<br />
title+="\n Picture Viewer mode";<br />
buttons+=["Browse"];<br />
if(loop_image == FALSE)<br />
buttons+=["Loop"];<br />
else<br />
buttons+=["Unloop"];<br />
buttons+=["Video","Power off","Help","Fix scale"];<br />
}<br />
else //Video menu<br />
{<br />
title+="\n Video display mode\n"+moviename+"\nTip:\nClick 'TV Guide' to view the Online bookmarks.";<br />
buttons+=["Pictures","Configure","Power off","Loop","Unload","Help","Play","Stop","Pause","TV Guide","Bookmarks","Set URL"];<br />
}<br />
}<br />
else<br />
buttons += ["Pictures","Video","Help"];<br />
<br />
llDialog(id,title,buttons,chan);<br />
}<br />
<br />
display_texture(integer check) //Display texture and set name in description (picture mode)<br />
{ //"Check" holds the number of textures in contents. The function uses "current_texture" to display.<br />
string name = llGetInventoryName(INVENTORY_TEXTURE,current_texture);<br />
llSetTexture(name,DISPLAY_ON_SIDE);<br />
report("Showing picture: "+name+" ("+(string)(current_texture+1)+"/"+(string)check+")");<br />
}<br />
<br />
<br />
next() //Change to next texture (picture mode)<br />
{ //This function is used twice - by the menu and timer. Therefor, it is a dedicated function.<br />
current_texture++;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(check == current_texture)<br />
current_texture = 0;<br />
<br />
display_texture(check);<br />
return;<br />
}<br />
<br />
default<br />
{<br />
state_entry()<br />
{<br />
chan = (integer)llFrand(1000) + 1000; //Pick a random listen channel for the listener<br />
if(PICTURE_ROTATION_TIMER <= 0) //Ensure the value is no less or equal 0<br />
PICTURE_ROTATION_TIMER = 1;<br />
llListenRemove(listenHandle);<br />
listenHandle = -1;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
off();<br />
llOpenRemoteDataChannel();<br />
}<br />
<br />
on_rez(integer i)<br />
{<br />
llResetScript();<br />
}<br />
<br />
touch_start(integer total_number)<br />
{<br />
//-------------------------------------------------------------------------------<br />
//Listen only to owner or group member. Edit this code to change access controls.<br />
if(llDetectedKey(0) != llGetOwner() && llDetectedGroup(0) == FALSE)<br />
return;<br />
//-------------------------------------------------------------------------------<br />
<br />
if(llGetOwnerKey(llGetKey()) != last_owner) //Sense if object has been deeded to group for Web Guide function<br />
{<br />
isGroup = TRUE;<br />
last_owner = llGetOwner();<br />
groupcheck = llRequestAgentData(llGetOwner(),DATA_NAME);<br />
<br />
if(mode == 2)<br />
{<br />
llSay(0,"Detected change in ownership. Attempting to obtain current parcel media texture...");<br />
video();<br />
}<br />
}<br />
<br />
menu(llDetectedKey(0));<br />
}<br />
<br />
changed(integer change)<br />
{<br />
if(change == CHANGED_INVENTORY) //If inventory change<br />
if(mode == 1) //If picture mode<br />
{<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check != 0)<br />
{<br />
current_texture = 0;<br />
display_texture(check);<br />
}<br />
else<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
report("No pictures found.");<br />
}<br />
}<br />
else<br />
if(mode == 2) //If video mode<br />
if(finditem(NOTECARD) != -1) //And bookmarks notecard present<br />
if(notecardkey != llGetInventoryKey(NOTECARD))<br />
tempuser = llGetNumberOfNotecardLines(NOTECARD); //Reload number of lines<br />
}<br />
<br />
listen(integer channel, string name, key id, string message)<br />
{<br />
if(message == "Pictures")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
pictures();<br />
mode = 1;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Video")<br />
{<br />
video();<br />
mode = 2;<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Power off")<br />
{<br />
if(mode == 2)<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
off();<br />
mode = 0;<br />
return;<br />
}<br />
if(message == "Help")<br />
{<br />
llSay(0,"Help documentation is available at: http://www.slguide.com/help");<br />
if(isGroup)<br />
{<br />
if(id == NULL_KEY)<br />
{<br />
llSay(0,"FreeView cannot load help pages while set to group without the remote.");<br />
llSay(0,"For further assistance, please consult: http://slguide.com/help");<br />
}<br />
else<br />
tell_remote("HELP"+(string)id+(string)XML_channel);<br />
}<br />
else<br />
llLoadURL(id,"Help pages for FreeView","http://www.slguide.com?c="+(string)XML_channel+"&help=1");<br />
}<br />
if(mode == 1)<br />
{<br />
if(message == "Browse")<br />
{<br />
loop_image = FALSE;<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Next")<br />
{<br />
extendtimer();<br />
next();<br />
browse(id);<br />
}<br />
if(message == "Back")<br />
{<br />
extendtimer();<br />
current_texture--;<br />
integer check = llGetInventoryNumber(INVENTORY_TEXTURE);<br />
if(check == 0)<br />
{<br />
llSetTexture(BLANK,DISPLAY_ON_SIDE);<br />
current_texture = 0;<br />
report("No pictures found.");<br />
return;<br />
}<br />
if(current_texture < 0)<br />
current_texture = check - 1;<br />
<br />
display_texture(check);<br />
<br />
browse(id);<br />
return;<br />
}<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llSetTimerEvent(PICTURE_ROTATION_TIMER);<br />
loop_image = TRUE;<br />
llOwnerSay("Picture will change every "+(string)PICTURE_ROTATION_TIMER+" seconds.");<br />
return;<br />
}<br />
if(message == "Unloop")<br />
{<br />
loop_image = FALSE;<br />
llOwnerSay("Picture loop disabled.");<br />
return;<br />
}<br />
if(message == "Fix scale")<br />
{<br />
llSay(0,"Setting display texture to 1,1 repeats and 0,0 offset.");<br />
llScaleTexture(1, 1, DISPLAY_ON_SIDE);<br />
llOffsetTexture(0, 0, DISPLAY_ON_SIDE);<br />
return;<br />
}<br />
}<br />
if(mode == 2)<br />
{<br />
if(channel == REMOTE_CHANNEL)<br />
{<br />
if(encryption == 0)<br />
encryption = (integer)message;<br />
llListenRemove(listenRemote);<br />
listenRemote = -1;<br />
llSay(0,"Remote configured ("+(string)id+")");<br />
}<br />
<br />
if(message == "TV Guide")<br />
{<br />
if(isGroup)<br />
{<br />
if(!encryption)<br />
{<br />
llSay(0,"** Error - This FreeView object has been deeded to group. You must use a Remote control to open the TV Guide.");<br />
llSay(0,"You can set up the remote control from the Video -> Configuration menu. Please refer to the notecard for further assistance.");<br />
return;<br />
}<br />
tell_remote((string)id+(string)XML_channel+(string)llGetOwner());<br />
}<br />
else<br />
llLoadURL(id, "Come to the Guide to Start Your Viewer Playing!", "http://slguide.com/index.php?v=" + (string)llGetKey() + "&c=" + (string)XML_channel + "&o=" + (string)llGetOwner() + "&");<br />
return;<br />
}<br />
<br />
string header = "Video mode"+moviename+": ";<br />
<br />
if(message == "<< Prev")<br />
{<br />
notecardline--;<br />
if(notecardline < 0)<br />
notecardline = numberofnotecardlines - 1;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Next >>")<br />
{<br />
notecardline++;<br />
if(notecardline >= numberofnotecardlines)<br />
notecardline = 0;<br />
tempuser = id;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
if(message == "Use")<br />
{<br />
if(tempurl == "** No URL specified! **")<br />
tempurl = "";<br />
seturl(tempurl,id);<br />
return;<br />
}<br />
<br />
if(message == "Menu")<br />
{<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Configure")<br />
{<br />
config(id);<br />
return;<br />
}<br />
if(message == "Bookmarks")<br />
{<br />
if(notecardcheck != -1)<br />
{<br />
llDialog(id,"Error: No valid bookmark data found in notecard '"+NOTECARD+"'.",["Menu"],chan);<br />
return;<br />
}<br />
if(finditem(NOTECARD) != -1) <br />
{<br />
tempuser = id;<br />
if(numberofnotecardlines < notecardline)<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
}<br />
else<br />
llDialog(id,"Error: No notecard named "+NOTECARD+" found in contents.",["Menu"],chan);<br />
return;<br />
}<br />
<br />
if(llGetLandOwnerAt(llGetPos()) != llGetOwner()) //If we do not have permissions to actually do the following functions<br />
{<br />
llSay(0,"Error: Cannot modify parcel media settings. "+llGetObjectName()+" is not owned by parcel owner.");<br />
menu(id);<br />
return; //Abort<br />
}<br />
<br />
if(listenUrl != -1 && channel == 1) //Incoming data from "Set URL" command (user spoke on channel 1)<br />
{<br />
llListenRemove(listenUrl);<br />
listenUrl = -1;<br />
tempmoviename = "";<br />
seturl(message,id);<br />
}<br />
if(message == "Play")<br />
{<br />
report(header+"Playing");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PLAY]);<br />
return;<br />
}<br />
if(message == "Stop")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_STOP]);<br />
return;<br />
}<br />
if(message == "Pause")<br />
{<br />
report(header+"Paused");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_PAUSE]);<br />
return;<br />
}<br />
if(message == "Unload")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_UNLOAD]);<br />
return;<br />
}<br />
if(message == "Loop")<br />
{<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_LOOP]);<br />
return;<br />
}<br />
//URL , Auto-Scale, <br />
if(message == "Set URL")<br />
{<br />
report(header+"Stopped");<br />
listenUrl = llListen(1,"",id,"");<br />
llDialog(id,"Please type the URL of your choice with /1 in thebegining. For example, /1 www.google.com",["Ok"],938);<br />
return;<br />
}<br />
if(message == "Align ON")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,TRUE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Align OFF")<br />
{<br />
report(header+"Stopped");<br />
llParcelMediaCommandList([PARCEL_MEDIA_COMMAND_AUTO_ALIGN,FALSE]);<br />
menu(id);<br />
return;<br />
}<br />
if(message == "Set Remote")<br />
{<br />
llSay(0,"Configuring remote...");<br />
encryption = 0;<br />
llListenRemove(listenRemote);<br />
listenRemote = llListen(REMOTE_CHANNEL,"","","");<br />
llSay(REMOTE_CHANNEL,"SETUP");<br />
}<br />
}<br />
}<br />
<br />
dataserver(key queryid, string data)<br />
{<br />
if(queryid == groupcheck) //Test if object is deeded to group<br />
{<br />
groupcheck = NULL_KEY;<br />
isGroup = FALSE;<br />
return;<br />
}<br />
<br />
if(queryid == tempuser) //If just checking number of notecard lines<br />
{<br />
numberofnotecardlines = (integer)data;<br />
notecardkey = llGetInventoryKey(NOTECARD);<br />
notecardcheck = 0;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
return;<br />
}<br />
if(notecardcheck != -1)<br />
{<br />
if(data != EOF)<br />
{<br />
if(data == "")<br />
{<br />
notecardcheck++;<br />
llGetNotecardLine(NOTECARD,notecardcheck);<br />
}<br />
else<br />
{<br />
notecardcheck = -1;<br />
return;<br />
}<br />
}<br />
else<br />
return;<br />
}<br />
<br />
if(data == "" && notecardline < numberofnotecardlines) //If user just pressed "enter" in bookmarks, skip<br />
{<br />
notecardline++;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
<br />
if(data == EOF)<br />
{<br />
notecardline = 0;<br />
llGetNotecardLine(NOTECARD,notecardline);<br />
return;<br />
}<br />
list parsed = llParseString2List(data,["|","| "," |"," | "],[]); //Ensure no blank spaces before "http://".<br />
string name = llList2String(parsed,0);<br />
tempurl = llList2String(parsed,1);<br />
if(tempurl == "")<br />
tempurl = "** No URL specified! **";<br />
<br />
tempmoviename = name;<br />
<br />
llDialog(tempuser,"Bookmarks notecard ("+(string)(notecardline+1)+"/"+(string)numberofnotecardlines+")\n"+name+" ("+mediatype(llList2String(llParseString2List(tempurl,["."],[]),-1))+")\n"+tempurl,["<< Prev","Use","Next >>","Menu"],chan);<br />
}<br />
<br />
remote_data(integer type, key channel, key message_id, string sender, integer ival, string sval)<br />
{<br />
if (type == REMOTE_DATA_CHANNEL)<br />
{<br />
XML_channel = channel;<br />
} <br />
else if(type == REMOTE_DATA_REQUEST)<br />
{<br />
list media_info = llParseString2List(sval, ["|"], []);<br />
tempmoviename = llList2String(media_info,0);<br />
seturl(llList2String(media_info,1),NULL_KEY);<br />
llRemoteDataReply(channel, message_id, sval, 1);<br />
}<br />
}<br />
<br />
timer()<br />
{<br />
if(llGetTime() > listenTimer) //If listener time expired...<br />
{<br />
llListenRemove(listenHandle); //Remove listeneres.<br />
llListenRemove(listenUrl);<br />
llListenRemove(listenRemote);<br />
listenHandle = -1;<br />
listenUrl = -1;<br />
listenRemote = -1;<br />
listenTimer = -1;<br />
if(loop_image == FALSE || mode != 1) //If we're not looping pictures or are in picture mode at all<br />
llSetTimerEvent(0.0); //Remove timer<br />
}<br />
<br />
if(loop_image == TRUE && mode == 1) //If we're looping pictures and and we're in picture mode...<br />
next(); //Next picture<br />
}<br />
}<br />
</pre><br />
<br />
[[Categories:Media]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Streaming_Media_in_OpenSimStreaming Media in OpenSim2009-02-08T04:15:12Z<p>Rtkwebman: New page: Streaming media in OpenSim works the same way as in SL. One of the most frequent misconceptions about streaming content in OpenSim is the simulator or regions server is actually doing the ...</p>
<hr />
<div>Streaming media in OpenSim works the same way as in SL. One of the most frequent misconceptions about streaming content in OpenSim is the simulator or regions server is actually doing the streaming. This is not true, all streaming happens outside of the metaverse on a seperate dedicated server. The streaming content is fed directly to Quicktime from the viewer. Generally anything able to be played in Quicktime can be viewed in OpenSim through your viewer. Streaming does not impact the performance of the simulator since all content is sent to the viewer and Quicktime player. <br />
<br />
== QuickTime 7 Supported Audio/Video Formats ==<br />
Current supported formats as listed by Apple are:<br />
<br />
=== Supported Video Formats ===<br />
*Animation <br />
*Apple BMP <br />
*Apple Pixlet (Mac OS X v10.3 only) <br />
*Apple Video <br />
*Cinepak <br />
*Component video <br />
*DV and DVC Pro NTSC <br />
*DV PAL <br />
*DVC Pro PAL <br />
*Graphics <br />
*H.261 <br />
*H.263 <br />
*H.264 <br />
*JPEG 2000 <br />
*Microsoft OLE (decode only) <br />
*Microsoft Video 1 (decode only) <br />
*Motion JPEG A <br />
*Motion JPEG B <br />
*MPEG-4 (Part 2) <br />
*Photo JPEG <br />
*Planar RGB <br />
*PNG <br />
*Sorenson Video 2 <br />
*Sorenson Video 3 <br />
*TGA <br />
*TIFF <br />
=== Supported Audio Formats ===<br />
*24-bit integer <br />
*32-bit floating point <br />
*32-bit integer <br />
*64-bit floating point <br />
*AAC (MPEG-4 Audio) <br />
*ALaw 2:1 <br />
*AMR Narrowband <br />
*Apple Lossless Encoder <br />
*IMA 4:1 <br />
*MACE 3:1 <br />
*MACE 6:1 <br />
*MS ADPCM (decode only) <br />
*QDesign Music 2 <br />
*Qualcomm PureVoice (QCELP) <br />
*ULaw 2:1<br />
<br />
Creating a Media Screen in OpenSim<br />
<br />
Now that you understand some of the fundamentals of what is going on with media content in OpenSim you are probably wanting to get started creating a video area so you and your friends can enjoy watching or listening to some media together. The best free script that I have come across is Freeview. The code for this script is listed below and you can simply copy and paste it into a script window to get you started.<br />
<br />
General Steps<br />
#Make sure you have a texture picked out to use as a media texture. Streaming media has to be displayed on a texture and unless you want to see your media playing all over the place make sure the texture is unique to just the prim you want to use as a view screen.<br />
#Create a prim that will display the media. <br />
#For a good looking display choose a blank texture with a black color for all sides.<br />
#Select just the prim face for the screen and make the texture your media texture from Step 1 and choose white for the color.<br />
#Drop the Freeview script into the Contents tab.<br />
#In the About Land window Media tab change your Replace Texture to the one in Step 1.<br />
#In the About Land window General tab make sure the Allow Deed To Group item is checked.<br />
<br />
At this point if your script compiled correctly then you should be able to click on the media view screen and a menu will pop up. A good test would be to choose the Video button and then the Set URL button. In the chat window type /1 and then a URL to a video that you know exists on a streaming server. The video should begin playing within a minute or so.<br />
<br />
[[Categories:Media]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2009-02-04T19:12:50Z<p>Rtkwebman: /* The goals are: */</p>
<hr />
<div>__NOTOC__<br />
===How to Upgrade Your Ubuntu Standalone OpenSimulator===<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
=== The goals are: ===<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
2. save-oar test.oar<br />
3. change-region test2<br />
4. save-oar test2.oar<br />
5. shutdown<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
2. cp -R opensim opensimbak<br />
3. rm -Rf opensim<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
5. cd opensim<br />
6. ./runprebuild.sh<br />
7. nant<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
2. cp -f *.db OpenSim.ini *.oar ../../opensim/bin<br />
3. cp -Rf Regions ../../opensim/bin<br />
4. cd ../../opensim/bin<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below) reload your oar files:'''<br />
1. change-region test<br />
2. load-oar test.oar<br />
3. change-region test2<br />
4. load-oar test2.oar<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
2. mono OpenSim.exe<br />
<br />
=== Additional Info ===<br />
Check out the page [[Upgrading]] for some great information on additional <br />
server upgrading issues.<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.<br />
<br />
==== To fix the NHibernate errors: ====<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
[[Category:Upgrading]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Build_InstructionsBuild Instructions2009-01-22T04:15:24Z<p>Rtkwebman: </p>
<hr />
<div>[[Category:Users]]<br />
This page covers building OpenSim from source code on multiple platforms. Please help us keep this page up to date as the project progresses.<br />
<br />
==Download from SVN==<br />
Check out the [[Download]] Section<br />
<br />
==MS Windows==<br />
<br />
OpenSim requires either the .Net framework version 2.0, or the latest Mono. It supports the following compilers:<br />
* [http://msdn2.microsoft.com/en-us/express/aa700756.aspx Microsoft Visual C# Express Edition] (note: not Visual C++)<br />
* [http://www.mono-project.com/ mono]<br />
<br />
Note for people who just downloaded the sources from http://dist.opensimulator.org/ (the "Downloads" link on the left) be advised that some important things are missing (like MySQL template scripts). For such features, you must download using svn!<br />
<br />
Additional note: any Microsoft C# Express edition should work (2005 or 2008)<br />
<br />
Additional note: It is possible to develope on Windows Vista 64 bits with the following tweaks:<br />
# Select OpenSim project properties from solution and choose platform to be x86. Rebuild solution.<br />
# Select OpenSim.exe properties under solution bin folder and choose windows xp sp 2 compatibility mode + run as administrator.<br />
<br />
=== Building ===<br />
<br />
* In the top-level directory, run the '<tt>runprebuild.bat</tt>' file. This will create a VS2005 solution file, a nant build file and a '<tt>compile.bat</tt>' file.<br />
* If you prefer VS2008, run the '<tt>runprebuild2008.bat</tt>' instead.<br />
<br />
* Open the resulting sln file with visual studio and build it there, or<br />
* Run the '<tt>compile.bat</tt>' file. This will build the executable using MSBuild.<br />
* if you prefer to use nant, run nant in the same top-level directory. This will build the executables.<br />
<br />
If you don't care about physics (walking on prims, etc), ignore the rest of this section.<br />
<br />
=== Running ===<br />
<br />
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.<br />
<br />
Double-click on the <tt>OpenSim.exe</tt> executable file in the <tt>bin</tt> directory. This will start up OpenSim in standalone mode.<br />
<br />
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.<br />
<br />
Physics can be invoked by adding the appropriate line to the [Startup] section of <tt>OpenSim.ini</tt>. For ODE, that would be:<br />
<br />
physics = OpenDynamicsEngine<br />
<br />
You can also add a command line option to a shortcut, or run from a command prompt with:<br />
<br />
-physics=OpenDynamicsEngine<br />
<br />
'''''Windows Vista'''''<br />
<br />
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.<br />
<br />
If you have McAfee SecurityCenter, see the description below.<br />
<br />
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.<br />
<br />
<br />
'''''McAfee Security'''''<br />
<br />
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.<br />
<br />
''Disable firewall''<br />
<br />
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".<br />
<br />
''Enable <tt>OpenSim.exe</tt> to open ports''<br />
<br />
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.<br />
<br />
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.<br />
<br />
Finally, select "OK" and exit the McAfee SecurityCenter window.<br />
<br />
==Linux/Mac OS X/FreeBSD==<br />
<br />
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.<br />
<br />
=== Ubuntu 8.04 / 8.10 ===<br />
<br />
For Ubuntu users on older distributions (7.10, 8.04, etc.) '''you need''' to upgrade your mono to 1.9.1.<br />
<br />
You can use the built in packages for mono. However, for better performance, you may want to [http://xyzzyxyzzy.net/2008/05/08/updated-mono-build-script-for-hardy-heron-and-mono-191/ upgrade mono to 1.9.1] ([http://tempvariable.blogspot.com/2008/04/installing-mono-191-on-ubuntu-804-hardy.html Other simple method])<br />
<br />
sudo apt-get install subversion nant mono-gmcs libmono-microsoft8.0-cil \<br />
libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil ruby<br />
svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
cd opensim<br />
./runprebuild.sh<br />
nant<br />
<br />
To upgrade the Mono version to the latest stable build Mono 2.0.1, read this page [[Build Instructions/Ubuntu-Mono-2.0.1 | Ubuntu on Mono 2.0.1]]<br />
<br />
=== openSUSE 10.3 and 11 ===<br />
<br />
Install an openSUSE 11 or 10.3 with its default options, add the online repositories<br />
when finished installing do an online update with all the latest packages.<br />
<br />
In yast install these packages, for running Opensim in standalone mode.<br />
(there is a slight diffrence between 10.3 and 11 but following should be same)<br />
subversion<br />
nant<br />
mono-jscript<br />
- check that mono-core is installed<br />
<br />
If you just want to use SQLite then jump to last section <br />
within this post.<br />
<br />
* Optional mysql - for Opensim running in Grid mode:<br />
Install these mysql packages via yast<br />
mysql<br />
mysql-client<br />
mysql-administrator<br />
mysql-gui-tools<br />
mysql-query-browser<br />
<br />
Before building create the mysql database.<br />
/etc/init.d/mysql start<br />
mysql -u root -p -h localhost<br />
(when asked for password just hit enter)<br />
<br />
mysql> create database opensim;<br />
mysql> quit<br />
<br />
set the configuration in bin/mysql_connection.ini<br />
Or on later builds set the connection string inside bin/OpenSim.ini<br />
<br />
Build after installation of above in bash terminal. i save it in /opt<br />
<br />
su -<br />
cd /opt<br />
svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
cd opensim<br />
./runprebuild.sh<br />
nant<br />
<br />
After this you should be able to continue on starting the diffrent Servers, look in the mysql-config section,or<br />
just run your OpenSim as a Standalone. By - eagleFX<br />
<br />
=== Mac OS X 10.5/10.4 ===<br />
* 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))<br />
* 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.<br />
* Install X11 for 10.4 from the Optional Install from the DVD/CD Installation Disk. X11 for 10.5 is installed by default.<br />
* 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:<br />
export PKG_CONFIG_PATH="/Library/Frameworks/Mono.framework/Versions/Current/lib/pkgconfig/:${PKG_CONFIG_PATH}"<br />
* Compile OpenSim<br />
svn co http://opensimulator.org/svn/opensim/tags/0.5.0-release opensim<br />
cd opensim <br />
./runprebuild.sh<br />
nant<br />
<br />
* Download and Compile libopenjpeg-libsl-2.1.2.0.dylib and libsecondlife.dll<br />
* libopenjpeg-libsl-2.1.2.0.dylib:<br />
svn co http://opensimulator.org/svn/opensim-libs/old/libsl1550 opensim-libs<br />
cd opensim-libs/openjpeg-libsl<br />
make -f Makefile.osx<br />
cp libopenjpeg-libsl-2.1.2.0.dylib ../../bin<br />
* 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))<br />
<br />
* 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])<br />
cd .. (back into opensim-libs)<br />
nant<br />
cp bin/libsecondlife.dll ../bin<br />
<br />
* Edit the libsecondlife.dll.config (PowerPC Only). Remove the cpu="x86" tag in the last dllmap line.<br />
<br />
=== FreeBSD 6.2 ===<br />
su<br />
cd /usr/ports/devel/subversion/ && make install clean (you may also need to rebuild apr-svn if this step fails)<br />
cd /usr/ports/lang/mono/ && make install clean<br />
cd /usr/ports/devel/nant/ && make install clean<br />
cd /usr/ports/databases/sqlite3/ && make install clean<br />
cd /usr/ports/x11-toolkits/libgdiplus/ && make install clean<br />
cd /opensim/installation/directory/<br />
svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
cd opensim<br />
./runprebuild.sh<br />
nant<br />
<br />
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]<br />
"System.DllNotFoundException: ./libopenjpeg-libsl-2.1.2.0.so" issue, but use "gmake" instead of "make"<br />
<br />
For ODE Physics you must do the following:<br />
cd /usr/ports/graphics/libGL/ && make install clean<br />
cd /usr/ports/graphics/libGLU/ && make install clean<br />
cd /opensim/installation/directory/<br />
svn co http://opensimulator.org/svn/opensim-libs/trunk opensim-libs<br />
cd opensim-libs/unmanaged/OpenDynamicsEngine2/<br />
sh autogen.sh<br />
./configure --enable-shared --enable-release --disable-demos<br />
make<br />
mv ./ode/src/.libs/libode.so /opensim/installation/directory/opensim/bin/<br />
<br />
=== RedHat Enterprise Linux 4 ===<br />
sudo vi /etc/yum.repos.d/mono.repo<br />
<br />
[mono]<br />
name=Mono for rhel-4-i386 (stable)<br />
baseurl=http://ftp.novell.com/pub/mono/download-stable/rhel-4-i386/<br />
enabled=1<br />
gpgcheck=0<br />
<br />
sudo yum install mono-complete monodoc-core nant<br />
svn co svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
cd opensim<br />
./runprebuild.sh<br />
nant<br />
<br />
=== RedHat Enterprise Linux 5 ===<br />
<br />
The instructions below also work on other RedHat Linux flavors such as CentOS or maybe Fedora.<br />
<br />
1. Put the [http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo Mono.repo] file in the /etc/yum.repo.d/ directory:<br />
$ sudo su -<br />
$ cd /etc/yum.repos.d/<br />
$ wget http://download.opensuse.org/repositories/Mono/RHEL_5/Mono.repo<br />
Naturally use the most [http://download.opensuse.org/repositories/Mono up-to-date link for your distribution].<br />
<br />
2. Install Mono and related tools with yum:<br />
$ yum install mono nant mono-jscript mono-nunit<br />
Make sure to use nunit-console2 to run your tests.<br />
<br />
=== Fedora 5 ===<br />
* 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.<br />
<br />
For detailed instructions go [http://ruakuu.blogspot.com/2008/06/installing-and-configuring-opensim-on.html here]<br />
<br />
=== Debian 4 ===<br />
<br />
For detailed instructions please see [[Debian 4 Build Instructions]]<br />
<br />
=== CentOS 5.2 32bit ===<br />
<br />
For detailed instructions please see [[CentOS 5.2 Build Instructions]]<br />
<br />
=== 64bit ===<br />
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]]<br />
<br />
<br />
=== Physics (Open Dynamics Engine ODE) ===<br />
As installed from svn, ODE will work on most 32 bit platforms. If you get an ODE-related crash, and/or a <i>libode.so not found</i> type of error, you will need to build libode from source.<br />
<br />
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:<br />
<br />
svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine<br />
<br />
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:<br />
<br />
--with-trimesh=gimpact <br />
--enable-shared<br />
<br />
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>)<br />
<br />
'''''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]''<br />
<br />
Setting up ODE for 64 Bits systems:<br />
<br />
========================================================================<br />
HOWTO on setting up and Install OpenSim on SLES10 - SP1 64Bit<br />
<br />
1. I installed Mono 2.01, added this installation source in Yast2<br />
This distro supports installing packages via YaST. Add the following installation source to YaST:<br />
* http://ftp.novell.com/pub/mono/download-stable/SLE_10 [^]<br />
For assistance with using repositories and installing packages with YaST, visit the Yast help page.<br />
<br />
"nant" was installed also via this operation.<br />
<br />
2. I installed subversion from http://software.opensuse.org/search [^]<br />
<br />
SLES/SLED10 -><br />
subversion-1.5.2-34.2.x86_64.rpm<br />
<br />
3. I downloaded and installed the lastest SVN version of opensim as usual (like a 32 bit system):<br />
http://opensimulator.org/wiki/Build_Instructions [^]<br />
<br />
4. I downloaded and installed the Open Dynamics Engine (ODE) to replace the 32 bit version of ODE with a 64 bit version.<br />
<br />
I did that with the following linux commands:<br />
(it is expected that you have all required Linux building tools installed):<br />
<br />
# cd<br />
# svn co http://opensimulator.org/svn/opensim-libs/trunk/unmanaged/OpenDynamicsEngine [^]<br />
# cd OpenDynamicEngine<br />
# chmod a+x ou/bootstrap<br />
# sh autogen.sh<br />
<br />
I installed/updated SLES10 with these rpm's for autogen.sh to run properly. http://software.opensuse.org/search [^]<br />
<br />
SLES/SLED10 -><br />
- autoconf-2.61-168.1.x86_64.rpm<br />
- automake-1.10.1-5.3.x86_64.rpm<br />
<br />
# CFLAGS="-m64" ./configure --enable-shared<br />
# make<br />
<br />
I installed gtk2-devel via yast2, and all its dependancies, because make keept failing.<br />
<br />
# cp ./ode/src/.libs/libode.so /opt/opensim/bin/<br />
<br />
note:<br />
in this directory it had made several versions of the "libode.so" because of running the previous commands several times<br />
so i had to copy libode.so.1.0.0 to /opt/opensim/bin/libode.so<br />
<br />
# vi ../opensim/bin/OpenSim.ini (change av_capsule_standup_tensor_linux to 1700000)<br />
<br />
<br />
The 'chmod' command is required to fix permissions that are wrong.<br />
The change in OpenSim.ini is required to avoid that avatars have bend legs and/or their feet are in the ground.<br />
========================================================================<br />
<br />
===Running===<br />
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.<br />
<code><br />
cd bin<br />
mono OpenSim.exe<br />
</code><br />
<br />
Note: if you are running a 32bit Server such as Ubuntu 8.0.4 you need the alternative launcher:<br />
<br />
<code><br />
mono OpenSim.32BitLaunch.exe<br />
</code><br />
<br />
<br />
<br />
* To invoke ODE, add the option:<br />
-physics=OpenDynamicsEngine<br />
to the <tt>mono OpenSim.exe</tt> line<br />
<br />
or add <code> physics = OpenDynamicsEngine </code> to the [Startup] section of <tt>OpenSim.ini</tt>. Same deal for other physics engines, when available.<br />
<br />
On mono 1.2.6, some distributions may see<br />
Unhandled Exception: System.NotSupportedException: CodePage 1252 not supported<br />
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).<br />
<br />
=== Additional Items ===<br />
<br />
* [[GC_NO_EXPLICIT|GC NO EXPLICIT]] - Enable Large Heap in Mono, this has been known to help performance and stability<br />
<br />
== Hardware selection guide ==<br />
<br />
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]]. <br />
<br />
[[Category:Users]]<br />
[[Category:Getting Started]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Build_Instructions/Ubuntu-Mono-2.0.1Build Instructions/Ubuntu-Mono-2.0.12009-01-22T04:14:32Z<p>Rtkwebman: </p>
<hr />
<div>First grab the normal stuff for the Mono <br />
<br />
sudo apt-get install subversion nant libmono-microsoft8.0-cil libmono-system-runtime2.0-cil libgdiplus libmono-i18n2.0-cil libmono-oracle2.0-cil ruby<br />
<br />
Then go to this website and read the compiling steps:<br />
<br />
http://devarthur.blogspot.com/2008/10/compiling-mono-201-on-ubuntu-gutsy.html<br />
<br />
PS: Be sure to use the ROOT user to compile, else it will fail<br />
[[Category:Getting Started]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Category:HardwareCategory:Hardware2009-01-22T04:10:46Z<p>Rtkwebman: New page: Catch-all for hardware information</p>
<hr />
<div>Catch-all for hardware information</div>Rtkwebmanhttp://opensimulator.org/wiki/Category:StandardsCategory:Standards2009-01-21T01:53:48Z<p>Rtkwebman: New page: == Uniform criteria, methods, processes and practices in OpenSim ==</p>
<hr />
<div><br />
== Uniform criteria, methods, processes and practices in OpenSim ==</div>Rtkwebmanhttp://opensimulator.org/wiki/Universal_Time_in_OpenSimUniversal Time in OpenSim2009-01-21T01:51:34Z<p>Rtkwebman: </p>
<hr />
<div>== OpenSim Standard Time ==<br />
<br />
<br />
OpenSim is based on [[UTC]] (Coordinated Universal Time) and not SLT (Second Life Time) which is based on PST (Pacific Standard Time). Due to the very nature of OpenSim being a metaverse, UTC was a natural choice due to its use throughout the Earth as the standard starting point for all timezones. Going forward it will be much easier to plan events and use standard toolsets in OpenSim and any metaverses based on it.<br />
[[Category:History]]<br />
[[Category:Standards]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Category:HistoryCategory:History2009-01-21T01:50:07Z<p>Rtkwebman: New page: == Historical and background information about OpenSim ==</p>
<hr />
<div><br />
== Historical and background information about OpenSim ==</div>Rtkwebmanhttp://opensimulator.org/wiki/Universal_Time_in_OpenSimUniversal Time in OpenSim2009-01-21T01:48:59Z<p>Rtkwebman: </p>
<hr />
<div>== OpenSim Standard Time ==<br />
<br />
<br />
OpenSim is based on [[UTC]] (Coordinated Universal Time) and not SLT (Second Life Time) which is based on PST (Pacific Standard Time). Due to the very nature of OpenSim being a metaverse, UTC was a natural choice due to its use throughout the Earth as the standard starting point for all timezones. Going forward it will be much easier to plan events and use standard toolsets in OpenSim and any metaverses based on it.<br />
[[Category:History]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Universal_Time_in_OpenSimUniversal Time in OpenSim2009-01-21T01:46:58Z<p>Rtkwebman: New page: == OpenSim Standard Time == OpenSim is based on UTC (Coordinated Universal Time) and not SLT (Second Life Time) which is based on PST (Pacific Standard Time). Due to the very nature...</p>
<hr />
<div><br />
== OpenSim Standard Time ==<br />
<br />
<br />
OpenSim is based on [[UTC]] (Coordinated Universal Time) and not SLT (Second Life Time) which is based on PST (Pacific Standard Time). Due to the very nature of OpenSim being a metaverse, UTC was a natural choice due to its use throughout the Earth as the standard starting point for all timezones. Going forward it will be much easier to plan events and use standard toolsets in OpenSim and any metaverses based on it.</div>Rtkwebmanhttp://opensimulator.org/wiki/Category:UpgradingCategory:Upgrading2009-01-19T18:45:07Z<p>Rtkwebman: New page: Tips, Tricks, and Methodologies for Upgrading Your OpenSimulator</p>
<hr />
<div>Tips, Tricks, and Methodologies for Upgrading Your OpenSimulator</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2009-01-19T18:43:45Z<p>Rtkwebman: </p>
<hr />
<div>__NOTOC__<br />
===How to Upgrade Your Ubuntu Standalone OpenSimulator===<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
=== The goals are: ===<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
2. save-oar test<br />
3. change-region test2<br />
4. save-oar test2<br />
5. shutdown<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
2. cp -R opensim opensimbak<br />
3. rm -Rf opensim<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
5. cd opensim<br />
6. ./runprebuild.sh<br />
7. nant<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
2. cp -f *.db OpenSim.ini test test2 ../../opensim/bin<br />
3. cp -Rf Regions ../../opensim/bin<br />
4. cd ../../opensim/bin<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below) reload your oar files:'''<br />
1. change-region test<br />
2. load-oar test<br />
3. change-region test2<br />
4. load-oar test2<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
2. mono OpenSim.exe<br />
<br />
=== Additional Info ===<br />
Check out the page [[Upgrading]] for some great information on additional <br />
server upgrading issues.<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.<br />
<br />
==== To fix the NHibernate errors: ====<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
[[Category:Upgrading]]</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2009-01-11T17:22:56Z<p>Rtkwebman: </p>
<hr />
<div>__NOTOC__<br />
===How to Upgrade Your Ubuntu Standalone OpenSimulator===<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
=== The goals are: ===<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
2. save-oar test<br />
3. change-region test2<br />
4. save-oar test2<br />
5. shutdown<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
2. cp -R opensim opensimbak<br />
3. rm -Rf opensim<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
5. cd opensim<br />
6. ./runprebuild.sh<br />
7. nant<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
2. cp -f *.db OpenSim.ini test test2 ../../opensim/bin<br />
3. cp -Rf Regions ../../opensim/bin<br />
4. cd ../../opensim/bin<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below) reload your oar files:'''<br />
1. change-region test<br />
2. load-oar test<br />
3. change-region test2<br />
4. load-oar test2<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
2. mono OpenSim.exe<br />
<br />
=== Additional Info ===<br />
Check out the page [[Upgrading]] for some great information on additional <br />
server upgrading issues.<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.<br />
<br />
==== To fix the NHibernate errors: ====<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T23:30:09Z<p>Rtkwebman: </p>
<hr />
<div>__NOTOC__<br />
===How to Upgrade Your Ubuntu Standalone OpenSimulator===<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
=== The goals are: ===<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
2. save-oar test<br />
3. change-region test2<br />
4. save-oar test2<br />
5. shutdown<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
2. cp -R opensim opensimbak<br />
3. rm -Rf opensim<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
5. cd opensim<br />
6. ./runprebuild.sh<br />
7. nant<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
3. cp -Rf Regions ../../opensim/bin<br />
4. cd ../../opensim/bin<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below) reload your oar files:'''<br />
1. change-region test<br />
2. load-oar test<br />
3. change-region test2<br />
4. load-oar test2<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
2. mono OpenSim.exe<br />
<br />
=== Additional Info ===<br />
Check out the page [[Upgrading]] for some great information on additional <br />
server upgrading issues.<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.<br />
<br />
==== To fix the NHibernate errors: ====<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T23:29:18Z<p>Rtkwebman: </p>
<hr />
<div>__NOTOC__<br />
===How to Upgrade Your Ubuntu Standalone OpenSimulator===<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
=== The goals are: ===<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
2. save-oar test<br />
3. change-region test2<br />
4. save-oar test2<br />
5. shutdown<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
2. cp -R opensim opensimbak<br />
3. rm -Rf opensim<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
5. cd opensim<br />
6. ./runprebuild.sh<br />
7. nant<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
3. cp -Rf Regions ../../opensim/bin<br />
4. cd ../../opensim/bin<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below)reload your oar files:'''<br />
1. change-region test<br />
2. load-oar test<br />
3. change-region test2<br />
4. load-oar test2<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
2. mono OpenSim.exe<br />
<br />
=== Additional Info ===<br />
Check out the page [[Upgrading]] for some great information on additional <br />
server upgrading issues.<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.<br />
<br />
==== To fix the NHibernate errors: ====<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T19:07:44Z<p>Rtkwebman: </p>
<hr />
<div>__NOTOC__<br />
===How to Upgrade Your Ubuntu Standalone OpenSimulator===<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
=== The goals are: ===<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
2. save-oar test<br />
3. change-region test2<br />
4. save-oar test2<br />
5. shutdown<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
2. cp -R opensim opensimbak<br />
3. rm -Rf opensim<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
5. cd opensim<br />
6. ./runprebuild.sh<br />
7. nant<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
3. cp -Rf Regions ../../opensim/bin<br />
4. cd ../../opensim/bin<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below)reload your oar files:'''<br />
1. change-region test<br />
2. load-oar test<br />
3. change-region test2<br />
4. load-oar test2<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
2. mono OpenSim.exe<br />
<br />
=== Additional Info ===<br />
Check out the page [[Upgrading]] for some great information on additional <br />
server upgrading issues.<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.<br />
<br />
==== To fix the NHibernate errors: ====<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T19:06:00Z<p>Rtkwebman: </p>
<hr />
<div>===How to Upgrade Your Ubuntu Standalone OpenSimulator===<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
=== The goals are: ===<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
2. save-oar test<br />
3. change-region test2<br />
4. save-oar test2<br />
5. shutdown<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
2. cp -R opensim opensimbak<br />
3. rm -Rf opensim<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
5. cd opensim<br />
6. ./runprebuild.sh<br />
7. nant<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
3. cp -Rf Regions ../../opensim/bin<br />
4. cd ../../opensim/bin<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below)reload your oar files:'''<br />
1. change-region test<br />
2. load-oar test<br />
3. change-region test2<br />
4. load-oar test2<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
2. mono OpenSim.exe<br />
<br />
=== Additional Info ===<br />
Check out the page [[Upgrading]] for some great information on additional <br />
server upgrading issues.<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.<br />
<br />
==== To fix the NHibernate errors: ====<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T18:55:59Z<p>Rtkwebman: </p>
<hr />
<div>===How to Upgrade Your Ubuntu Standalone OpenSimulator===<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
=== The goals are: ===<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
2. save-oar test<br />
3. change-region test2<br />
4. save-oar test2<br />
5. shutdown<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
2. cp -R opensim opensimbak<br />
3. rm -Rf opensim<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
5. cd opensim<br />
6. ./runprebuild.sh<br />
7. nant<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
3. cp -Rf Regions ../../opensim/bin<br />
4. cd ../../opensim/bin<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below)reload your oar files:'''<br />
1. change-region test<br />
2. load-oar test<br />
3. change-region test2<br />
4. load-oar test2<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
2. mono OpenSim.exe<br />
<br />
== Additional Info ==<br />
Check out the page [[Upgrading]] for some great information on additional server upgrading issues.<br />
<br />
'''To fix the NHibernate errors:'''<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T18:54:24Z<p>Rtkwebman: </p>
<hr />
<div>===How to Upgrade Your Ubuntu Standalone OpenSimulator===<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
=== The goals are: ===<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
2. save-oar test<br />
3. change-region test2<br />
4. save-oar test2<br />
5. shutdown<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
2. cp -R opensim opensimbak<br />
3. rm -Rf opensim<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
5. cd opensim<br />
6. ./runprebuild.sh<br />
7. nant<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
3. cp -Rf Regions ../../opensim/bin<br />
4. cd ../../opensim/bin<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below), reload your oar files:'''<br />
1. change-region test<br />
2. load-oar test<br />
3. change-region test2<br />
4. load-oar test2<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
2. mono OpenSim.exe<br />
<br />
== Additional Info ==<br />
Check out the page [[Upgrading]] for some great information on additional server upgrading issues.<br />
<br />
'''To fix the NHibernate errors:'''<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
<br />
<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T18:50:44Z<p>Rtkwebman: </p>
<hr />
<div>__NOTOC__<br />
=How to Upgrade Your Ubuntu Standalone OpenSimulator=<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
== The goals are: ==<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
<br />
2. save-oar test<br />
<br />
3. change-region test2<br />
<br />
4. save-oar test2<br />
<br />
5. shutdown<br />
<br />
<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
<br />
2. cp -R opensim opensimbak<br />
<br />
3. rm -Rf opensim<br />
<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
<br />
5. cd opensim<br />
<br />
6. ./runprebuild.sh<br />
<br />
7. nant<br />
<br />
<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
<br />
3. cp -Rf Regions ../../opensim/bin<br />
<br />
4. cd ../../opensim/bin<br />
<br />
<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below), reload your oar files:'''<br />
1. change-region test<br />
<br />
2. load-oar test<br />
<br />
3. change-region test2<br />
<br />
4. load-oar test2<br />
<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
<br />
2. mono OpenSim.exe<br />
<br />
<br />
<br />
== Additional Info ==<br />
Check out the page [[Upgrading]] for some great information on additional server upgrading issues.<br />
<br />
'''To fix the NHibernate errors:'''<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
<br />
<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T18:50:00Z<p>Rtkwebman: </p>
<hr />
<div>_NOTOC_<br />
=How to Upgrade Your Ubuntu Standalone OpenSimulator=<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
== The goals are: ==<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
<br />
2. save-oar test<br />
<br />
3. change-region test2<br />
<br />
4. save-oar test2<br />
<br />
5. shutdown<br />
<br />
<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
<br />
2. cp -R opensim opensimbak<br />
<br />
3. rm -Rf opensim<br />
<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
<br />
5. cd opensim<br />
<br />
6. ./runprebuild.sh<br />
<br />
7. nant<br />
<br />
<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
<br />
3. cp -Rf Regions ../../opensim/bin<br />
<br />
4. cd ../../opensim/bin<br />
<br />
<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below), reload your oar files:'''<br />
1. change-region test<br />
<br />
2. load-oar test<br />
<br />
3. change-region test2<br />
<br />
4. load-oar test2<br />
<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
<br />
2. mono OpenSim.exe<br />
<br />
<br />
<br />
== Additional Info ==<br />
Check out the page [[Upgrading]] for some great information on additional server upgrading issues.<br />
<br />
'''To fix the NHibernate errors:'''<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
<br />
<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T18:49:22Z<p>Rtkwebman: </p>
<hr />
<div>_TOC_<br />
=How to Upgrade Your Ubuntu Standalone OpenSimulator=<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
== The goals are: ==<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
<br />
2. save-oar test<br />
<br />
3. change-region test2<br />
<br />
4. save-oar test2<br />
<br />
5. shutdown<br />
<br />
<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
<br />
2. cp -R opensim opensimbak<br />
<br />
3. rm -Rf opensim<br />
<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
<br />
5. cd opensim<br />
<br />
6. ./runprebuild.sh<br />
<br />
7. nant<br />
<br />
<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
<br />
3. cp -Rf Regions ../../opensim/bin<br />
<br />
4. cd ../../opensim/bin<br />
<br />
<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below), reload your oar files:'''<br />
1. change-region test<br />
<br />
2. load-oar test<br />
<br />
3. change-region test2<br />
<br />
4. load-oar test2<br />
<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
<br />
2. mono OpenSim.exe<br />
<br />
<br />
<br />
== Additional Info ==<br />
Check out the page [[Upgrading]] for some great information on additional server upgrading issues.<br />
<br />
'''To fix the NHibernate errors:'''<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
<br />
<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T18:45:51Z<p>Rtkwebman: </p>
<hr />
<div>=How to Upgrade Your Ubuntu Standalone OpenSimulator=<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
== The goals are: ==<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
'''Run OpenSim'''<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
'''Save your Region information and shutdown the Simulator'''<br />
1. change-region test<br />
<br />
2. save-oar test<br />
<br />
3. change-region test2<br />
<br />
4. save-oar test2<br />
<br />
5. shutdown<br />
<br />
<br />
<br />
'''Backup your current install, delete it, then install the latest version'''<br />
1. cd ../..<br />
<br />
2. cp -R opensim opensimbak<br />
<br />
3. rm -Rf opensim<br />
<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
<br />
5. cd opensim<br />
<br />
6. ./runprebuild.sh<br />
<br />
7. nant<br />
<br />
<br />
<br />
'''Start moving your old information to the new install'''<br />
1. cd ../opensimbak/bin<br />
<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
<br />
3. cp -Rf Regions ../../opensim/bin<br />
<br />
4. cd ../../opensim/bin<br />
<br />
<br />
<br />
'''Run the new install'''<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
'''When the server finishes booting (if you get NHibernate errors see Additional Info below), reload your oar files:'''<br />
1. change-region test<br />
<br />
2. load-oar test<br />
<br />
3. change-region test2<br />
<br />
4. load-oar test2<br />
<br />
<br />
'''Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay.'''<br />
1. shutdown<br />
<br />
2. mono OpenSim.exe<br />
<br />
<br />
<br />
== Additional Info ==<br />
Check out the page [[Upgrading]] for some great information on additional server upgrading issues.<br />
<br />
'''To fix the NHibernate errors:'''<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
<br />
<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T18:40:21Z<p>Rtkwebman: /* Additional Info */</p>
<hr />
<div>=How to Upgrade Your Ubuntu Standalone OpenSimulator=<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
== The goals are: ==<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
== Run OpenSim ==<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
== Save your Region information and shutdown the Simulator ==<br />
1. change-region test<br />
<br />
2. save-oar test<br />
<br />
3. change-region test2<br />
<br />
4. save-oar test2<br />
<br />
5. shutdown<br />
<br />
<br />
<br />
== Backup your current install, delete it, then install the latest version ==<br />
1. cd ../..<br />
<br />
2. cp -R opensim opensimbak<br />
<br />
3. rm -Rf opensim<br />
<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
<br />
5. cd opensim<br />
<br />
6. ./runprebuild.sh<br />
<br />
7. nant<br />
<br />
<br />
<br />
== Start moving your old information to the new install ==<br />
1. cd ../opensimbak/bin<br />
<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
<br />
3. cp -Rf Regions ../../opensim/bin<br />
<br />
4. cd ../../opensim/bin<br />
<br />
<br />
<br />
== Run the new install ==<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
== When the server finishes booting (if you get NHibernate errors see Additional Info below), reload your oar files: ==<br />
1. change-region test<br />
<br />
2. load-oar test<br />
<br />
3. change-region test2<br />
<br />
4. load-oar test2<br />
<br />
<br />
== Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay. ==<br />
1. shutdown<br />
<br />
2. mono OpenSim.exe<br />
<br />
<br />
<br />
== Additional Info ==<br />
Check out the page [[Upgrading]] for some great information on additional server upgrading issues.<br />
<br />
'''To fix the NHibernate errors:'''<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
<br />
<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.</div>Rtkwebmanhttp://opensimulator.org/wiki/Upgrade_Ubuntu_StandaloneUpgrade Ubuntu Standalone2008-12-07T18:37:32Z<p>Rtkwebman: /* Additional Info */</p>
<hr />
<div>=How to Upgrade Your Ubuntu Standalone OpenSimulator=<br />
<br />
The following instructions assume you have a currently running two region (island) OpenSimulator on '''Ubuntu 8.10''' in '''Standalone''' mode using '''SQLite''' for the database. We will also assume the two regions are named ''test'' and ''test2''.<br />
<br />
<br />
== The goals are: ==<br />
<br />
1. Backup your current install and preserve all your Inventory/Assets, Terrain info, Region info, and OpenSim.ini file.<br />
<br />
2. Update your current version to the latest trunk.<br />
<br />
3. Reload it all and run your brand new upgraded OpenSimulator.<br />
<br />
<br />
<br />
== Run OpenSim ==<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
== Save your Region information and shutdown the Simulator ==<br />
1. change-region test<br />
<br />
2. save-oar test<br />
<br />
3. change-region test2<br />
<br />
4. save-oar test2<br />
<br />
5. shutdown<br />
<br />
<br />
<br />
== Backup your current install, delete it, then install the latest version ==<br />
1. cd ../..<br />
<br />
2. cp -R opensim opensimbak<br />
<br />
3. rm -Rf opensim<br />
<br />
4. svn co http://opensimulator.org/svn/opensim/trunk opensim<br />
<br />
5. cd opensim<br />
<br />
6. ./runprebuild.sh<br />
<br />
7. nant<br />
<br />
<br />
<br />
== Start moving your old information to the new install ==<br />
1. cd ../opensimbak/bin<br />
<br />
2. cp -f *.db Opensim.ini test test2 ../../opensim/bin<br />
<br />
3. cp -Rf Regions ../../opensim/bin<br />
<br />
4. cd ../../opensim/bin<br />
<br />
<br />
<br />
== Run the new install ==<br />
1. mono OpenSim.exe<br />
<br />
<br />
<br />
== When the server finishes booting (if you get NHibernate errors see Additional Info below), reload your oar files: ==<br />
1. change-region test<br />
<br />
2. load-oar test<br />
<br />
3. change-region test2<br />
<br />
4. load-oar test2<br />
<br />
<br />
== Now that your OpenSimulator is running, shut it down then restart it just to make sure everything is okay. ==<br />
1. shutdown<br />
<br />
2. mono OpenSim.exe<br />
<br />
<br />
<br />
== Additional Info ==<br />
Check out the page [[Upgrading]] for some great information.<br />
<br />
To fix the NHibernate errors:<br />
<br />
1. Download the file http://prdownloads.sourceforge.net/castleproject/Castle-net-2.0-release-2007-9-20.zip?download<br />
<br />
2. Copy the Castle.DynamicProxy2.dll Castle.DynamicProxy2.xml Castle.Core.dll Castle.Core.xml files from the bin folder into the opensim/bin directory.<br />
<br />
3. Run the OpenSimulator and the errors should be fixed.<br />
<br />
<br />
If you have any additional files like r32 terrain files you might want to preserve them too. A good practice would be to store them somewhere other than the opensim directory so you do not risk losing them.</div>Rtkwebman