OpenSimulator - User contributions [en]

Server Commands

2012-06-15T06:35:42Z

Planetoid: /* Region Console Commands */ add show region [region name]

__NOTOC__
{{Quicklinks}}

= What are server commands? =

Server commands are those you can type on the console to make the server do various things.

Commands can be divided up into those that apply to the simulator (simulator commands) and those that apply to grid services (service commands).

On a standalone system, both simulator and service commands will be available on the single standalone system console.

On a grid architecture, the simulator commands will be available on the simulators, whilst the service commands will be available on the ROBUST console.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== Region Console Commands ==

=== General ===

* backup - trigger a simulator backup (Persist objects to the database now). The simulator does this automatically at regular intervals and on shutdown.
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* command-script [name of scriptfile] - Runs a command script containing server commands
* create region [name] [filename] - Create a new region
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* debug scene - Turn on scene debugging
* delete-region <name> - Delete a region from disk
* edit scale [primitivename] [xvalue] [yvalue] [zvalue] - changes size of the named prim
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* force update - triggers a resend of all prims in a region
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* kill uuid <UUID> - Kill an object by UUID (helpful with red lines in the console)
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* quit - equivalent to shutdown.
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* reload estate - reload estate data
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information.
* set region flags <Region name> <flags> - Set database flags for region
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show info - show server information (version and startup path)
* show modules - show module data
* show neighbours - Shows the local regions' neighbours
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show ratings - Show rating data
* show region [region name] - Show region data (Region Name, Region UUID, Location, URI, Owner ID, Flags)
* show regions - Show regions data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)
* show stats - show usefull statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show uptime - show server startup time and uptime.
* show version - show server version.
* shutdown - disconnects all clients and shutdown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Commands ===

* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Asset Commands ===

The fcache commands only currently appearance if you are using the fcache asset cache. This is the default on OpenSimulator.

* fcache assets - Attempt a deep scan and cache of all assets in all scenes
* fcache clear [file] [memory] - Remove all assets in the cache. If file or memory is specified then only this cache is cleared.
* fcache expire <datetime> - Purge cached assets older then the specified date/time
* fcache status - Display cache status
* j2k decode <ID> - Do JPEG2000 decoding of an asset.

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Commands ===

* land show - Shows all parcels on the current region.

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Terrain Commands ===

Note that some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file.
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions revert map.
* terrain revert - Loads the revert map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect

=== Tree Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== User Commands ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* bypass permissions <true / false> - Bypass in-world permission checks
* debug permissions - Turn on permissions debugging
* force permissions - Force permissions on or off.
* kick user <first> <last> [message]: - Kick a user off the simulator
* login disable - Disable user entry to this simulator
* login enable - Enable user entry to this simulator
* login status - Show whether logins to this simulator are enabled or disabled
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* teleport user <destination> - Teleport a user on this simulator to a specific destination. Currently only in OpenSimulator development code after the 0.7.3.1 release (commit bf0b817).

=== Windlight/[[LightShare]] Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Enable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===

* delete asset - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. OpenSimulator 0.7.3 onwards.
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"
* reset user password - reset a user's password.
* login-level <value> - Set the miminim userlevel allowed to login.
* login-reset - reset the login level to its default value.
* login-text <text to print during the login>
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account (0.7.2-dev)

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* 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 port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

'''Important Note'''

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.

link-mapping
== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - sim FPS
* PhyFPS - physics FPS
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

Server Commands

2012-03-21T09:30:18Z

Planetoid: /* User Service */

__NOTOC__
{{Quicklinks}}

= What are server commands? =

You can type server commands on the region server or ROBUST service console to do various things.

'''Disclaimer''': some commands may not work as expected, some may not work at all, and there is a chance that you may even lose all your settings/contents. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

Except where noted, this list should be accurate for OpenSimulator 0.7.1 onwards.

= Commands =

== Region Console Commands ==

=== General ===

* alert <message> - send an in-world alert to everyone
* alert-user <first> <last> <message> - send an an in-world alert to a specific user
* backup - trigger a simulator backup (Persist objects to the database now). The simulator does this automatically at regular intervals and on shutdown.
* bypass permissions <true / false> - Bypass in-world permission checks
* change region <region name> - subsequent commands apply only to the specified region. If region name is "root" then all regions are selected
* clear-assets - forcibly clears asset cache, probably leaving sim unstable. Use with caution.
* command-script [name of scriptfile] - Runs a command script containing server commands
* create region [name] [filename] - Create a new region
* debug packet <level> - Turn on packet debugging, where OpenSimulator prints out summaries of incoming and outgoing packets for viewers, depending on the level set
* debug permissions - Turn on permissions debugging
* debug scene - Turn on scene debugging
* delete-region <name> - Delete a region from disk
* edit scale [primitivename] [xvalue] [yvalue] [zvalue] - changes size of the named prim
* emergency-monitoring - turn emergency debugging monitoring mode on or off.
* export-map [<path>] - Save an image of the world map (default name is exportmap.jpg)
* force permissions - Force permissions on or off.
* force update - triggers a resend of all prims in a region
* help [<command>] - Get general command list or more detailed help on a specific command or set of commands
* kick user <first> <last> [message]: - Kick a user off the simulator
* kill uuid <UUID> - Kill an object by UUID (helpful with red lines in the console)
* link-mapping - Set a local grid co-ordinate to link to a remote hypergrid
* link-region - Link a HyperGrid region. Not sure how this differs from link-mapping
* modules list - List modules
* modules load <name> - Load a module
* modules unload <name> - Unload a module
* monitor report - Returns a variety of statistics about the current region and/or simulator
* quit - equivalent to shutdown.
* region restart abort [<message>] - Abort a scheduled region restart, with an optional message
* region restart bluebox <message> <delta seconds>+ - Schedule a region restart. If one delta is given then the region is restarted in delta seconds time. A time to restart is sent to users in the region as a dismissable bluebox notice. If multiple deltas are given then a notice is sent when we reach each delta.
* region restart notice <message> <delta seconds>+ - Schedule a region restart. Same as above except showing a transient notice instead of a dismissable bluebox.
* reload estate - reload estate data
* remove-region - remove a region from the simulator
* restart - Restarts all sims in this instance
* set log level [level] - change the console logging level only. For example, off or debug. See [[Logging]] for more information.
* set region flags <Region name> <flags> - Set database flags for region
* set terrain heights <corner> <min> <max> [<x>] [<y>] - Sets the terrain texture heights on corner #<corner> to <min>/<max>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate. Corner # SW = 0, NW = 1, SE = 2, NE = 3.
* set terrain texture <number> <uuid> [<x>] [<y>] - Sets the terrain <number> to <uuid>, if <x> or <y> are specified, it will only set it on regions with a matching coordinate. Specify -1 in <x> or <y> to wildcard that coordinate.
* show caps - show all registered capabilities URLs
:NOTE: In OpenSimulator 0.7.1, "show capabilities" is shown as a result for help command, but actually only "show caps" will be accepted. ([http://opensimulator.org/mantis/view.php?id=5467 #5467])
* show circuits - Show agent circuit data
* show connections - show connections data
* show http-handlers - show all registered http handlers
* show hyperlinks - list hg regions
* show info - show server information (version and startup path)
* show modules - show module data
* show neighbours - Shows the local regions' neighbours
* show pending-objects - show number of objects in the pending queues of all viewers
* show pqueues [full] - show priority queue data for each client. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show queues - Show queue data for agent connections.
* show ratings - Show rating data
* show regions - Show region data (Region Names, XLocation YLocation coordinates, Region Ports, Estate Names)
* show stats - show usefull statistical information for this server. See [[#Frame Statistics Values|Frame Statistics Values]] below for more information.
* show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
* show throttles [full] - Show throttle data for each client connection, and the maximum allowed for each connection by the server. Without the 'full' option, only root agents are shown. With the 'full' option child agents are also shown.
* show uptime - show server startup time and uptime.
* show users [full]- show info about currently connected users to this region. Without the 'full' option, only users actually on the region are shown. With the 'full' option child agents of users in neighbouring regions are also shown.
* show version - show server version.
* shutdown - disconnects all clients and shutdown.
* unlink-region <local name> - unlink a hypergrid region

=== Appearance Module Commands ===
* appearance show - Show information about avatar appearance. Currently just checks whether the baked texture is "OK" or "corrupt". Still in development. Only exists in development code at the moment.

=== Archive Commands ===

* load iar <first> <last> <inventory path> <password> [<archive path>] - Load user inventory archive. See [[Inventory Archives]].
* load oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* load xml [-newIDs [<x> <y> <z>]] - Load a region's data from XML format (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)
:those xml are the result of the export save or *export save-all
* load xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
* save iar <first> <last> <inventory path> <password> [<archive path>] - Save user inventory archive. See [[Inventory Archives]]
* save oar [filename] - save the current region to an OpenSimulator archive. Default filename is '''region.oar'''. See [[OpenSim Archives]].
* save prims xml2 [<prim name> <file name>] - Save named prim to XML2
* save xml [filename] - save prims to XML
* save xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)

=== Config Commands ===

* config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
* config save <path> - Save the current configuration to a file.
* config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSimulator nor modules dynamically reload config values.
* config show [<section>] [<key>] - Synonym for 'config get'

=== Land Module Commands ===

* land show - Shows all parcels on the current region.

=== Script Commands ===

These currently only exist in git master OpenSimulator development code post the 0.7.2 release.

* scripts resume [<script-item-uuid>] - Resumes all suspended scripts
* scripts show [<script-item-uuid>] - Show script information. <script-item-uuid> option only exists from git master 82f0e19 (2012-01-14) onwards (post OpenSimulator 0.7.2).
* scripts start [<script-item-uuid>] - Starts all stopped scripts
* scripts stop [<script-item-uuid>] - Stops all running scripts
* scripts suspend [<script-item-uuid>] - Suspends all running scripts

=== Terrain Module Commands ===

Note that some of these may require a sim restart to show properly.
* terrain load - Loads a terrain from a specified file.
* terrain load-tile - Loads a terrain from a section of a larger file.
* terrain save - Saves the current heightmap to a specified file.
* terrain fill - Fills the current heightmap with a specified value.
* terrain elevate - Raises the current heightmap by the specified amount.
* terrain lower - Lowers the current heightmap by the specified amount.
* terrain multiply - Multiplies the heightmap by the value specified.
* terrain bake - Saves the current terrain into the regions revert map.
* terrain revert - Loads the revert map terrain into the regions heightmap.
* terrain newbrushes - Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.
* terrain stats - Shows some information about the regions heightmap for debugging purposes.
* terrain effect - Runs a specified plugin effect

=== Tree Module Commands ===

* tree active - Change activity state for the trees module
* tree freeze - Freeze/Unfreeze activity for a defined copse
* tree load - Load a copse definition from an xml file
* tree plant - Start the planting on a copse
* tree rate - Reset the tree update rate (mSec)
* tree reload - Reload copse definitions from the in-scene trees
* tree remove - Remove a copse definition and all its in-scene trees
* tree statistics - Log statistics about the trees

=== Windlight/[[LightShare]] Module Commands ===

* windlight load - Load windlight profile from the database and broadcast
* windlight enable - Enable the windlight plugin
* windlight disable - Enable the windlight plugin

== ROBUST Service Commands ==

These can also be accessed on the simulator command console itself in standalone mode.

=== Asset Service ===
* delete asset - Delete an asset from the database. Doesn't appear to be implemented.
* dump asset <ID> - Dump an asset to the filesystem. (dev code only)
* show digest <ID> - Show summary information about an asset. From OpenSimulator 0.7.3 onwards this will be renamed to "show asset"

=== User Service ===
* create user [first] [last] [passw] [RegionX] [RegionY] [Email] - creates a new user and password
:or just: create user - and server prompts for all data
:
:'''Note for use of create user in standalone mode:''' use the user default coordinates
:of 1000,1000 for Start Region X and Y position otherwise server
:gives error of "[LOGIN]: Not found region"
* reset user password - reset a user's password.
* login-level <value> - Set the miminim userlevel allowed to login.
* login-reset - reset the login level to its default value.
* login-text <text to print during the login>
* show account <firstname> <lastname> - show account details for the given user name (0.7.2-dev)
* set user level <firstname> <lastname> <level> - Set UserLevel for the user, which determines whether a user has a god account (0.7.2-dev)

== Details of Terrain Module Commands ==

==== terrain load ====
Loads a terrain from a specified file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain load-tile ====
Loads a terrain from a section of a larger file.

Parameters
* filename (String)
The file you wish to load from, the file extension determines the loader to be used. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)
* file width (Integer)
The width of the file in tiles
* file height (Integer)
The height of the file in tiles
* minimum X tile (Integer)
The X region coordinate of the first section on the file
* minimum Y tile (Integer)
The Y region coordinate of the first section on the file

==== terrain save ====
Saves the current heightmap to a specified file.

Parameters
* filename (String)
The destination filename for your heightmap, the file extension determines the format to save in. Supported extensions include: .r32 (RAW32) .f32 (RAW32) .ter (Terragen) .raw (LL/SL RAW) .jpg (JPEG) .jpeg (JPEG) .bmp (BMP) .png (PNG) .gif (GIF) .tif (TIFF) .tiff (TIFF)

==== terrain fill ====
Fills the current heightmap with a specified value.

Parameters
* value (Double)
The numeric value of the height you wish to set your region to.

==== terrain elevate ====
Raises the current heightmap by the specified amount.

Parameters
* amount (Double)

==== terrain lower ====
Lowers the current heightmap by the specified amount.

Parameters
* amount (Double)
The amount of height to remove from the terrain in meters.

==== terrain multiply ====
Multiplies the heightmap by the value specified.

Parameters
* value (Double)
The value to multiply the heightmap by.

==== terrain bake ====
Saves the current terrain into the regions revert map.

==== terrain revert ====
Loads the revert map terrain into the regions heightmap.

==== terrain newbrushes ====
Enables experimental brushes which replace the standard terrain brushes. WARNING: This is a debug setting and may be removed at any time.

Parameters
* Enabled? (Boolean)
true / false - Enable new brushes

==== terrain stats ====
Shows some information about the regions heightmap for debugging purposes.

==== terrain effect ====
Runs a specified plugin effect

Parameters
* name (String)
The plugin effect you wish to run, or 'list' to see all plugins

== Details of Hypergrid Commands ==

For full details and explanations of Hypergrid Commands, see the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid#Linking_regions_.28Optional.29 Linking Regions] sections of the [http://opensimulator.org/wiki/Installing_and_Running_Hypergrid Installing and Running Hypergrid] page.

'''show hyperlinks'''

This command will show a list of all hypergrid linked regions.

'''link-region <Xloc> <Yloc> <host> <port> <location-name>'''

* 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 port of the region you want to link to

E.g. link-region 8998 8998 osl2.nac.uci.edu 9006 OSGrid Gateway

'''unlink-region <local region name>'''

This command will unlink the specified hypergrid linked region - be sure to use the exact local name as reported by the "show hyperlinks" command.

'''Important Note'''

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.

link-mapping
== Frame Statistics Values ==

The labels of the Frame Statistics values shown by the console command "show stats" are a bit cryptic. Here is a list of the meanings of these values:

* Dilatn - time dilation
* SimFPS - sim FPS
* PhyFPS - physics FPS
* AgntUp - # of agent updates
* RootAg - # of root agents
* ChldAg - # of child agents
* Prims - # of total prims
* AtvPrm - # of active prims
* AtvScr - # of active scripts
* ScrLPS - # of script lines per second
* PktsIn - # of in packets per second
* PktOut - # of out packets per second
* PendDl - # of pending downloads
* PendUl - # of pending uploads
* UnackB - # of unacknowledged bytes
* TotlFt - total frame time
* NetFt - net frame time
* PhysFt - physics frame time
* OthrFt - other frame time
* AgntFt - agent frame time
* ImgsFt - image frame time

[[Category:Support]]
[[Category:Help]]
[[Category:Configuration]]
[[Category:Getting Started]]
[[Category:Development]]

0.7 Release

2011-04-27T07:36:24Z

Planetoid: /* Major changes from 0.6.x */

= Release Notes =

== Major changes from 0.6.x ==

Release 0.7 features the completed major refactoring and rearchitecting work that happened during the second half of 2009 and the first quarter of 2010. This work targeted mainly the resource services and servers previously known as UGAIM. These servers have been replaced by one single server shell called [[ROBUST]] which can now run any combination of services in it.

The standard opensim release includes configuration files for two deployment architectures:

* The standalone deployment consists in having both the simulator and the services in one single process, OpenSim.exe, configured by OpenSim.ini (and included .inis under bin/config-include).
* The grid deployment has 1 ROBUST server process (Robust.exe) running all services, configured by Robust.ini (or Robust.HG.ini); and one or more simulators (OpenSim.exe), each configured by OpenSim.ini (and included .ini files under bin/config-include).

Users and distributors of OpenSim can deviate from these pre-existing configurations in many ways. Specifically, large grids will benefit from splitting the single ROBUST server into several ROBUST servers, each running a collection of services. Instructions for how to do that are found elsewhere. (Think of the ROBUST server as an Apache server, to which you can load service modules)

The services themselves have been reconceptualized; we now have the following set of main services:

*Assets -- the asset store
*Authentication -- passwords and auth tokens
*Authorization -- access control
*Avatar -- the visual representation of users, formerly known as "avatar appearance"
*FreeSwitch -- voice
*Friends -- social net
*Gatekeeper -- hypergrid foreign users control
*Grid -- maps map locations to IPs and regions
*Grid User -- grid-local information about users
*Inventory -- the inventory store
*Login -- the login service
*Presence -- tracks where in the grid user agents are
*User Accounts -- administrative info about users
*User Agents -- hypergrid local users protection

The simulators access these services through abstract interfaces, therefore being isolated from implementation details. The services are seamlessly instantiated as plugins in any process, namely ROBUST server shells and the simulators processes themselves, which means that we have complete reuse of service code between standalone and grid configurations. The plugin specification is done in configuration files (.ini). Moreover, access to remote services is also seamlessly achieved through the instantiation of stubs (aka service connectors) as plugins; again, the specification of which stubs the simulators use is done externally in configuration files (.ini).

This layering allows for alternative third-party implementations of the entire resource service infrastructure without having to affect one line of code in the simulator, and simply using different ini files. Starting in this release, there is an alternative infrastructure to Robust: [http://code.google.com/p/openmetaverse/ SimianGrid], a project separate from OpenSim. The standard OpenSim release includes simulator's connectors and configuration files for the SimianGrid, but that infrastructure is not distributed with OpenSim, only Robust is.

==Database changes==

[[image:DB-0.7.jpg|400px|right|(click to enlarge)]]

[[image:DB-0.7-old-tables.jpg|400px|right|(click to enlarge)]]

The database schema has changed considerably from previous releases. The top picture on the right shows the entire set of tables for a clean installation of the 0.7 release with MySql. The bottom picture shows the new tables as well as the tables that existed in previous versions of OpenSim and that are now obsolete, stroked in red. OpenSim does not drop the old tables automatically, for obvious reasons. Once you are sure your data migration was successful, you can then drop the obsolete tables manually.

In the picture on top, the tables are grouped into 2 catalogs, the service-db and the simulator-db, corresponding to the data managed by the resource services (the ConnectionString under the [DatabaseService] section) and the data managed by the simulators (the connection_string under [Startup] section), respectively.

As before, you have a lot of freedom to define how the data is organized, so, for example you might have one single catalog with all the tables (like the organization shown in the picture on the bottom). In any case, after a clean installation of release 0.7, there should be all these tables in your DB.

For SQLite, the tables are split among several .db files under the bin directory. Here are the SQLite .db files that a clean install of 0.7 should produce:

$ ls -l *.db
----------+ 1 crista None 6555648 Jun 14 08:15 Asset.db
----------+ 1 crista None 564224 Jun 14 08:15 OpenSim.db
----------+ 1 crista None 5120 Jun 14 08:15 auth.db
----------+ 1 crista None 4096 Jun 14 08:14 avatars.db
----------+ 1 crista None 4096 Jun 14 08:14 friends.db
----------+ 1 crista None 4096 Jun 14 08:14 griduser.db
----------+ 1 crista None 26624 Jun 14 08:15 inventory.db
----------+ 1 crista None 0 Jun 14 08:14 inventoryStore.db
----------+ 1 crista None 4096 Jun 14 08:15 userprofiles.db

With SQLite, the simulator data is in OpenSim.db; the service data is in all the other files. inventoryStore.db has to do with migrations of inventory from older OpenSim releases; on a fresh install, this file is created but is has no data, you can safely delete it afterward.

==Hypergrid changes==

The Hypergrid underwent considerable changes to make it more secure. 0.7 features HG1.5, an interoperability design that is as secure as it can be while continuing to assume the use of the regular Linden viewer. Here are the highlights with respect to security.

'''HG Teleports: The Gateway'''

HG teleports are now done through the Gateway service, as opposed to being done directly between the departing and the receiving simulators. The flow is like this: user U is in sim A of grid G1, and wants to HG TP to sim B of grid G2; sim A posts the user agent to the Gateway service of G2; after verifying a few things, and making sure this is a genuine agent for user U, the Gateway service in G2 logs in the user's presence in the local grid as a valid grid user, and posts the agent to sim B; sim B in G2 then contacts Sim A in G1 telling it it can delete the agent; at that point sim2 logs off user U from G1.

The posting of foreign agents directly to simulators of a grid, without passing through the Gateway, will fail.

In 0.7, the Gateway is still not performing authorization (i.e. access control for foreign users based on grid-specific policies), but that step is now possible, and will be introduced in a future release.

'''User Agents Verification'''

Prior to 0.7, it was possible to impersonate users by launching agents at simulators pretending to be those users. This vulnerability was independent of the Hypergrid being active or not, it affected all publicly available simulators. With 0.7 and beyond, and for grids where all simulators are under the same authority, this vulnerability has been eliminated.

HG1.5 includes pieces of protocol that guarantee that the user agent being launched at the Gatekeeper of a grid is indeed a genuine agent from the claimed user.

'''Inventory Access'''

The important thing to know about the family of viewers deriving from the Linden viewer is that they all access the user's inventory from the simulator that the user is currently on. In other words, they expect the simulators to proxy inventory, instead of accessing inventory directly from the user's inventory service. This poses serious security and privacy issues that can only be minimized but not eliminated. HG1.5 minimizes the risks as much as they can be minimized while allowing users to access their inventory everywhere. This comes at the cost of a slight UI mismatch at points.

First, in HG1.0, the visiting simulator had the power to delete items from the user's inventory and even delete the entire user inventory. That vulnerability has been eliminated. Foreign simulators cannot delete anything from the user's inventory: "purge" actions from a foreign simulator are ignored by the user's home inventory service. This means that if the user performs a genuine "purge" while in a foreign sim, the viewer will show that the items have been purged, but upon the next login those items will be in the Trash bin again, because they weren't really deleted.

Second, upon arrival at a foreign simulator that simulator is not given the user's root inventory folder. Instead, it is given another folder called Suitcase that will act as root folder while the user is visiting. As such, the simulator cannot recursively download the user's inventory; it can only 'see' the items and folder under the Suitcase folder. (No need to create a Suitcase folder, it will be created if it doesn't exist)

Besides the Suitcase folder, the only items that the simulator will know about upon user's arrival are those pertaining to the user's current appearance. 'Knowing about' means that a rogue simulator can copy them; but it can never delete them, as explained above.

Because inventory access is dictated by the viewer (i.e. by the user's actions), privacy of inventory depends on what actions the user does while visiting foreign grids. If the user does not access his/her inventory, the visiting simulator will know very little about it -- only the things stated above. On the other extreme, searching for an inventory item or opening up the texture picker makes the viewer query the entire user inventory, sending the to simulator all folder identifiers one by one; this means that the visiting simulator will 'see' the entire inventory; rogue simulators may then copy the items (again, they cannot delete them).

While using the Linden family of viewers, HG users should be aware of these issues. Trust decisions, ultimately, fall on them. If users trust the visiting grid, they can access their inventory without worrying that it will be stolen; if, however, the users don't know much about the simulator that they are visiting, they can still visit but should abstain from performing inventory actions.

==Groups Changes==

The groups module can use a PHP XmlRpc server from:

* Flotsam project at http://code.google.com/p/flotsam/
* SimianGrid project at http://code.google.com/p/openmetaverse

The same GroupsServerURI configuration variable is used for either. 0.6.x setups using the old XmlRpcServiceURL configuration variable should be changed to use GroupsServerURI as illustrated in Opensim.ini.example.

==Profile Changes==

The profile feature has been discontinued from the core distribution. 3rd-party addons provide different flavors of support for this feature.

==Bug Fixes, New Features and Assorted Changes==

* Impovements to sculptmap and level of detail handling.
* Standalone database configuration simplified.
* Parcel and estate bans
* Neighboring regions being brought up and down results in correct accessibility in the connected clients.
* Friends online/offline notifications are now working across the board.
* Object attach/drop/attach correctly working.
* Inventory folder 'wear' working correctly.
* Inventory accept/decline notifications working correctly.
* Eliminated deadlock affecting scripts startup. This deadlock showed more often in certain mono versions. The same code was responsible for a CPU spike at region startup, which is now under control.
* Megaregion prims now in place after unclean shutdown. They used to be missing.
* Several permissions vulnerabilities fixed.
* Allow use of old angle rules PSYS_SRC_INNERANGLE and PSYS_SRC_OUTERANGLE in llParticleSystem().
* Bug fix in llRot2Euler()
* llVecNorm() now returns a zero-length vector when one is supplied as input.
* Fixed problem where "Adult" regions were reported as being of type "Unknown"
* Fixed Copy on Ray, Drag Copy and other little things.
* Make drag copy and copy-on-ray handle friends list perms properly.
* Added checks to XInventory DB layer to truncate names and descriptions, so they fit their sizes in the DB.
* Guarded prioritizer agains null values as those produced by a bullet dying before it can be updated
* Security fix: Allow only textures to be fetched using HTTP texture cap
* Fixed faulty profile cut parameter checking in llSetPrimitiveParams()
* Fixed attachments coming back upon being detached in neighbouring regions and crossing.
* Added CHANGED_TELEPORT event trigger upon inter-sim teleports.
* Prevented region crossings from screwing up complex attachments by preserving link numbers.
* Added ability to load IARs directly from URIs
* Added prim prioritization according to several schemes (configurable)
* Fixed spamming the assets table with map tiles.
* Corrected an invalid construction of Primitive.TextureEntry
* Added LightShare scripting
* Added SimianGrid connectors
* "Share with group" implemented for object inventory items. This only works if you're using a groups module with OpenSim.
* Added HTTP texture retrieval.
* Fixes to allow Linden Lab's viewer 2 to work, though some new features of this viewer (e.g. shared media/media on a prim) are not yet implemented.
* Added --skip-assets option to load oar command. This allows an oar to be loaded without loading its assets, which can be quicker if the assets are already known to be in the database.
* Various core performance improvements.
* Various core stability improvements.

* Master Avatar no longer in use. Upon creation of a new region, the user is prompted for the region owner and estate information. In standalone configurations, the region owner account is created if it doesn't exist; in grid configurations, the region owner account must already have been created.

= Upgrading from older releases =

Upgrading the database from older releases is done automatically when OpenSim 0.7 is first run; no special provisions are required. However, we very strongly recommend that you backup your database first, in case something goes wrong during the migration process.

Configuration files, on the other hand, have changed in 0.7 compared with 0.6 versions. Simply copying old configuration files can result in strange errors. We recommend that you start afresh with the OpenSim.ini.example and example files in bin/config-include and manually move accross any changes that you've made to the default configuration.

== Standalone Deployments ==

For standalones, there is no noticeable difference in the mode of operation. The main configuration file is OpenSim.ini, as before; make sure it exists and that is readable. If you are upgrading from 0.6.[7-8-9], you should already know about config-include/StandaloneCommon.ini. If you are upgrading from older releases, please be aware that this additional configuration file is needed. Make sure it exists and that it is readable. There are .example files for both of these.

There were several changes and additions to the configuration files. As such, it is better that you start with the given .example files and customize from them, as opposed to upgrading your existing ini files.

== Grid Deployments ==

The deployment model for grids has changed considerably, as explained before, so you need to acquire the know-how for operating in this post-0.7 model. The most important change is this: '''none of the UGAIM servers exist any longer'''; they have been replaced by one single server shell, Robust.exe, configured by one single configuration file, Robust.ini (or Robust.HG.ini). There are .example files provided. Copy one of them, and make the appropriate customizations. Robust does not depend on OpenSim.ini, only on Robust.ini.

Robust.exe -inifile=Robust.HG.ini
or
Robust.exe -inifile=Robust.ini

On the simulators' side, the operation is the same as before. The main configuration file is OpenSim.ini, as before; make sure it exists and that is readable. If you are upgrading from 0.6.[7-8-9], you should already know about config-include/GridCommon.ini. If you are upgrading from older releases, please be aware that this additional configuration file is needed. Make sure it exists and that it is readable. There are .example files for both of these.

It is better that you start with the given .example files and customize from them, as opposed to upgrading your existing ini files.

=Troubleshooting=

When migrations fail, the migration number is incremented anyway. If one of your migrations fail, notice which number it was, and to which table it pertained to. Then, login to the DB and set the version number of the corresponding store to the number just before the failed migration.

For example, if there is a failure in migration 8 for the assets table, issue this command in the DB:
> UPDATE Migrations SET version=7 WHERE name='AssetStore';
Then run Robust/OpenSim again.

The very last resort is to perform the migration manually, i.e. login to the DB server and issue the offending statement directly there.

See also [http://opensimulator.org/mantis/view.php?id=4875 this bug report] for useful tips related to account migration problems.

[[Category:History]]