Installing and Running Hypergrid
From OpenSimulator
| Line 9: | Line 9: | ||
#* 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. | #* 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. | ||
# 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. | # 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 /><br /> | ||
| + | ''The Following command line switch for mono has been deprecated and should probably be removed from this page in the near future. - Hiro P./daTwitch''<br /> | ||
'''[mono] OpenSim.exe -hypergrid=true''' | '''[mono] OpenSim.exe -hypergrid=true''' | ||
| − | + | <br/ ><br /> | |
Here is an example of the Network settings for a standalone: | Here is an example of the Network settings for a standalone: | ||
Revision as of 21:32, 23 August 2009
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 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 "http://<external_host_name>:<http_port>". See below.
- Run opensim like this: [mono] OpenSim.exe -hypergrid=true. 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.
The Following command line switch for mono has been deprecated and should probably be removed from this page in the near future. - Hiro P./daTwitch
[mono] OpenSim.exe -hypergrid=true
Here is an example of the Network settings for a standalone:
[Network] http_listener_port = 9300 remoting_listener_port = 9895 (legacy - not used any more) grid_server_url = http://example.com:9300 grid_send_key = null grid_recv_key = null user_server_url = http://example.com:9300 user_send_key = null user_recv_key = null asset_server_url = http://example.com:9300 inventory_server_url = http://example.com:9300 messaging_server_url = http://example.com:9300
Here is an example of the Network settings for a grided opensim:
[Network] http_listener_port = 9300 remoting_listener_port = 9895 (legacy - not used any more) grid_server_url = http://example.com:8001 grid_send_key = null grid_recv_key = null user_server_url = http://example.com:8002 user_send_key = null user_recv_key = null asset_server_url = http://example.com:8003 inventory_server_url = http://example.com:8004 ; Port 8005 reserved messaging_server_url = http://example.com:8006
It is also recommended to have both of:
WorldMapModule = "WorldMap" WorldMapModule = "HGWorldMapModule"
in your OpenSim.ini . HGWorldMapModule will, after teleporting to another grid, clean up tiles in your map left over from the grid on which you were previously.
Important Note
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.
Linking regions
Method 1
On the console, type for example:
link-region <Xloc> <Yloc> osl2.nac.uci.edu:9006
- Use Xloc and Yloc that make sense to your world, i.e. close to your regions, but not adjacent.
- 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
You can link to a specific region within an instance, by using the name of the region at the end, for example:
link-region 997 997 osl2.nac.uci.edu:9006:UCI Welcome
Method 2
There is also some initial support for reading the links from a xml file.
Use the console command: link-region <URI> [<excludeList>]
The uri can be either the path of a local xml file or a xml document on a http server.
The format of the xml file is:
<Nini> <Section Name="Region1"> <Key Name="xloc" Value="1002"/> <Key Name="yloc" Value="1006" /> <Key Name="externalPort" Value="9006" /> <Key Name="externalHostName" Value="osl2.nac.uci.edu" /> <Key Name="localName" Value="OSGrid-Gateway" /> <Key Name="real-xloc" Value="10222"/> //optional field that gives the region's real location on its home grid <Key Name="real-yloc" Value="10265" /> //optional field that gives the region's real location on its home grid </Section> <Section Name="Region2"> ... </Section> ... </Nini>
[Note] The section names can be anything you want, but they all should be different and have no spaces in the name.
ExcludeList:
The exclude list is a single string paramater with the format: excludeList:<SectionName>[;<SectionName>]
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.
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).
So for example, someone might create a editable online list for the up coming OpenSimulator's 2nd birthday. Which might look something like:
<Nini> <Section Name="OSGrid-Party"> <Key Name="xloc" Value="1002"/> <Key Name="yloc" Value="1006" /> <Key Name="externalPort" Value="9006" /> <Key Name="externalHostName" Value="osl2.nac.uci.edu" /> <Key Name="localName" Value="OSGrid-Gateway" /> </Section> <Section Name="UCIGrid-Party"> ... </Section> </Nini>
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"
This is so that my region doesn't try to create a hyper link to itself.
Method 3 (dynamic)
Starting in r8193, if you're in an HG-enabled region, you'll be able to dynamically link sims, and TP there, in any one of these ways (and probably more). All you need to know is the target address, e.g. from the list below.
1) Type for example secondlife://ucigrid04.nacs.uci.edu:9007/ in the chat box, pull up the chat history and click on that link
2) Pull up the map and search for things like ucigrid04.nacs.uci.edu:9007
3) Using the embedded browser visit pages that have links like secondlife://ucigrid04.nacs.uci.edu:9007/ (there's one up at http://www.ics.uci.edu/~lopes/hypergrid/test.html)
Again, you can link to a specific region within an instance by adding the name of that region at the end, like this: secondlife://ucigrid04.nacs.uci.edu:9007:Gateway 7000/
Important Note
Due to a viewer 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.
Unlinking regions
On the console, type for example:
unlink-region osl2.nac.uci.edu:9006
or
unlink-region <local region name>
