Server Commands

From OpenSimulator

(Difference between revisions)
Jump to: navigation, search
(removed "Template:ServerCommands" reference link)
(Integrated "Template:Server_Commands" into the main "Server_Commands" page. Template:Server_Commands can now be marked for deletion. Thank-you!)
Line 2: Line 2:
 
<br>
 
<br>
 
'''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
 
'''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
 +
 +
 +
==General Server Commands==
 +
* alert - send an alert to a designated user or all users.
 +
    alert [First] [Last] [Message] - send an alert to a user. Case sensitive.
 +
    alert general [Message] - send an alert to all users.
 +
* backup - trigger a simulator backup
 +
* change-region [region name] - subsequent commands apply only to the specified region
 +
* change-region root (or ..) - exits the region and returns to 'root'
 +
* clear-assets - forcibly clears asset cache, probably leaving sim unstable. Use with caution.
 +
* create-region [name] [filename] - Creates a new region
 +
* create user (in opensim.exe console for Standalone mode or User Server console for gridmode)
 +
* command-script [name of scriptfile] - Runs a command script containing server commands
 +
* edit-scale [primitivename] [xvalue] [yvalue] [zvalue] - changes size of the named prim
 +
* force-update - triggers a resend of all prims in a region
 +
* help - ehm... what was this for again...?
 +
* load-xml [filename] [-newUID] [offset_x offset_y offset_z] - load prims from XML
 +
    -newUID optional switch generates new UUID's for all prims
 +
            leave this switch off to keep UUID's as they were
 +
    Offset is optional
 +
 +
    This example lets you place it at an offset from 100,100,20.. as such: 
 +
    load-xml [filename] -newUID 3 1 2
 +
    (Loading the prim at 103, 101, 22)
 +
* save-xml [filename] - save prims to XML
 +
* load-xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
 +
* save-xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)
 +
* load-oar [filename] - load an OpenSimulator archive.  This entirely replaces the current region.  Default filename is scene_oar.tar.gz.  See [[OpenSim Archives]] for more details.
 +
* save-oar [filename] - save the current region to an OpenSimulator archive.  Default filename is scene_oar.tar.gz.  See [[OpenSim Archives]] for more details.
 +
* permissions [on|off] - each user becomes super user
 +
* script [command] - sends a command to all scripts in the Scene
 +
* reset user password - Resets a users password if they forget it (in opensim.exe console for Standalone mode or User Server console for gridmode)
 +
* set-time [time] - sets the region's clock
 +
* show assets - shows state of asset cache.
 +
* show uptime - show simulator startup and uptime.
 +
* show users - show info about connected users.
 +
* show modules - show info about loaded region or shared modules
 +
* show threads - shows the persistent threads registered with the system.  Does not include threadpool threads.
 +
* shutdown - disconnect all clients and shutdown.
 +
* terrain help - show help for terrain commands.
 +
* quit - equivalent to shutdown.
 +
 +
==User Server Commands (in Gridmode)==
 +
* create user [first] [last] [passw] [RegionX] [RegionY] - 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 yser default coordinates
 +
    of 1000,1000 for Start Region X and Y position otherwise server
 +
    gives error of "[LOGIN]: Not found region"
 +
* logoff-user <firstname> <lastname> <message> - logs off the specified user from the grid
 +
* 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>
 +
* quit - equivalent to shutdown.
 +
* reset user password - Resets a users password if they forget it.
 +
* set log level [level] - change the console logging level only.  For example, off or debug.
 +
* show info - show server information (e.g. startup path).
 +
* show stats - show statistical information for this server.
 +
* show threads - list tracked threads.
 +
* show uptime - show server startup time and uptime.
 +
* show version - show server version.
 +
* shutdown - shutdown the server.
 +
 +
== Terrain Specific ==
 +
 +
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
 +
 +
=== Details of Terrain 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
 +
 +
==Hypergrid Commands==
 +
 +
When '''opensim.exe''' is run with the '''-hypergrid=true''' flag:
 +
 +
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
 +
 +
'''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
 +
 +
==SVNBackup Module==
 +
* svn save - saves a current copy of all your regions to SVN.
 +
* svn load - loads SVN head and imports it to your region.
 +
* svn load <revision> - loads a specified revision
 +
* svn load-region <name> - loads a specified region at head revision
 +
* svn load-region <name> <revision> - loads a specified region from a specified SVN revision.
 +
  
 
==UserServer Commands==
 
==UserServer Commands==

Revision as of 02:44, 21 May 2009

Technical Reference -> Terms -> Server_Commands

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


Contents

General Server Commands

  • alert - send an alert to a designated user or all users. 
   alert [First] [Last] [Message] - send an alert to a user. Case sensitive.
   alert general [Message] - send an alert to all users.
  • backup - trigger a simulator backup
  • change-region [region name] - subsequent commands apply only to the specified region
  • change-region root (or ..) - exits the region and returns to 'root'
  • clear-assets - forcibly clears asset cache, probably leaving sim unstable. Use with caution.
  • create-region [name] [filename] - Creates a new region
  • create user (in opensim.exe console for Standalone mode or User Server console for gridmode)
  • command-script [name of scriptfile] - Runs a command script containing server commands
  • edit-scale [primitivename] [xvalue] [yvalue] [zvalue] - changes size of the named prim
  • force-update - triggers a resend of all prims in a region
  • help - ehm... what was this for again...?
  • load-xml [filename] [-newUID] [offset_x offset_y offset_z] - load prims from XML 
    -newUID optional switch generates new UUID's for all prims 
            leave this switch off to keep UUID's as they were
    Offset is optional

    This example lets you place it at an offset from 100,100,20.. as such:  
    load-xml [filename] -newUID 3 1 2
    (Loading the prim at 103, 101, 22)
  • save-xml [filename] - save prims to XML
  • load-xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
  • save-xml2 [filename] - save prims to XML (Format 2 - rearrangement of some nodes, to make loading/saving easier)
  • load-oar [filename] - load an OpenSimulator archive. This entirely replaces the current region. Default filename is scene_oar.tar.gz. See OpenSim Archives for more details.
  • save-oar [filename] - save the current region to an OpenSimulator archive. Default filename is scene_oar.tar.gz. See OpenSim Archives for more details.
  • permissions [on|off] - each user becomes super user
  • script [command] - sends a command to all scripts in the Scene
  • reset user password - Resets a users password if they forget it (in opensim.exe console for Standalone mode or User Server console for gridmode)
  • set-time [time] - sets the region's clock
  • show assets - shows state of asset cache.
  • show uptime - show simulator startup and uptime.
  • show users - show info about connected users.
  • show modules - show info about loaded region or shared modules
  • show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
  • shutdown - disconnect all clients and shutdown.
  • terrain help - show help for terrain commands.
  • quit - equivalent to shutdown.

User Server Commands (in Gridmode)

  • create user [first] [last] [passw] [RegionX] [RegionY] - 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 yser default coordinates
   of 1000,1000 for Start Region X and Y position otherwise server
   gives error of "[LOGIN]: Not found region"
  • logoff-user <firstname> <lastname> <message> - logs off the specified user from the grid
  • 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>
  • quit - equivalent to shutdown.
  • reset user password - Resets a users password if they forget it.
  • set log level [level] - change the console logging level only. For example, off or debug.
  • show info - show server information (e.g. startup path).
  • show stats - show statistical information for this server.
  • show threads - list tracked threads.
  • show uptime - show server startup time and uptime.
  • show version - show server version.
  • shutdown - shutdown the server.

Terrain Specific

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

Details of Terrain 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

Hypergrid Commands

When opensim.exe is run with the -hypergrid=true flag:

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

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.

link-mapping

SVNBackup Module

  • svn save - saves a current copy of all your regions to SVN.
  • svn load - loads SVN head and imports it to your region.
  • svn load <revision> - loads a specified revision
  • svn load-region <name> - loads a specified region at head revision
  • svn load-region <name> <revision> - loads a specified region from a specified SVN revision.


UserServer Commands

Only in grid mode:
login-level [level] : set the minimal user GodLevel to access to the grid. By default a new user has a value of 0
login-reset : reset the level to 0
login-text "text"  : set the welcome text


Command Proposals

show stats
kill [username] (Rock Vacirca: I hope this means: removes the named user and all their assets)
save-xml/load-xml [primitivename] [filename]
water-level float meters
water-tide float low_tide_level_meters float high_tide_level_meters float period_hours ;-)
delete-prims [regionname]
diagnostics [on/off] (disable the server diagnostics, as users cannot log in while this is happening)
show users all (list all users, whether logged in or not)  NOT WORKING IN STANDALONE
Retrieved from "http://opensimulator.org/index.php?title=Server_Commands&oldid=12742"
Personal tools
General
About This Wiki