rswiki-book/src/317/317-Protocol.md

567 lines
37 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# 317 Protocol
## Packet structure
When the client sends a packet to the server, the first byte encapsulates its [opcode](http://en.wikipedia.org/wiki/Opcode).
This specific opcode is encrypted with a value generated by the [ISAAC](http://en.wikipedia.org/wiki/ISAAC_(cipher)) [PRNG](http://en.wikipedia.org/wiki/Pseudorandom_number_generator), seeded with a dynamically server generated key during the login block.
The server decrypts it and associates the opcode to the packet's respective predefined size.
If the packet does not contain a fixed size, the opcode will be followed by either a byte or a word - varying per packet - for its proper size.
This is then followed by the [payload](http://en.wikipedia.org/wiki/Payload_(software)).
## Login Protocol Overview
Every connection to the main 'gateway' server sends a single byte of data, mostly well known as the connection type.
The connection type tells the main server which type of connection you wish to initiate.
The old engine list consists of:
| ID | Description |
|--|--|
| 14 | Login request |
| 15 | Update |
| 16 | New connection login |
| 18 | Reconnecting login |
The connection type we will cover in the following paragraphs is the login connection type, 14. After the login handshake initiating connection type, the client writes hash derived from the logging in player's username.
This is believed to help select the appropriate login server.
On successful handshake, the server sends back 8 ignored bytes.
```java
long encodedUsername = encode_base37(username);
int usernameHash = (int) (encodedUsername >> 16 & 31L);
out.offset = 0;
out.writeByte(14); // Connection type
out.writeByte(usernameHash);
in.queueBytes(2, out.payload);
for (int j = 0; j < 8; j++)
in.read();
```
At this point, the client reads in one byte, called the status code. The
status code 0 is expected to start the login protocol correctly. If the
status code is 0, the client reads a long, dubbed by many as the server
session key. This is used to help generate a unique seed for the client
session's packet opcode masking. The client then stores two ints that
are the upper and lower ints of the client session key, which has the
same purpose as the server's key. The client then starts writing the
login block, which is RSA encrypted.
The login block starts with the byte 10, which is considered a magic
number. Following it is the client session key and server session key
longs. After the session keys, the session's UID (unique identifier or
user identifier) is written to the block. This is used to distinguish
between multiple sessions. Trailing behind the UID comes the client's
username and password written as modified C-strings that are rather
terminated with a 10 byte than a NULL byte. This block is then RSA
encrypted and stored for later use.
Now starts the login request packet. It starts off with a flag telling
the server whether or not the client is reconnecting or connecting for
the first time. The byte is 18 or 16, respectively. \[NOW CLASSIFIED AS
A CONNECTION TYPE\] Following is the size of the rest of the login
response packet, including the login block that trails at the end, to
tip the server how much data it should expect. Later comes the magic
number byte 255, and right behind it the client revision short. The
packet is just about crafted completely. A flag byte that represents if
the client is running in low memory or high memory modes is sent, and
after the 9 CRC32 checksums of the file system 0 basic archives (this
includes versionlist, media, config, etc.). To top it off, the RSA
encrypted login block is appended to the end and the packet is sent to
the server.
The ISAAC ciphers are seeded for packet opcode masking after adding 50
to each int of the session keys, and the status code is reread. This
finishes the login protocol.
## Login Protocol Breakdown
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.
**Server Session Key**:
The server-session-key is one of two seeds used to encrypt the game protocol communications, using the ISAAC algorithm instances.
**Data File Version**:
The CRC checks for the cache files.
**User ID**:
A client-side randomly generated integer.
This could be used in reassigning sessions to players that have lost connection.
It is stored as a packed integer in a file named 'uid.dat' in the cache directory.
**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 seeds used to encrypt the game protocol communications, using the ISAAC algorithm instances.
**Connect Status**: The status of the connection (16 if new, 18 if reconnecting).
**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 (0 if low-memory client, 1 if high-memory client).
**CRC Values**: Nine 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 privilege status - regular (0), player moderator (1), or administrator (2).
**Flagged**: If set to 1, information about mouse movements etc. are sent to the server.
Suspected bot accounts are flagged.
**Response Codes**:
At the beginning and 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. Please 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 regarding login response code 15 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 sends byte 18 as it's
*Connect Status* 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 poor connection you've
noticed that your chat stays there upon a reconnect, and this is exactly why.
When you implement response code 15 though, you do NOT need to send the "player status" or the "flagged" bytes.
## Login Process
### Stage 1: Client -> Server
| Data Type | Value |
|--|--|
| Unsigned [Byte](/Data-Types.html#common-data-types) | 14 |
| Unsigned [Byte](/Data-Types.html#common-data-types) | "name hash" |
### Stage 2: Server -> Client
| Data Type | Value |
|--|--|
| [Byte](/Data-Types.html#common-data-types) | 0 |
| [Byte](/Data-Types.html#common-data-types) | 0 |
| [Byte](/Data-Types.html#common-data-types) | 0 |
| [Byte](/Data-Types.html#common-data-types) | 0 |
| [Byte](/Data-Types.html#common-data-types) | 0 |
| [Byte](/Data-Types.html#common-data-types) | 0 |
| [Byte](/Data-Types.html#common-data-types) | 0 |
| [Byte](/Data-Types.html#common-data-types) | 0 |
| [Byte](/Data-Types.html#common-data-types) | "response code" |
| [Long](/Data-Types.html#common-data-types) | Server session key |
### Stage 3: Client -> Server
| Data Type | Value |
|--|--|
| [Byte](/Data-Types.html#common-data-types) | Connect status |
| [Byte](/Data-Types.html#common-data-types) | Size |
| [Byte](/Data-Types.html#common-data-types) | 255 |
| [Short](/Data-Types.html#common-data-types) | 317 (Client version) |
| [Int](/Data-Types.html#common-data-types) | crc values [0] |
| [Int](/Data-Types.html#common-data-types) | crc values [1] |
| [Int](/Data-Types.html#common-data-types) | crc values [2] |
| [Int](/Data-Types.html#common-data-types) | crc values [3] |
| [Int](/Data-Types.html#common-data-types) | crc values [4] |
| [Int](/Data-Types.html#common-data-types) | crc values [5] |
| [Int](/Data-Types.html#common-data-types) | crc values [6] |
| [Int](/Data-Types.html#common-data-types) | crc values [7] |
| [Int](/Data-Types.html#common-data-types) | crc values [8] |
| [Byte](/Data-Types.html#common-data-types) | 10 |
| [Long](/Data-Types.html#common-data-types) | Client session key |
| [Long](/Data-Types.html#common-data-types) | Server session key |
| [Int](/Data-Types.html#common-data-types) | User id |
| [RS String](/RS-String.html) | Username |
| [RS String](/RS-String.html) | Password |
### Stage 4: Server -> Client
| Data Type | Value |
|--|--|
| [Byte](/Data-Types.html#common-data-types) | Response code |
| [Byte](/Data-Types.html#common-data-types) | Player status |
| [Byte](/Data-Types.html#common-data-types) | Flagged |
### Player Updating
The player updating process consists of 4 parts:
a. Our player movement updates
b. Other player movement updates
c. Player list updating
c.a. Apperance updating
c.b. Location updating
d. Player update block flag-based updates
### Our player movement updates
The client begins by reading 1 bit. This bit tells the client whether or
not it is currently updating 'our player', or the player the client is
controlling.
If it's not updating our player, it exits and goes onto step b.
If it is, it then reads 2 bits. The value is called the movement update type.
There are 4 recognized movement update types:
* Type 0 basically tells the client there is nothing to update for our player, just add its index to the local updating list.
* Type 1 tells the client you moved in one direction.
The client reads 3 bits, which represents the direction you moved in, and then 1 bit, which states whether further update is required.
If so, it adds it to the updating list. This is used in walking.
* Type 2 functions in much of the same way as its previous, only this time it reads two 3 bit values. The first represents the player's last direction, and the second it's current direction.
Trailing behind it is also the 1 bit 'update required' flag as type 1. This is used in running.
* Type 3 on the other hand is different.
It reads in 2 bits which represents our player's plane, or its level of height, in the game world.
Only 0-3 inclusive are appropriate planes supported by the client. It
then reads 1 bit, which describes whether or not to clear the
awaiting-waypoint queue, basically to stop client from further queued
stepping, such as used in teleporting. After this, it reads the 'update
required' bit, and checks to see if further update is required. Directly
after, it reads two 7 bit quantities, representing the new relative X
and relative Y coordinates of our player to our current map region's
origin. It then sets our players position to the plane, x, and y
positions as told to.
### Other player movement updates
The client begins by reading an 8 bit value telling the client how many
players there are to update. It then enters a loop for each player there
is to update.
Inside this loop, the client reads 1 bit. This is the movement update
required flag. If the flag is 0, it sets the current updating player's
last update cycle time to the current game logic loop cycle time, and
adds the player to the local player list. If the flag is not 0, it then
reads the movement update type, which is a 2 bit quantity.
The following known types are:
* 0, the client updates the current player's last update cycle time, adds the current player to the local player list, and adds it to the updating list.
* 1, the client updates the current player's last update cycle time and adds the current player to the local player list as well, but also reads in 3 bit quantity.
This represents the current player's direction it walked to.
It then reads the a 1 bit value that specifies whether or not to add the player to the updating list.
* 2, the client does the exact same thing as the type 2 update, except it reads in two of the 3 bit quantities.
The first represents the current player's last direction, and the second its current direction running.
* 3, the client queues to remove the player from the list of players to be updated but it is possible such as in the instances for when players teleport to add them back to the list of players to be updated during the populate update.
### Player list updating
The next step in the player updating procedure is the player list
updating, or where the client recieves data on every player in its local
list, such as appearance and location relative to ours. The client loops
through a process for each player in the updating.
The client reads an 11 bit quantity from the buffer, which is the next
player in the updated list to be informed about. The clietn then checks
if it has a cached buffer for that player's updating, and if it does, it
updates the player appearance.
### Appearance updating
Appearance updating starts off by first reading an unsigned byte that
represents the current player's gender. Then it reads another unsigned
byte that represents the player's over-head icon id. This is used with
prayer icons above heads. Next, a loop occurs 12 times to read equipment
data.
In the loop, the client reads an unsigned byte that is the equipment
slot's item id high byte. If it is 0, the player's equpment slot has no
item. If it is not 0, another unsigned byte is read the merged with the
previous to create the equipment's item id. If the id is 65535 (written
as a -1 signed short), then the player's appearance is that of an NPC.
The client reads in an unsigned short representing the NPC's id and sets
the player's definition to that NPC's.
After the equipment loop, it loops 5 times, once for each type of
coloured body part. In each loop, the client reads an unsigned short and
assigns it as the color of the current loop idx (which represents the
body part).
Finally, after the color loop, the client reads 7 unsigned shorts representing animation indices; the animations belong to:
* Standing still
* Turning while standing
* Walking
* Turning around (backwards)
* Turning a quarter-way clockwise
* Turning a quarter-way counter clockwise
* Running
After these animation indices are read, a long representing the player's
name is read, an unsigned byte representing the combat level, and an
unsigned short representing the players skill level (for things where
players arent ranked by levels, such as where it states
`<player name> (skill <skill>)` as an action menu text).
### Location updating
After the appearance updating, the client starts to update that player's
location relative to our player. The player is added to the local player
list and it's last update cycle time. It then reads a 1 bit quantity
that defines whether or not the client has a chunk in the player update
block list. If it does, it adds it to the updating list. The next bit
states whether or not to discard the awaiting-waypoint queue, such as
when teleporting. It then reads to 5 bit values that determine the
players relative X and Y coordinates to our player. The local player
area is 16x16, so if the delta of the two coordinates is \> 15, 32 is
subtracted from it to signify the player is on the other side of ours.
The client then sets the player's position, ending the player list
updating process.
#### Update block flag-based updating
The following is what most people think of when they say 'update mask'
and 'update flag'. This process of the updating procedure is very
important. It begins with looping through ALL players in the local
player update list, reading an unsigned byte which from now on will be
called the update flag. All further updates are seen to be 'included' by
comparing a bitwise mask to this flag. If the flag has the bits for 0x40
all on, this signifies that the flag was too large for a simple unsigned
byte and reads in another unsigned byte, which it uses as the upper
unsigned byte, therefore the update flag is an unsigned little-endian
short. The client then passes off the data to a helper method which
processes all updates this flag signifies.
Inside this method, many different bitwise masks are compared to the
player's flag, and if the mask is set, logic is performed. These masks
are frequently called update masks. A list of player update masks are
below:
* **0x400**: The 0x400 mask is used to update the player so they
appear to be asynchronously animating and walking. This mask is
often used for the [Agility](http://runescape.wikia.com/wiki/Agility) skill.
The data associated goes in order of: byte (type C)
which is the first location's X coordinate value, byte (type S)
which is the first location's Y coordinate value, byte (type S)
which is the second location's X coordinate value, byte (type C) the
second location's Y coordinate value. After the locations are
written, there is a required movement speed which is written as a
short which marks how fast to move from position 1 to position 2.
Another short (type A) is written as the movement speed going from
position 2 to position 1. Finally one byte is written to end the
mask block, which marks the direction.
* **0x100**: The 0x100 mask is responsible for player graphics
updating. The data associated is a little-endian unsigned short
which represents the graphics id, and an int which is the graphics
delay.
* **0x8**: Animations are handled by the 0x8 mask. The payload for
this update is a little-endian unsigned short that is the animation
id, and an unsigned inversed byte (Special C) which states the
animation's delay.
* **0x4**: The beloved 0x4 mask takes care of forced player text that
is only displayed above the player's model. The only data associated
with this is a jagex ASCII string with a terminator of 10.
* **0x80**: Unlike the previous, the 0x80 mask handles normal player
chat text. The client will read a little-endian unsigned short which
holds chat text attributes. It holds the text color and chat
effects. Next, the client reads an unsigned byte which states the
player's priveleges (normal player, player moderator, moderator,
staff) to give the chatter's name a crown. Right behind it trails an
unsigned inversed byte that gives chat text length in bytes.
Trailing afterwards is dictionary-compressed chat text. All chat
text characters become indexes into a valid character table and are
written as nibbles (4 bit quantities).
* **0x1**: Updating the player's current interacting-entity is done
via mask 0x1. The entity id is written as a little-endian unsigned
short.
* **0x10**: The 0x10 mask updates appearance of the player in exact
same way as in updating player list. Only difference is that
appearance is updated from a set-sized buffer filled from the
current buffer. An unsigned inversed byte is read first which
describes appearance buffer size, and the buffer is filled.
* **0x2**: Facing coordinate updating is signified by the 0x2 mask.
The player's facing-towards X and Y are set to read values;
specifically, an unsigned lower-inverted short and little-endian
unsigned short, respectively.
* **0x20**: Notifying client's of a player's health is done via the
0x20 mask. The hitpoint damage done to the player is sent as an
unsigned byte, followed by the hit type as a positive inverted byte.
The player's current and max health are read as an unsigned inverted
byte and unsigned byte, respectively.
* **0x200**: The 0x200 mask acts in the same way as the 0x20 mask and
is most likely associated with special attacks from weapons that
have the ability to hit twice at the same time. Hitpoint damage is
an unsigned byte, the hit type an unsigned inverted byte, and the
current and maximum health being an unsigned byte and unsigned
inverted byte, respectively.
After the client processes every single player in the update player list, it ends player updating.
## 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](/317/317-Animation-reset.html) | Resets all animations in the immediate area. |
| 4 | FIXED | 6 | [Draw graphic at position](/317/317-Draw-graphic-at-position.html) | Draw a graphic at a given x/y position after a delay. |
| 8 | FIXED | 4 | [Set interface model](/317/317-Set-interface-model.html) | Draw a given model on a given interface. |
| 24 | FIXED | 1 | [Flash sidebar](/317/317-Flash-sidebar.html) | Causes a sidebar icon to start flashing. |
| 27 | FIXED | 0 | [Input amount](/317/317-Input-amount.html) | Displays the "Input amount" interface. |
| 34 | VARIABLE_SHORT | N/A | [Draw items on interface](/317/317-Draw-items-on-interface.html) | Draw a collection of items on an interface. |
| 35 | FIXED | 4 | [Camera shake](/317/317-Camera-shake.html) | Causes the camera to shake. |
| 36 | FIXED | 3 | [Force client setting](/317/317-Force-client-setting.html) | Forcefully changes a client's setting's value. Also changes the default value for that setting. |
| 44 | FIXED | 5 | [Send ground item](/317/317-Send-ground-item.html) | Place an item stack on the ground. |
| 50 | FIXED | 9 | [Send add friend](/317/317-Send-add-friend.html) | Sends a friend to the friend list. |
| 53 | VARIABLE_SHORT | N/A | [Draw items on interface](/317/317-Draw-items-on-interface.html) | Draw a collection of items on an interface. |
| 60 | VARIABLE_SHORT | N/A | [Begin processing position related packets](/317/317-Begin-processing-position-related-packets.html) | Begin processing position related packets. |
| 61 | FIXED | 1 | [Show multi-combat](/317/317-Show-multi-combat.html) | Shows the player that they are in a multi-combat zone. |
| 64 | FIXED | 2 | [Delete ground item](/317/317-Delete-ground-item.html) | Delete ground item. |
| 65 | VARIABLE_SHORT | N/A | [NPC updating](/317/317-NPC-updating.html) | NPC updating |
| 68 | FIXED | 0 | [Reset button state](/317/317-Reset-button-state.html) | Resets the button state for all buttons. |
| 70 | FIXED | 6 | [Interface offset](/317/317-Interface-offset.html) | Sets the offset for drawing of an interface. |
| 71 | FIXED | 3 | [Send sidebar interface](/317/317-Send-sidebar-interface.html) | Assigns an interface to one of the tabs in the game sidebar. |
| 72 | FIXED | 2 | [Clear inventory](/317/317-Clear-inventory.html) | Clears an interface's inventory. |
| 73 | FIXED | 4 | [Load map region](/317/317-Load-map-region.html) | Loads a new map region. |
| 74 | FIXED | 4 | [Play song](/317/317-Play-song.html) | Starts playing a song. |
| 75 | FIXED | 4 | [NPC head on interface](/317/317-NPC-head-on-interface.html) | Place the head of an NPC on an interface |
| 78 | FIXED | 0 | [Reset destination](/317/317-Reset-destination.html) | Resets the players' destination. |
| 79 | FIXED | 4 | [Scroll position](/317/317-Scroll-position.html) | Sets the scrollbar position of an interface. |
| 81 | VARIABLE | N/A | [Begin player updating](/317/317-Begin-player-updating.html) | Begins the player update procedure |
| 84 | FIXED | 7 | [Edit ground item amount](/317/317-Edit-ground-item-amount.html) | Edit ground item amount |
| 85 | FIXED | 2 | [Set local player coordinates](/317/317-Set-local-player-coordinates.html) | Set local player coordinates |
| 87 | FIXED | 7 | [Force client setting](/317/317-Force-client-setting.html) | Forcefully changes a client's setting's value. Also changes the default value for that setting. |
| 97 | FIXED | 2 | [Show interface](/317/317-Show-interface.html) | Displays a normal interface. |
| 99 | FIXED | 1 | [Minimap State](/317/317-Minimap-State.html) | Sets the mini map's state. |
| 101 | FIXED | 3 | [Object removal](/317/317-Object-removal.html) | Sends an object removal request to the client. |
| 104 | VARIABLE | N/A | [Player Option](/317/317-Player-Option.html) | Adds a player option to the right click menu of player(s). |
| 105 | FIXED | 4 | [Play sound in location](/317/317-Play-sound-in-location.html) | Play sound in location. |
| 106 | FIXED | 1 | [Interface over tab](/317/317-Interface-over-tab.html) | Draws an interface over the tab area. |
| 107 | FIXED | 0 | [Reset camera](/317/317-Reset-camera.html) | Resets the camera position. |
| 109 | FIXED | 0 | [Logout](/317/317-Logout.html) | Disconnects the client from the server. |
| 110 | FIXED | 1 | [Run energy](/317/317-Run-energy.html) | Sends the players run energy level. |
| 114 | FIXED | 2 | [System update](/317/317-System-update.html) | Sends how many seconds until a 'System Update.' |
| 117 | N/A | N/A | [Create Projectile](/317/317-Create-Projectile.html) | Creates a projectile. |
| 121 | FIXED | 4 | [Song Queue](/317/317-Song-Queue.html) | Queues a song to be played next. |
| 122 | FIXED | 4 | [Interface color](/317/317-Interface-color.html) | Changes the color of an interface. |
| 126 | VARIABLE_SHORT | N/A | [Set interface text](/317/317-Set-interface-text.html) | Attaches text to an interface. |
| 134 | FIXED | 6 | [Skill level](/317/317-Skill-level.html) | Sends a skill level to the client. |
| 142 | FIXED | 2 | [Show inventory interface](/317/317-Show-inventory-interface.html) | Show inventory interface |
| 147 | FIXED | 14 | [Player to object transformation](/317/317-Player-to-object-transformation.html) | Player to object transformation |
| 151 | FIXED | 5 | [Object spawn](/317/317-Object-spawn.html) | Sends an object spawn request to the client. |
| 156 | FIXED | 3 | [Remove non-specified ground items???](/317/317-Remove-non-specified-ground-items???.html) | Remove non-specified ground items?????? |
| 160 | FIXED | 4 | [Spawn an animated object???](/317/317-Spawn-an-animated-object???.html) | Shows an interface in the chat box?????? |
| 164 | FIXED | 2 | [Chat interface](/317/317-Chat-interface.html) | Shows an interface in the chat box. |
| 166 | FIXED | 6 | [Spin camera](/317/317-Spin-camera.html) | Spin camera |
| 171 | FIXED | 3 | [Hidden Interface](/317/317-Hidden-Interface.html) | Sets an interface to be hidden until hovered over. |
| 174 | FIXED | N/A | [Audio](/317/317-Audio.html) | Sets what audio/sound is to play at a certain time. |
| 176 | FIXED | 10 | [Open welcome screen](/317/317-Open-welcome-screen.html) | Displays the welcome screen. |
| 177 | FIXED | 6 | [Set cutscene camera](/317/317-Set-cutscene-camera.html) | Set cutscene camera |
| 185 | FIXED | 2 | [Player head to interface](/317/317-Player-head-to-interface.html) | Sends the players head model to an interface |
| 187 | FIXED | 0 | [Enter name](/317/317-Enter-name.html) | Displays the "Enter name" interface. |
| 196 | VARIABLE_BYTE | N/A | [Send private message](/317/317-Send-private-message.html) | Sends a private message to another player. |
| 200 | FIXED | 4 | [Interface animation](/317/317-Interface-animation.html) | Sets an interface's model animation. |
| 206 | FIXED | 3 | [Chat settings](/317/317-Chat-settings.html) | Sends the chat privacy settings. |
| 208 | FIXED | 2 | [Walkable interface](/317/317-Walkable-interface.html) | Displays an interface in walkable mode. |
| 214 | VARIABLE_SHORT | N/A | [Send add ignore](/317/317-Send-add-ignore.html) | Sends a ignored player to the ignore list. |
| 215 | FIXED | 7 | [Spawn ground item for all except specified player](/317/317-Spawn-ground-item-for-all-except-specified-player.html) | Spawn ground item for all except specified player |
| 218 | FIXED | 2 | [Open chatbox interface](/317/317-Open-chatbox-interface.html) | Opens an interface over the chatbox. |
| 219 | FIXED | 0 | [Clear screen](/317/317-Clear-screen.html) | Clears the screen of all open interfaces. |
| 221 | FIXED | 1 | [Friends list status](/317/317-Friends-list-status.html) | Friends list load status. |
| 230 | FIXED | 8 | [Interface model rotation](/317/317-Interface-model-rotation.html) | Sets an interface's model rotation and zoom |
| 240 | FIXED | 2 | [Weight](/317/317-Weight.html) | Sends the players weight amount. |
| 241 | VARIABLE_SHORT | N/A | [Construct map region](/317/317-Construct-map-region.html) | Constructs a dynamic map region using a palette of 8*8 tiles. |
| 246 | FIXED | 6 | [Interface item](/317/317-Interface-item.html) | Displays an item model inside an interface. |
| 248 | FIXED | 4 | [Inventory overlay](/317/317-Inventory-overlay.html) | Displays an interface over the sidebar area. |
| 249 | FIXED | 3 | [Initialize player](/317/317-Initialize-player.html) | Sends the player's membership status and their current index on the server's player list. |
| 253 | VARIABLE_BYTE | N/A | [Send message](/317/317-Send-message.html) | Sends a server message (e.g. 'Welcome to RuneScape') or trade/duel request. |
| 254 | VARIABLE_BYTE | N/A | [Display hint icon](/317/317-Display-hint-icon.html) | Displays a hint icon. |
## Client -> Server Packets
| Opcode | Type | Length (bytes) | Name | Description
|--|--|--|--|--|
| 0 | FIXED | 0 | [Idle](/317/317-Idle.html) | Sent when there are no actions being performed by the player for this cycle. |
| 3 | FIXED | 1 | [Focus change](/317/317-Focus-change.html) | Sent when the game client window goes out of focus. |
| 4 | VARIABLE BYTE | N/A | [Chat](/317/317-Chat.html) | Sent when the player enters a chat message. |
| 14 | FIXED | 8 | [Item on player](/317/317-Item-on-player.html) | Sent when a player uses an item on another player. |
| 16 | FIXED | 1 | [Alternate item option 2](/317/317-Alternate-item-option-2.html) | Sent when a player uses an item. This is an alternate item option. |
| 17 | FIXED | 2 | [NPC action 2](/317/317-NPC-action-2.html) | Sent when a player clicks the second option of an NPC. |
| 18 | FIXED | 2 | [NPC action 4](/317/317-NPC-action-4.html) | Sent when a player clicks the fourth option of an NPC. |
| 21 | FIXED | 2 | [NPC action 3](/317/317-NPC-action-3.html) | Sent when a player clicks the third option of an NPC. |
| 25 | FIXED | 10 | [Item on floor](/317/317-Item-on-floor.html) | Sent when a player uses an item on another item thats on the floor. |
| 39 | FIXED | 2 | [Trade answer](/317/317-Trade-answer.html) | Sent when a player answers a trade request from another player. |
| 40 | FIXED | N/A | [NpcDialogue](/317/317-NPC-Dialogue.html) | Sent when a player clicks the "Click here to continue" on any dialogue. |
| 41 | FIXED | 6 | [Equip item](/317/317-Equip-item.html) | Sent when a player equips an item. |
| 43 | FIXED | 6 | [Bank 10 items](/317/317-Bank-10-items.html) | Sent when a player banks 10 of a certain item. |
| 53 | FIXED | 4 | [Item on item](/317/317-Item-on-item.html) | Sent when a player uses an item with another item. |
| 70 | FIXED | 6 | [Object action 3](/317/317-Object-action-3.html) | Sent when the player clicks the third action available for an object. |
| 72 | FIXED | 2 | [Attack (NPC)](/317/317-Attack-(NPC).html) | Sent when a player attacks an NPC. |
| 73 | FIXED | 2 | [Trade request](/317/317-Trade-request.html) | Sent when a player requests a trade with another player. |
| 74 | FIXED | 8 | [Remove ignore](/317/317-Remove-ignore.html) | Sent when a player removes a player from their ignore list. |
| 79 | FIXED | 6 | [Light item](/317/317-Light-item.html) | Sent when a player attempts to light logs on fire. |
| 86 | FIXED | 4 | [Camera movement](/317/317-Camera-movement.html) | Sent when the player moves the camera. |
| 87 | FIXED | 6 | [Drop item](/317/317-Drop-item.html) | Sent when a player wants to drop an item onto the ground. |
| 95 | FIXED | 3 | [Privacy options](/317/317-Privacy-options.html) | Sent when a player changes their privacy options (i.e. public chat). |
| 98 | VARIABLE_BYTE | N/A | [Walk on command](/317/317-Walk-on-command.html) | Sent when the player should walk somewhere according to a certain action performed, such as clicking an object. |
| 101 | FIXED | 13 | [Design screen](/317/317-Design-screen.html) | Sent when a player is choosing their character design options. |
| 103 | VARIABLE_BYTE | N/A | [Player command](/317/317-Player-command.html) | Sent when the player enters a command in the chat box (e.g. "::command") |
| 117 | FIXED | 6 | [Bank 5 items](/317/317-Bank-5-items.html) | Sent when a player banks 5 of a certain item. |
| 121 | FIXED | 0 | [Loading finished](/317/317-Loading-finished.html) | Sent when the client finishes loading a map region. |
| 122 | FIXED | 6 | [Item action 1](/317/317-Item-action-1.html) | Sent when the player clicks the first option of an item, such as "Bury" for bones. |
| 126 | VARIABLE BYTE | N/A | [Private message](/317/317-Private-message.html) | Sent when a player sends a private message to another player. |
| 129 | FIXED | 6 | [Bank all items](/317/317-Bank-all-items.html) | Sent when a player banks all of a certain item that they have in their inventory. |
| 130 | FIXED | 0 | [Close window](/317/317-Close-window.html) | Sent when a player presses the close, exit or cancel button on an interface. |
| 131 | FIXED | 4 | [Mage NPC](/317/317-Mage-NPC.html) | Sent when a player uses magic attacks on an NPC. |
| 132 | FIXED | 6 | [Object action 1](/317/317-Object-action-1.html) | Sent when the player clicks the first option of an object, such as "Cut" for trees. |
| 133 | FIXED | 8 | [Add ignore](/317/317-Add-ignore.html) | Sent when a player adds a player to their ignore list. |
| 135 | FIXED | 6 | [Bank X items part-1](/317/317-Bank-X-items-part-1.html) | Sent when a player requests to bank an X amount of items. |
| 139 | FIXED | 2 | [Follow](/317/317-Follow.html) | Sent when a player clicks the follow option on another player. |
| 145 | FIXED | 6 | [Unequip item](/317/317-Unequip-item.html) | Sent when a player unequips an item. |
| 155 | FIXED | 2 | [NPC action 1](/317/317-NPC-action-1.html) | Sent when a player clicks first option of an NPC, such as "Talk." |
| 164 | VARIABLE_BYTE | N/A | [Regular walk](/317/317-Regular-walk.html) | Sent when the player walks regularly. |
| 185 | FIXED | 2 | [Button click](/317/317-Button-click.html) | Sent when a player clicks an in-game button. |
| 188 | FIXED | 8 | [Add friend](/317/317-Add-friend.html) | Sent when a player adds a friend to their friend list. |
| 192 | FIXED | 12 | [Item on object](/317/317-Item-on-object.html) | Sent when a a player uses an item on an object. |
| 202 | FIXED | 0 | [Idle logout](/317/317-Idle-logout.html) | Sent when the player has become idle and should be logged out. |
| 208 | FIXED | 4 | [Bank X items part-2](/317/317-Bank-X-items-part-2.html) | Sent when a player enters an X amount of items they want to bank. |
| 210 | FIXED | 0 | [Region change](/317/317-Region-change.html) | Sent when a player enters a new map region. |
| 214 | FIXED | 7 | [Move item](/317/317-Move-item.html) | Sent when a player moves an item from one slot to another. |
| 215 | FIXED | 8 | [Remove friend](/317/317-Remove-friend.html) | Sent when a player removes a friend from their friend list. |
| 218 | FIXED | 8 | [Report player](/317/317-Report-player.html) | Sent when a player reports another player. |
| 236 | FIXED | 6 | [Pickup ground item](/317/317-Pickup-ground-item.html) | Sent when the player picks up an item from the ground. |
| 237 | FIXED | 8 | [Magic on items](/317/317-Magic-on-items.html) | Sent when a player casts magic on the items in their inventory. |
| 241 | FIXED | 4 | [Mouse click](/317/317-Mouse-click.html) | Sent when the player clicks somewhere on the game screen. |
| 248 | VARIABLE_BYTE | N/A | [Map walk](/317/317-Map-walk.html) | 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. |
| 249 | FIXED | 4 | [Magic on player](/317/317-Magic-on-player.html) | Sent when a player attempts to cast magic on another player. |
| 252 | FIXED | 6 | [Object action 2](/317/317-Object-action-2.html) | Sent when the player clicks the second option available for an object. |
| 253 | FIXED | 6 | [Ground Item Action](/317/317-Ground-Item-Action.html) | Sent when the player clicks the first option for a ground item (i.e. 'Light Logs') |