Server Commands

Revision as of 09:58, 25 January 2011

 

Home

 

Download

 

News

 

Support

 

Admin

 

Dev

 

Screen Shots

 

Grid List

 

Bugs

Languages:

English    Deutsch    Français    日本語    Русский

Technical Reference -> Terms -> Server Commands

What are 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. This summary quickly goes out of date - the best place to find commands is by typing "help" on the region console.

General Server Commands

Console Command Summary View here: Console_Commands  (opens in this tab)

• 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 (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
• 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
• config get [<section>] [<key>] - Get the current configuration, either for a particular key, a particular section or the whole config.
• config set <section> <key> - Set a particular configuration value. On the whole, this is useless since neither OpenSim nor modules dynamically reload config values.
• config save <path> - Save the current configuration to a file.
• create region [name] [filename] - Create a new region
• create user (in opensim.exe console for Standalone mode or User Server console for gridmode)
• delete-region <name> - Delete a region from disk
• edit scale [primitivename] [xvalue] [yvalue] [zvalue] - changes size of the named prim
• 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
• kick user <first> <last> [message]: - Kick a user off the simulator
• kill uuid <UUID> - Kill an object by UUID (helpfull with red lines in the console)
• load-xml [filename] [-newUID] [offset_x offset_y offset_z] - load prims from XML (0.7.*: DEPRECATED and may be REMOVED soon. Use "load xml2" instead)

-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)

> 0.6.9 should support following:

load xml [-newIDs [<x> <y> <z>]:] - Load a region's data from XML format

those xml are the result of the export save or *export save-all

• 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)
• load-xml2 [filename] - optional parameters not supported for XML2 format as at 1-Jul-2008
• load xml2 - Load a region's data from XML2 format
• 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.
• load iar <first> <last> <inventory path> <password> [<archive path>]: - Load user inventory archive.
• save iar <first> <last> <inventory path> <password> [<archive path>]: - Save user inventory archive. See save iar
• modules list - List modules
• modules load <name> - Load a module
• modules unload <name> - Unload a module
• quit - Shutdown the simulator
• reset user password - Resets a users password if they forget it (in opensim.exe console for Standalone mode or User Server console for gridmode)
• restart - Restarts all sims in this instance
• set-time [time] - sets the region's clock
• set log level [level] - change the console logging level only. For example, off or debug. See Logging for more information.
• show modules - show info about loaded region or shared modules
• shutdown - same as quit.
• terrain help - show help for terrain commands.
• quit - equivalent to shutdown.

User Server Commands (in Gridmode) (or more User and Region specific)

• 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>
• monitor report - Returns a variety of statistics about the current region and/or simulator
• 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. See Logging for more information.
• show info - show server information (version and startup path)
• show neighbours - Shows the local regions' neighbours
• show queues - Show queue data for agent connections.
• show ratings - Show rating data
• show regions - Show region data (XLocation YLocation coordinates, Region Names, Region Ports)
• show stats - show usefull statistical information for this server. See Frame Statistics Values below for more information.
• show threads - shows the persistent threads registered with the system. Does not include threadpool threads.
• show throttles - Show throttle data for each client connection, and the maximum allowed for each connection by the server.
• show uptime - show server startup time and uptime.
• show users - show info about currently connected users to this region
• show version - show server version.
• shutdown - disconnects all clients and shutdown.

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

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

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