rswiki-book/135-Protocol.mediawiki

[[Category RSC]]
This page refers to the RSC #135 client revision. You can find a partially refactored RSC #135 client [https://bitbucket.org/_mthd0/rsc here].

== '''Packet structure''' ==

<pre>byte tempbuf[];
if (in.available() >= 2) {
    len = in.read();
    if (len >= 160)
        len = (len - 160) * 256 + in.read();
}
if (len > 0 && in.available() >= len) {
    if (len >= 160) {
        opcode = in.read() & 0xff;
        len--;
        tempbuf = new byte[len];
        in.read(tempbuf, 0, len);
        put(tempbuf);
    } else {
        byte lastbyte = (byte) in.read();
        len--;
        if (len > 0) {
            opcode = in.read() & 0xff;
            len--;
            tempbuf = new byte[len];
            in.read(tempbuf, 0, len);
            put(tempbuf);
            put(lastbyte);
        } else {
            opcode = (lastbyte & 0xff);
        }
    }
}
</pre>

RSC-135 uses big-endian byte order exclusively.

== '''Reference''' ==
Player usernames are encoded and decoded with the following methods:

<pre>public static long encode_37(String s) {
    String s1 = "";
    for (int i = 0; i < s.length(); i++) {
        char c = s.charAt(i);
        if (c >= 'a' && c <= 'z')
            s1 = s1 + c;
        else if (c >= 'A' && c <= 'Z')
            s1 = s1 + (char) ((c + 97) - 65);
        else if (c >= '0' && c <= '9')
            s1 = s1 + c;
        else
            s1 = s1 + ' ';
    }
    s1 = s1.trim();
    if (s1.length() > 12)
        s1 = s1.substring(0, 12);
    long l = 0L;
    for (int j = 0; j < s1.length(); j++) {
        char c1 = s1.charAt(j);
        l *= 37L;
        if (c1 >= 'a' && c1 <= 'z')
            l += (1 + c1) - 97;
        else if (c1 >= '0' && c1 <= '9')
            l += (27 + c1) - 48;
    }
    return l;
}

public static String decode_37(long l) {
    String s = "";
    while (l != 0L) {
        int i = (int) (l % 37L);
        l /= 37L;
        if (i == 0) {
            s = " " + s;
        } else if (i < 27) {
            if (l % 37L == 0L)
                s = (char) ((i + 65) - 1) + s;
            else
                s = (char) ((i + 97) - 1) + s;
        } else {
            s = (char) ((i + 48) - 27) + s;
        }
    }
    return s;
}
</pre>

== '''Login''' ==
* The username and password are prepared. This is done by replacing any spaces or illegal characters with _ and appending spaces to the string until its length is 20.
* The connection with the server is established.
* The client reads a raw long from the server, this is the "session id".
* The client creates a new frame, opcode 0 or 19 if the player is reconnecting.
* A short, the client's revision number (135) is placed in the buffer.
* A long, the player's username encoded with mod37 (see above) is placed in the buffer.
* A string encoded with RSA and the player's session id (the password) is placed in the buffer.
* An integer, the player's "ranseed" value is placed in the buffer.
** "ranseed" does not seed anything. RSC135 does not use ISAAC ciphering. It is an applet parameter or read from uid.dat. Presumably, it was used to identify players connecting from the same computer.
* The stream is then flushed.
* A byte is read from the stream and discarded.
* Another byte is read, this is the login response code from the server.

{| class="wikitable"
|-
! Login Resp.
! Description
|-
| 0
| Successful login
|-
| 1
|?
|-
| 3
| Invalid username or password
|-
| 4
| Username already in use
|-
| 5
| Client has been updated
|-
| 6
| IP address is already in use
|-
| 7
| Login attempts exceeded
|-
| 11
| Account temporarily disabled
|-
| 12
| Account permanently disabled
|-
| 15
| Server is currently full
|-
| 16
| Members-only server
|-
| 17
| Members-only area?
|}

== '''Registration''' ==

* The username and password are prepared. This is done by replacing any spaces or illegal characters with _ and appending spaces to the string until its length is 20.
* The connection with the server is established.
* The client reads a raw long from the server, this is the "session id".
* The client creates a new frame, opcode 2.
* A short, the client's revision number (135) is placed in the buffer.
* A long, the player's username encoded with mod37 (see above) is placed in the buffer.
* A short, the applet's "referid" parameter is placed in the buffer.
* A string encoded with RSA and the player's session id (the password) is placed in the buffer.
* An integer, the player's "ranseed" value is placed in the buffer.
** "ranseed" does not seed anything. RSC135 does not use ISAAC ciphering. It is an applet parameter or read from uid.dat. Presumably, it was used to identify players connecting from the same computer.
* The stream is then flushed.
* A byte is read from the stream and discarded.
* Another byte is read, this is the newplayer response code from the server.

{| class="wikitable"
|-
! Newp Resp.
! Description
|-
| 2
| Successful registration
|-
| 3
| Username already taken
|-
| 5
| Client has been updated
|-
| 6
| IP address is already in use
|-
| 7
| Registration attempts exceeded?
|}

== '''Packets''' ==
The packet opcodes are unchanged from previous revisions, presumably this was before the protocol was being regularly modified to deter the developers of bots such as [[AutoRune]]. The payload/structure is quite similar to most other RSC revisions.

=== '''Incoming Data''' ===
'''TODO:'''
{| class="wikitable"
|-
! Name
! Opcode
! Payload
! Description
|-
! Display Message
| 8 ||
* ?
| ?
|-
! Close Connection
| 9 ||
* ?
| ?
|-
! Logout Failed
| 10 ||
* ?
| ?
|-
! Initialize Friends List
| 23 ||
* ?
| ?
|-
! Update Friends List
| 24 ||
* ?
| ?
|-
! Ignore List
| 26 ||
* ?
| ?
|-
! Initialize Privacy Settings
| 27 ||
* ?
| ?
|-
! Private Message
| 28 ||
* ?
| ?
|-
! Player Positions
| 255 ||
* ?
| ?
|-
! Ground Item Positions
| 254 ||
* ?
| ?
|-
! Object Positions
| 253 ||
* ?
| ?
|-
! Whole Inventory
| 252 ||
* ?
| ?
|-
! Players (Appearance)
| 250 ||
* ?
| ?
|-
! Boundary Positions
| 249 ||
* ?
| ?
|-
! NPC Positions
| 248 ||
* ?
| ?
|-
! NPCs (Appearance)
| 247 ||
* ?
| ?
|-
! Display Dialog
| 246 ||
* ?
| ?
|-
! Hide Dialog
| 245 ||
* ?
| ?
|-
! Initialize World
| 244 ||
* ?
| ?
|-
! All Skills
| 243 ||
* ?
| ?
|-
! Equipment Bonuses
| 242 ||
* ?
| ?
|-
! Player Death
| 241 ||
* ?
| ?
|-
! Update Environment
| 240 ||
* ?
| ?
|-
! Display Character Design
| 239 ||
* ?
| ?
|-
! Display Trade Offer
| 238 ||
* ?
| ?
|-
! Hide Trade
| 237 ||
* ?
| ?
|-
! Update Trade Offer
| 236 ||
* ?
| ?
|-
! Other's Trade Status
| 235 ||
* ?
| ?
|-
! Display Shop
| 234 ||
* ?
| ?
|-
! Hide Shop
| 233 ||
* ?
| ?
|-
! Our Trade Status
| 229 ||
* ?
| ?
|-
! Init Game Settings
| 228 ||
* ?
| ?
|-
! Set Prayers
| 227 ||
* ?
| ?
|-
! Set Quests
| 226 ||
* ?
| ?
|-
! Display Bank
| 222 ||
* ?
| ?
|-
! Hide Bank
| 221 ||
* ?
| ?
|-
! Bank Update
| 214 ||
* ?
| ?
|-
! Single XP Update
| 220 ||
* ?
| ?
|-
! Update InvItem
| 213 ||
* ?
| ?
|-
! Remove InvItem
| 212 ||
* ?
| ?
|-
! Single Skill Update
| 211 ||
* ?
| ?
|-
|}

=== '''Outgoing Data''' ===
'''TODO: Password recovery & recovery questions, 254'''
{| class="wikitable"
|-
! Name
! Opcode
! Payload
! Description
|-
! Disconnect
| 1 ||
* None
| Sends the disconnect packet
|-
! Newplayer (Registration)
| 2 ||
* Short - The client's revision number (135)
* Long - Long representation of the username
* Short - Referrer ID
** Integer.parseInt(getParameter("referrerid"));
* Line-RSA - Password, server session ID, bigintegers
* Int - The "ranseed" value
| Registers a new user.
|-
! Login
| 0 ||
* Short - The client's revision number (135)
* Long - Long representation of the username
* Line-RSA - Password, server session ID, bigintegers
* Int - The "ranseed" value
| Logs the player in.
|-
! Reconnect
| 19 ||
* Same as 0
| Reconnects the player after they are disconnected.
|-
! Logout
| 6 ||
* None
| Sends the logout packet to the server
|-
! Admin Command
| 7 ||
* String - The command
| Sends a command to the server to be executed
|-
! Report Abuse
| 10 ||
* Long - The long representation of the username to report
| Sends an abuse report to the server
|-
! Add Friend
| 26 ||
* Long - long representation of username
| Adds a user to your friends list
|-
! Remove Friend
| 27 ||
* Long - The long representation of the username to report
| Removes a user from your friends list
|-
! Send Message
| 28 ||
* Long - The long representation of the username to send the message to
* String - The message
| Sends a message to the specified user
|-
! Ignore User
| 29 ||
* Long - The long representation of the username to ignore
| Adds a user to your ignore list
|-
! Walk to Tile
| 255 ||
* Short - (start_x + area_x). The initial position.
* Short - (start_y + area_y)
* Byte... - (route_x[i] - start_x)
* Byte... - (route_y[i] - start_y)
| Variable length. Walks to a tile. The number of steps can be calculated by dividing the available data by 2.
|-
! Walk to Entity
| 215 ||
* The same as 255.
| Variable length. Walks to an entity. The number of steps can be calculated by dividing the available data by 2.
|-
! Acknowledge Players
| 254 ||
* Short - Size?
* Short... - The player's server index
* Short... - ???
| Variable length. Informs the server of new players. Why?
|-
! Drop Item
| 251 ||
* Short - The slot of the item to drop
| Drops the specified item on the ground
|-
! Cast on Item
| 220 ||
* Short - The slot of the item to cast a spell on
* Short - The id of the spell to cast
| Casts a spell (such as High Alchemy) on the specified item
|-
! Use with Item
| 240 ||
* Short - The slot of the first item to use
* Short - The slot of the second item to use
| Uses an item in the player's inventory with another item in the player's inventory
|-
! Remove Item
| 248 ||
* Short - The slot of the item to unequip
| Unequips the specified inventory item
|-
! Wear Item
| 249 ||
* Short - The slot of the item to equip
| Equips the specified inventory item
|-
! Item Command
| 246 ||
* Short - The slot of the item to use
| Buries, eats, etc the specified inventory item
|-
! Select Option
| 237 ||
* Byte - The position of the option in the dialog_options array
| Selects an option in a dialog (dialog referring to, for example, the menu displayed when certing)
|-
! Combat Style
| 231 ||
* Byte - The position of the combat style in the list
| Sets the player's combat style.
* 0 - Controlled 
* 1 - Aggressive
* 2 - Accurate
* 3 - Defensive
|-
! Close Bank
| 207 ||
* None
| Informs the server that the player has closed the banking interface.
|-
! Withdraw Item
| 206 ||
* Short - The ID of the item to withdraw
* Short - The amount of the specified item to withdraw
| Withdraws a single type of item from the player's bank.
|-
! Deposit Item
| 205 ||
* Short - The ID of the item to deposit
* Short - The amount of the specified item to deposit
| Deposits a single type of item into the player's bank.
|-
! Disable Prayer
| 211 ||
* Byte - The ID of the prayer to disable
| Disables a prayer.
|-
! Enable Prayer
| 212 ||
* Byte - The ID of the prayer to enable
| Enables a prayer.
|-
! Confirm Trade
| 202 ||
* None
| Confirms the trade offer.
|-
! Accept Trade
| 232 ||
* None
| Accepts the trade offer.
|-
! Decline Trade
| 233 ||
* None
| Declines the trade offer.
|-
! Trade Update
| 234 ||
* Byte - The amount of traded items to send to the server
* Short... - The id of the item
* Int... - The amount/stack size of the item
| Variable length. Updates the trade offer.
|-
! Cast on GItem
| 224* ||
* Short - The item's X coordinate
* Short - The item's Y coordinate
* Short - The item's ID
* Short - The spell's ID
| Casts a spell on an item on the ground.
|-
! Use with GItem
| 250* ||
* Short - The item's X coordinate
* Short - The item's Y coordinate
* Short - The item's ID
* Short - The inventory slot
| Uses an item in the player's inventory with an item on the ground.
|-
! Take GItem
| 252* ||
* Short - The item's X coordinate
* Short - The item's Y coordinate
* Short - The item's ID
| Picks up an item on the ground.
|-
! Cast on Boundary
| 223* ||
* Short - The bound's X coordinate
* Short - The bound's Y coordinate
* Byte - The bound's direction
* Short - The spell's ID
| Casts a spell on a boundary (or 'wall object').
|-
! Use with Boundary
| 239* ||
* Short - The bound's X coordinate
* Short - The bound's Y coordinate
* Byte - The bound's direction
* Short - The inventory slot
| Uses an item in the player's inventory with a boundary (or 'wall object').
|-
! Boundary Cmd 1
| 238* ||
* Short - The bound's X coordinate
* Short - The bound's Y coordinate
* Byte - The bound's direction
| Performs the primary action (usually 'open') on a boundary (or 'wall object').
|-
! Boundary Cmd 2
| 229* ||
* Short - The bound's X coordinate
* Short - The bound's Y coordinate
* Byte - The bound's direction
| Performs the secondary action (usually 'close' or 'picklock') on a boundary (or 'wall object').
|-
! Cast on Object
| 222* ||
* Short - The object's X coordinate
* Short - The object's Y coordinate
* Short - The spell's ID
| Casts a spell on an object. Unused?
|-
! Use with Object
| 241* ||
* Short - The object's X coordinate
* Short - The object's Y coordinate
* Short - The inventory slot
| Uses an item in the player's inventory with an object.
|-
! Object Cmd 1
| 241* ||
* Short - The object's X coordinate
* Short - The object's Y coordinate
| Performs the primary action on an object (for example, 'mine').
|-
! Object Cmd 2
| 230* ||
* Short - The object's X coordinate
* Short - The object's Y coordinate
| Performs the secondary action on an object (for example, 'prospect').
|-
! Cast on NPC
| 225* ||
* Short - The NPC's server index
* Short - The spell's ID
| Casts a spell on a non-player character.
|-
! Use with NPC
| 243* ||
* Short - The NPC's server index
* Short - The inventory slot
| Uses an item in the player's inventory with a non-player character. 
|-
! Talk to NPC
| 245* ||
* Short - The NPC's server index
| Starts talking to a non-player character.
|-
! Attack NPC
| 244* ||
* Short - The NPC's server index
| Starts attacking a non-player character.
|-
! NPC Cmd 2
| 195* ||
* Short - The NPC's server index
| Performs the secondary action on a non-player character, usually 'pickpocket'.
|-
! Cast on Player
| 226* ||
* Short - The player's server index
* Short - The spell's ID
| Casts a spell on another player.
|-
! Use with Player
| 219* ||
* Short - The player's server index
* Short - The inventory slot
| Uses an item (for example, a Gnomeball, or a Christmas cracker) on another player.
|-
! Attack Player
| 228* ||
* Short - The player's server index
| Starts attacking another player.
|-
! Trade Player
| 235 ||
* Short - The player's server index
| Sends a trade request to another player.
|-
! Follow Player
| 214 ||
* Short - The player's server index
| Starts following another player.
|-
! Duel Player
| 204 ||
* Short - The player's server index
| Sends a duel request to another player.
|-
! RuntimeException
| 17 ||
* String - The text of the error.
| Sent when the client throws an exception while processing data sent by the server.
|-
! Confirm Duel Offer
| 198 ||
* None
| Confirms the duel offer.
|-
! Accept Duel Offer
| 199 ||
* None
| Accepts the duel offer.
|-
! Duel Settings
| 200 ||
* Byte - No retreating, 0 or 1
* Byte - No magic, 0 or 1
* Byte - No prayers, 0 or 1
* Byte - No weapons, 0 or 1
| Updates the duel settings.
|-
! Duel Items
| 201 ||
* Byte - The total number of offered items
* Short... - Offered item ID
* Int... - Offered item stack size
| Variable length. Updates the stake.
|-
! Decline Duel Offer
| 203 ||
* None
| Declines the duel offer.
|-
! Character Design
| 236 ||
* Byte - The player's gender - 2=Female, 1=Male
* Byte - The player's hair style
* Byte - The player's 'body type' - 4=Female, 1=Male
* Byte - The player's 'leg type' - Always 2
* Byte - The player's hair colour
* Byte - The player's top colour
* Byte - The player's leg colour
* Byte - The player's skin colour
* Byte - The player's class
| Submits the player's chosen design when they log in for the first time.
* 0 - Adventurer class
* 1 - Warrior class
* 2 - Wizard class
* 3 - Ranger class
* 4 - Miner class
|}

Notes:

* Opcodes marked with * are preceded by Walk to Entity.
* When closing the duel confirm screen, it may send the decline trade packet, for some reason.