SimulatorLoginProtocol - Revision history

Steevithak: /* References */ added link to ULM diagram of SL login sequence

2020-09-21T01:25:50Z

‎References: added link to ULM diagram of SL login sequence

Steevithak: /* References */ replaced 404 link using wayback archive

2020-09-20T23:22:27Z

‎References: replaced 404 link using wayback archive

Steevithak: /* XML-RPC Call Parameters */ corrected list of login XML-RPC parameters, divided into required and options

2020-09-20T23:09:38Z

‎XML-RPC Call Parameters: corrected list of login XML-RPC parameters, divided into required and options

Steevithak: /* XML-RPC Call Parameters */ added explanation of the id0 parameter of login XML-RPC call

2020-09-20T22:25:34Z

‎XML-RPC Call Parameters: added explanation of the id0 parameter of login XML-RPC call

Steevithak: /* Details */ broke up RPC example into manageable sections

2020-09-20T22:20:10Z

‎Details: broke up RPC example into manageable sections

Acryline at 11:12, 3 March 2015

2015-03-03T11:12:35Z

Justincc: /* Details */

2014-09-18T22:53:40Z

‎Details

Justincc: /* Details */

2014-09-18T22:52:28Z

‎Details

Justincc: /* Details */

2014-09-18T22:47:17Z

‎Details

Justincc: /* Details */

2014-09-18T22:44:03Z

‎Details

← Older revision		Revision as of 01:25, 21 September 2020
Line 2,957:		Line 2,957:

	[https://web.archive.org/web/20160728124132/http://justincc.org/blog/2011/05/26/opensimulators-login-process-and-common-login-problems/ OpenSimulator’s login process and common login problems] - Blog post with diagrams that illustrate the login process.		[https://web.archive.org/web/20160728124132/http://justincc.org/blog/2011/05/26/opensimulators-login-process-and-common-login-problems/ OpenSimulator’s login process and common login problems] - Blog post with diagrams that illustrate the login process.
		+
		+	[http://wiki.secondlife.com/wiki/File:Second_LIfe_Login_UML2.png Second Life Login ULM Sequence Diagram]

← Older revision		Revision as of 23:22, 20 September 2020
Line 2,956:		Line 2,956:
	== References ==		== References ==

−	http://justincc.org/blog/2011/05/26/opensimulators-login-process-and-common-login-problems/ ~~provides some~~ diagrams that illustrate the login process.	+	[https://web.archive.org/web/20160728124132/http://justincc.org/blog/2011/05/26/opensimulators-login-process-and-common-login-problems/ OpenSimulator’s login process and common login problems] - Blog post with diagrams that illustrate the login process.

@@ Line 183: / Line 183: @@
 == XML-RPC Call Parameters ==
-The parameters are as follows
+Required Parameters
 * '''first''' - First name of the user.
@@ Line 189: / Line 189: @@
 * '''passwd''' - MD5 hash of the user's password with the string "$1$" prepended.
 * '''start''' - The region in which the user should start upon login.  This is one of
-** "home" - start in the user's home location.
+** "home" - start in the user's home location
-** "last" - start in the location from which the user last logged out.
+** "last" - start in the location from which the user last logged out
 ** A specific location.  This is in the format "uri:<region-name>&amp;<x-coord>&amp;<y-coord>&amp;<z-coord>".  For instance, the string "uri:test&amp;128&amp;128&amp;0" above signals that the user should login to the center of the region named test (the avatar is placed on the ground if given a z-coordinate below terrain).
 * '''channel''' - Name of the viewer/client connecting.
-* '''platform''' - Probably the platform of the client/viewer.  Currently ignored by OpenSimulator.  This is probably not particularly important anyway - Singularity 1.8.5.5617, for instance, has this set to "Win" even on the Linux platform.
+* '''version''' - Version number of the viewer/client connecting.
 * '''mac''' - MAC address of the network card used by the client/viewer to make the connection.
-* '''id0''' - A hardware hash based on the serial number of user's first hard drive. Used by Second Life to uniquely identifying computers and track users. Currently unused by OpenSimulator.
+* '''id0''' - A hardware hash based on the serial number of user's first hard drive. Used by Second Life to uniquely identify computers and track users. Currently unused by OpenSimulator.
-* '''skipoptional''' - A boolean.  Function unknown.  Currently unused by OpenSimulator.
+* '''agree_to_tos''' - Boolean ('''true'''|'''false'''). Has user agreed to terms of service on Second Life. Currently unused by OpenSimulator.
 * '''last_exec_event''' - An integer.  Function unknown.  Currently unused by OpenSimulator.
-* '''options''' - A list of strings.  Function unknown, though probably used in many cases to control the data sent back by the login service.  Currently unused by OpenSimulator which just sends back all data every time.
+* '''last_exec_duration'''
 == Example XML-RPC Response ==

@@ Line 196: / Line 196: @@
 * '''platform''' - Probably the platform of the client/viewer.  Currently ignored by OpenSimulator.  This is probably not particularly important anyway - Singularity 1.8.5.5617, for instance, has this set to "Win" even on the Linux platform.
 * '''mac''' - MAC address of the network card used by the client/viewer to make the connection.
-* '''id0''' - A GUID.  Function unknown.  Currently unused by OpenSimulator.
+* '''id0''' - A hardware hash based on the serial number of user's first hard drive. Used by Second Life to uniquely identifying computers and track users. Currently unused by OpenSimulator.
 * '''skipoptional''' - A boolean.  Function unknown.  Currently unused by OpenSimulator.
 * '''last_exec_event''' - An integer.  Function unknown.  Currently unused by OpenSimulator.

@@ Line 30: / Line 30: @@
 The viewer connects directly to the simulator and is authenticated using the circuit code.
-== Details ==
+== Example XML-RPC Call ==
 The simulator exposes an XML-RPC method called login_to_simulator at the loginuri URL.  This takes a number of parameters from the viewer.  Here's an example call.
@@ Line 180: / Line 180: @@
 </methodCall>
 </source>
 The parameters are as follows
@@ Line 198: / Line 200: @@
 * '''last_exec_event''' - An integer.  Function unknown.  Currently unused by OpenSimulator.
 * '''options''' - A list of strings.  Function unknown, though probably used in many cases to control the data sent back by the login service.  Currently unused by OpenSimulator which just sends back all data every time.
 Here's an example response to the example call above.  If you are looking to use this information in code, I recommend that you start by using only the parameters that you actually need.  There are likely many parameters here that are historical and actually no longer or never used by viewers (and which one day should be cleaned up).
@@ Line 2,831: / Line 2,835: @@
 </methodResponse>
 </source>
 The parameters are as follows:

← Older revision		Revision as of 11:12, 3 March 2015
Line 1:		Line 1:
		+	{{Languages\|SimulatorLoginProtocol}}
	(This page is a work in progress)		(This page is a work in progress)

@@ Line 2,838: / Line 2,838: @@
 ** look_at is the direction the avatar should be facing.  This is a unit vector so (0, 1, 0) is facing straight north, (1, 0, 0) is east, (0,-1, 0) is south and (-1, 0, 0) is west.
 * '''look_at''' - The direction in which the avatar should be facing upon login.  This is a unit vector so (0, 1, 0) is facing straight north, (1, 0, 0) is east, (0,-1, 0) is south and (-1, 0, 0) is west.
-* '''agent_access_max''' - The maximum level of region that user can access.  OpenSimulator currently always sets this to "A" (probably adult).
+* '''agent_access''' - The current maturity access level of the user.  OpenSimulator currently always sets this to "M" (probably mature).  Probably unused.
 * '''seed_capability''' - The URL that the viewer should use to request further [[capabilities]].
-* '''first_name''' - First name of the logged in user.
+* '''first_name''' - First name of this user.
 * '''sim_ip''' - The IP to use to communicate with the receiving simulator.
 * '''sim_port''' - The UDP port to use to communicate with the receiving simulator.
@@ Line 2,850: / Line 2,853: @@
 * '''region_size_y''' - The y size of the start region in meters.  Usually this will be 256 but with a [[varregion]] this can be a multiple of 256.
 * '''circuit_code''' - Circuit code to use for all UDP connections.
-* '''session_id''' - UUID of this session.
+* '''session_id''' - The UUID of this session.
 * '''inventory-root''' - The ID of the user's root folder (which appears as the "My Inventory" folder in most viewers).
 * '''inventory-skeleton''' - Details about the child folders of the root folder.  Each entry has the following parameters.
@@ Line 2,870: / Line 2,874: @@
 ** asset_id - The asset ID of the gesture.
 * '''initial-outfit''' - You would think this would correspond to user's initial outfit.  However, OpenSimulator always sends back an entry with folder_name "Nightclub Female" and gender "female" with no obvious ill effect.  Can probably be ignored.
 * '''login-flags''' - Some extra information about login.  Of these
 ** stipend_since_login - probably shows whether a user received stipend money since their last login.  OpenSimulator always sets this to "N".

@@ Line 2,847: / Line 2,847: @@
 * '''region_x''' - The x grid coordinate of the start region in meters.  So a region at map co-ordinate 1000 will have a grid co-ordinate of 256000.
 * '''region_y''' - The y grid coordinate of the start region in meters.
-* '''circuit_code''' - The session ID.
+* '''region_size_x''' - The x size of the start region in meters.  Usually this will be 256 but with a [[varregion]] this can be a multiple of 256.
 * '''inventory-root''' - The ID of the user's root folder (which appears as the "My Inventory" folder in most viewers).
 * '''inventory-skeleton''' - Details about the child folders of the root folder.  Each entry has the following parameters.
@@ Line 2,866: / Line 2,869: @@
 ** item_id - The item ID of the gesture in the user's inventory.
 ** asset_id - The asset ID of the gesture.
 * '''login-flags''' - Some extra information about login.  Of these
 ** stipend_since_login - probably shows whether a user received stipend money since their last login.  OpenSimulator always sets this to "N".

@@ Line 2,841: / Line 2,841: @@
 * '''seed_capability''' - The URL that the viewer should use to request further [[capabilities]].
 * '''first_name''' - First name of the logged in user.
-* '''sim_ip''' - IP to use to connect to the initial simulator.
+* '''sim_ip''' - The IP to use to communicate with the receiving simulator.
-* '''region_x''' - The x grid coordinate of the region in meters.  So a region at map co-ordinate 1000 will have a grid co-ordinate of 256000.
+* '''sim_port''' - The UDP port to use to communicate with the receiving simulator.
-* '''region_y''' - The y grid coordinate of the region in meters.
+* '''http_port''' - Function unknown.  OpenSimulator currently always sets this to 0.  The port given directly for capabilities is used instead.
 * '''circuit_code''' - The session ID.
 * '''inventory-root''' - The ID of the user's root folder (which appears as the "My Inventory" folder in most viewers).
@@ Line 2,853: / Line 2,856: @@
 ** '''version''' - The version number of the folder.  This is increment on operations that change the folder's contents.  A viewer can cache these version numbers and other inventory information so that it can reduce the amount of inventory data that it has to request.
 * '''inventory-lib-root''' - The ID of the library root folder (which appears as the "OpenSim Library" folder in most viewers).
-* '''inventory-skeleton''' - Details about the child folders of the library root folder.  Has the same format as inventory-skeleton above.
+* '''inventory-skel-lib''' - Details about the child folders of the library root folder.  Has the same format as inventory-skeleton above.
 * '''map-server-url''' - URL from which to request [[map]] tiles.
 * '''buddy-list''' - The user's friend list.  This contains an entry for each friend (buddy).  These entries have the following parameters.
 ** buddy_id - The UUID of the friend.
-** buddy_rights_given - The rights granted to this friend.  The values correspond [https://github.com/openmetaversefoundation/libopenmetaverse/blob/master/OpenMetaverse/FriendsManager.cs the FriendsRights enum in libopenmetaverse].
+** buddy_rights_given - The rights that the friend has granted to this user.  The value corresponds to [https://github.com/openmetaversefoundation/libopenmetaverse/blob/master/OpenMetaverse/FriendsManager.cs the FriendsRights enum in libopenmetaverse].
 * '''login-flags''' - Some extra information about login.  Of these
 ** stipend_since_login - probably shows whether a user received stipend money since their last login.  OpenSimulator always sets this to "N".