317 Protocol

From RuneWiki
Jump to navigationJump to search
Stub

This article is a stub. You can help RuneWiki by expanding it.


Login Protocol

The login is comprised of four stages in which the client and server switch in regards to which one is reading and which one is writing.

Variables:

The login process has a lot of variable data, compiled here is a list of the variables and their different values.

Name Hash

A hash of the player name, thought to be used to select an appropriate login server. This has no use in current private servers.

Return Code

The return code is a code used to identify which part of login the session is currently at.

Value Response
-1 Waits for 2000ms and tries again while counting failures.
0 Exchanges session keys, player name, password, etc.
1 Waits for 2000ms and tries again.
2 Client made a successful login.
3 "Invalid username or password."
4 "Your account has been disabled. Please check your message-center for details."
5 "Your account is already logged in. Try again in 60 secs..."
6 "RuneScape has been updated! Please reload this page."
7 "This world is full. Please use a different world."
8 "Unable to connect. Login server offline."
9 "Login limit exceeded. Too many connections from your address."
10 "Unable to connect. Bad session id."
11 "Login server rejected session. Please try again."
12 "You need a members account to login to this world. Please subscribe, or use a different world."
13 "Could not complete login. Please try using a different world."
14 "The server is being updated. Please wait 1 minute and try again."
15 N/A
16 "Login attempts exceeded. Please wait 1 minute and try again."
17 "You are standing in a members-only area. To play on this world move to a free area first."
20 "Invalid loginserver requested. Please try using a different world."
21 "You have only just left another world. Your profile will be transferred in: (number) seconds."
22 "Malformed login packet. Please try again."
None of the above "Unexpected server response. Please try using a different world."

Server Session Key

The server-session-key is one of two ciphers used to encrypt the game protocol, using the ISAAC algorithms.

"Data File Version"

Unknown, quoted from a Winterlove private server.

User ID

The ID of the user.

Username

The username of the player, used to identify their account.

Password

The password of the player account, used so only they can log into their account.

Client Session Key

The client-session-key is one of two ciphers used to encrypt the game protocol, using the ISAAC algorithms.

Connect Status

The status of the connection.

Value Status
16 Signifies that the connection is new.
18 Signifies that the session is reconnecting a previously lost connection.

Size

The size of the unencrypted login packet, used to determine how many bytes need to be read from the stream by the server.

Client Version

The memory-version of the game client.

Client Version Value: 0

Signifies that the client is a low-memory client.

Client Version Value: 1

Signifies that the client is a high-memory client.

CRC Values

9 4-byte values, Each containing the CRC of their respective cache files. Used by the server to verify client is up to date.

Player Status

The in-game player status - player, player moderator, or administrator.

Value Status
0 Signifies that this player is a normal player.
1 Signifies that this player is a player moderator.
2 Signifies that this player is an administrator.

Flagged

If set to 1, information about mouse movements etc. are sent to the server. Suspected bot accounts are flagged.

Login Process:

Stage 1: Client -> Server

Type Value
ubyte 14
ubyte "name hash"


Stage 2: Server -> Client

Type Value
byte 0
byte 0
byte 0
byte 0
byte 0
byte 0
byte 0
byte 0
byte "return code"
long "server session key"


Stage 3: Client -> Server

Type Value
byte "connect status"
byte "size"
byte 255
short 317
byte "client version"
int "crc values"[0]
int "crc values"[1]
int "crc values"[2]
int "crc values"[3]
int "crc values"[4]
int "crc values"[5]
int "crc values"[6]
int "crc values"[7]
int "crc values"[8]
byte 10
int "datafileversion"[0]
int "datafileversion"[1]
int "datafileversion"[2]
int "datafileversion"[3]
int "user id"
string "username"
string "password"
long "client session key"
long "server session key"


Stage 4: Server -> Client

Type Value
byte "return code"
byte "player status"
byte "flagged"


Response Codes

Towards the end of the login procedure, we send different values to the client to allow or deny a login. The various values show different messages on the login box on the client or do something internally.

Value Response
-1 Waits for 2000ms and tries again while counting failures.
0 Exchanges session keys, player name, password, etc.
1 Waits for 2000ms and tries again.
2 Client made a successful login.
3 "Invalid username or password."
4 "Your account has been disabled. Please check your message-center for details."
5 "Your account is already logged in. Try again in 60 secs..."
6 "RuneScape has been updated! Please reload this page."
7 "This world is full. Please use a different world."
8 "Unable to connect. Login server offline."
9 "Login limit exceeded. Too many connections from your address."
10 "Unable to connect. Bad session id."
11 "Login server rejected session. Please try again."
12 "You need a members account to login to this world. Please subscribe, or use a different world."
13 "Could not complete login. Please try using a different world."
14 "The server is being updated. Please wait 1 minute and try again."
15 See the notes below.
16 "Login attempts exceeded. Please wait 1 minute and try again."
17 "You are standing in a members-only area. To play on this world move to a free area first."
20 "Invalid loginserver requested. Please try using a different world."
21 "You have only just left another world. Your profile will be transferred in: (number) seconds."
None of the above "Unexpected server response. Please try using a different world."

Regarding response code 15

On the server, players are not unregistered for quite some time. This can be best witnessed when the client forcefully closes the connection while in combat. If you're quick enough before the player dies or kills the NPC, login attempts during that time return that the account is already logged in. This probably explains why the message says "try again in 60 seconds", and they just reused the response when the player is truly logged in.

Going along with this "players aren't offline yet" idea, when the client experiences some lag and performs a reconnect, it byte 18 as it's "connection type" to the server.

The server most likely saves this as a boolean (reconnect = var == 18;). When the login is entirely validated, meaning the password's are okay and the server isn't full, it can either send back the normal response, 2, or 15.

But why 15? If you look at the client code, you'll see that the chat messages aren't cleared. If you've ever had a shitty connection you've noticed that your chat stays there upon a reconnect, and this is exactly why. There are some minor annoyances with implementing response 15, since you can't send the rights byte (or the flagged byte, I forget which).

Game Protocol

The game protocol is the in-game communication of player actions between the server and client.

Server -> Client Packets

Opcode Type Length (bytes) Name Description
1 FIXED 0 Animation reset Resets all animations in the immediate area.
68 FIXED 0 Reset button state Resets the button state for all buttons.
71 FIXED 3 Send sidebar interface Assigns an interface to one of the tabs in the game sidebar.
73 FIXED 4 Load map region Loads a new map region.
97 FIXED 2 Show interface Displays a normal interface.
107 FIXED 0 Reset camera Resets the camera position.
109 FIXED 0 Logout Disconnects the client from the server.
110 FIXED 1 Run energy Sends the players run energy level.
114 FIXED 2 System update Sends how many seconds until a 'System Update.'
122 FIXED 4 Interface color Changes the color of an interface.
126 VARIABLE_SHORT N/A Send text Attaches text to an interface.
164 FIXED 2 Chat interface Shows an interface in the chat box.
176 FIXED 10 Open welcome screen Displays the welcome screen.
206 FIXED 3 Chat settings Sends the chat privacy settings.
208 FIXED 2 Walkable interface Displays an interface in walkable mode.
219 FIXED 0 Clear screen Clears the screen of all open interfaces.
240 FIXED 2 Weight Sends the players weight amount.
241 VARIABLE_SHORT N/A Construct map region Constructs a dynamic map region using a palette of 8*8 tiles.
246 FIXED 6 Interface item Displays an item model inside an interface.
249 FIXED 3 Initialize player Sends the player's membership status and their current index on the server's player list.
253 VARIABLE_BYTE N/A Send message Sends a server message (e.g. 'Welcome to RuneScape') or trade/duel request.

Client -> Server Packets

Opcode Type Length (bytes) Name Description
0 FIXED 0 Idle Sent when there are no actions being performed by the player for this cycle.
3 FIXED 1 Focus change Sent when the game client window goes out of focus.
4 VARIABLE BYTE N/A Chat Sent when the player enters a chat message.
14 FIXED 8 Item on player Sent when a player uses an item on another player.
17 FIXED 2 NPC action 2 Sent when a player clicks the second option of an NPC.
21 FIXED 2 NPC action 3 Sent when a player clicks the third option of an NPC.
25 FIXED 10 Item on floor Sent when a player uses an item on another item thats on the floor.
39 FIXED 2 Follow Sent when a player clicks the follow option on another player.
41 FIXED 6 Equip item Sent when a player equips an item.
43 FIXED 6 Bank 10 items Sent when a player banks 10 of a certain item.
53 FIXED 4 Item on item Sent when a player uses an item with another item.
70 FIXED 6 Object action 3 Sent when the player clicks the third action available for an object.
72 FIXED 2 Attack (NPC) Sent when a player attacks an NPC.
73 FIXED 2 Trade request Sent when a player requests a trade with another player.
74 FIXED 8 Remove ignore Sent when a player removes a player from their ignore list.
79 FIXED 6 Light item Sent when a player attempts to light logs on fire.
86 FIXED 4 Camera movement Sent when the player moves the camera.
87 FIXED 6 Drop item Sent when a player wants to drop an item onto the ground.
95 FIXED 3 Privacy options Sent when a player changes their privacy options (i.e. public chat).
98 VARIABLE_BYTE N/A Walk on command Sent when the player should walk somewhere according to a certain action performed, such as clicking an object.
101 FIXED 13 Design screen Sent when a player is choosing their character design options.
103 VARIABLE_BYTE N/A Player command Sent when the player enters a command in the chat box (e.g. "::command")
117 FIXED 6 Bank 5 items Sent when a player banks 5 of a certain item.
121 FIXED 0 Loading finished Sent when the client finishes loading a map region.
122 FIXED 6 Item action 1 Sent when the player clicks the first option of an item, such as "Bury" for bones.
126 VARIABLE BYTE N/A Private message Sent when a player sends a private message to another player.
129 FIXED 6 Bank all items Sent when a player banks all of a certain item that they have in their inventory.
130 FIXED 0 Close window Sent when a player presses the close, exit or cancel button on an interface.
132 FIXED 6 Object action 1 Sent when the player clicks the first option of an object, such as "Cut" for trees.
133 FIXED 8 Add ignore Sent when a player adds a player to their ignore list.
135 FIXED 6 Bank X items part-1 Sent when a player requests to bank an X amount of items.
139 FIXED 2 Trade answer Sent when a player answers a trade request from another player.
145 FIXED 6 Unequip item Sent when a player unequips an item.
155 FIXED 2 NPC action 1 Sent when a player clicks first option of an NPC, such as "Talk."
164 VARIABLE_BYTE N/A Regular walk Sent when the player walks regularly.
185 FIXED 2 Button click Sent when a player clicks an in-game button.
188 FIXED 8 Add friend Sent when a player adds a friend to their friend list.
192 FIXED 12 Item on object Sent when a a player uses an item on an object.
202 FIXED 0 Idle logout Sent when the player has become idle and should be logged out.
208 FIXED 4 Bank X items part-2 Sent when a player enters an X amount of items they want to bank.
210 FIXED 0 Region change Sent when a player enters a new map region.
214 FIXED 7 Move item Sent when a player moves an item from one slot to another.
215 FIXED 8 Remove friend Sent when a player removes a friend from their friend list.
218 FIXED 8 Report player Sent when a player reports another player.
236 FIXED 6 Pickup ground item Sent when the player picks up an item from the ground.
237 FIXED 8 Magic on items Sent when a player casts magic on the items in their inventory.
241 FIXED 4 Mouse click Sent when the player clicks somewhere on the game screen.
248 VARIABLE_BYTE N/A Map walk Sent when the player walks using the map. Has 14 additional (assumed to be anticheat) bytes added to the end of it that are ignored.
252 FIXED 6 Object action 2 Sent when the player clicks the second option available for an object.
Retrieved from "https://old.runewiki.org/index.php?title=317_Protocol&oldid=1219"