3 |
What information do we collect? We collect
4 | information from you when you register on our site or information posted
5 | on our site.
When ordering or registering on our site, as
6 | appropriate, you may be asked to enter your: e-mail address. You may,
7 | however, visit our site anonymously.
What do we use
8 | your information for? Any of the information we
9 | collect from you may be used to improve customer service (your
10 | information helps us to more effectively respond to your customer
11 | service requests and support needs)
How do we protect
12 | your information? We implement a variety of
13 | security measures to maintain the safety of your personal information
14 | when you enter, submit, or access your personal information.
15 |
Do we use cookies? Yes (Cookies
16 | are small files that a site or its service provider transfers to your
17 | computers hard drive through your Web browser (if you allow) that
18 | enables the sites or service providers systems to recognize your browser
19 | and capture and remember certain information
We use cookies
20 | to compile aggregate data about site traffic and site interaction so
21 | that we can offer better site experiences and tools in the
22 | future.
Do we disclose any information to outside
23 | parties? We do not sell, trade, or otherwise
24 | transfer to outside parties your personally identifiable information.
25 | This does not include trusted third parties who assist us in operating
26 | our website, conducting our business, or servicing you, so long as those
27 | parties agree to keep this information confidential. We may also release
28 | your information when we believe release is appropriate to comply with
29 | the law, enforce our site policies, or protect ours or others rights,
30 | property, or safety. However, non-personally identifiable visitor
31 | information may be provided to other parties for marketing, advertising,
32 | or other uses.
33 |
--------------------------------------------------------------------------------
/src/317/317-Camera-shake.md:
--------------------------------------------------------------------------------
1 | # Camera oscillate
2 | Begins camera oscillation, which is implemented using a configurable sinusoidal oscillator to offset a specific degree of freedom.
3 |
4 | ## Packet Details
5 | | Key | Value |
6 | |--|--|
7 | | Name | Camera oscillate |
8 | | Description | Begin camera oscillation. |
9 | | Opcode | 35 |
10 | | Type | Fixed |
11 | | Length | 4 |
12 | | Revision | 317 |
13 |
14 | ## Packet Structure
15 | | Data Type | Description |
16 | |--|--|
17 | | [Byte](/Data-Types.html#common-data-types) | Parameter (camera X, Z, Y, yaw, pitch) |
18 | | [Byte](/Data-Types.html#common-data-types) | Jitter (for randomization) |
19 | | [Byte](/Data-Types.html#common-data-types) | Amplitude |
20 | | [Byte](/Data-Types.html#common-data-types) | Frequency (scaled by 100) |
21 |
22 | ## Other Information
23 | The oscillate event enables the client to oscillate one of 5 of it's position parameters.
24 | i.e. corresponding to the camera's degrees of freedom; parameters 0, 1, and 2 refer to the location of the camera, while 3 and 4 deal with the camera's orientation.
25 | Together, these enable complex effects involving manipulation of the camera position to give rise to simulated earth-quakes and camera shock.
26 |
27 | | Parameter | Description |
28 | |--|--|
29 | | 0 | Camera location along world X axis (a horizontal axis, aligned with map grid X) |
30 | | 1 | Camera location along world Z axis (vertical axis) |
31 | | 2 | Camera location along world Y axis (a horizontal axis, aligned with map grid Y) |
32 | | 3 | Camera orientation in world X plane w.r.t. world Z axis, i.e. yaw |
33 | | 4 | Camera orientation in world Z plane w.r.t. world X axis, i.e. pitch |
34 |
35 | Note there is no built-in way to manipulate camera roll, as this is not one of the camera's degrees of freedom.
36 |
37 | ## What it's doing
38 | Every time the world is rendered, each camera parameter that is enabled for oscillation is offset by a value computed as follows:
39 |
40 | | Calculation | Formula |
41 | |--|--|
42 | | Delta | `(int) ((Math.random() * (double) (jitter * 2 + 1) - (double) jitter) + Math.sin((double) phase * ((double) frequency / 100D)) * (double) amplitude);` |
43 |
44 | Each parameter's phase accumulator (phase) is incremented by 1 each logic update.
45 |
46 | ## Parameter
47 | The offset itself is detailed as follows for each parameter:
48 |
49 | | Parameter | Action |
50 | |--|--|
51 | | 0 | `camera_x += delta` |
52 | | 1 | `camera_z += delta` |
53 | | 2 | `camera_y += delta` |
54 | | 3 | `camera_yaw = camera_yaw + delta & 0x7ff;` |
55 | | 4 | `camera_pitch += delta` |
56 |
57 | Note that the camera's yaw is corrected modulo 0x7ff, or 2048, which is equivalent to 2 \pi radians in Jagex's binary angle system.
58 | This is not done to the camera pitch, which is instead clamped (see below).
59 |
60 | ## Note
61 | For oscillating the camera pitch, clamping is done to ensure the angle not out of bounds:
62 |
63 | ```java
64 | if (camera_pitch < 128)
65 | camera_pitch = 128
66 | if (camera_pitch > 383)
67 | camera_pitch = 383
68 | ```
69 |
70 | This is due to Jagex restricting the possible range of orientations the camera may take.
71 |
--------------------------------------------------------------------------------
/src/718-Protocol.md:
--------------------------------------------------------------------------------
1 | \[\[Category Packet\]\] \[\[Category Packet 718\]\] \[\[Category RS2\]\]
2 |
3 | == '''Packet structure''' == ?
4 |
5 | == '''Login''' == ?
6 |
7 | == '''Game Protocol''' ==
8 |
9 | ===Server -\> Client Packets===
10 |
11 | {
12 | ---
13 |
14 | ! Opcode ! Type ! Length (bytes) ! Name ! Description \|- \| 2 \|
15 | VARIABLE\_SHORT \| -2 \| \[\[718 Friends packet\|Friends packet\]\] \|
16 | Sends a friend to the friend list. \|- \| 5 \| FIXED \| 4 \| \[\[718
17 | Close window\|Close window\]\] \| Closes an interface. \|- \| 6 \| FIXED
18 | \| 1 \| \[\[718 Player under NPC priority\|Player under NPC priority\]\]
19 | \| N/A \|- \| 9 \| FIXED \| 6 \| \[\[718 Music effect\|Music effect\]\]
20 | \| Plays a music effect. \|- \| 10 \| VARIABLE\_BYTE \| -1 \| \[\[718
21 | Set mouse\|Set mouse\]\] \| N/A \|- \| 11 \| FIXED \| -2 \| \[\[718
22 | World list\|World list\]\] \| Sends the world list. \|- \| 14 \| FIXED
23 | \| 23 \| \[\[718 Interface\|Interface\]\] \| Opens an interface. \|- \|
24 | 17 \| VARIABLE\_SHORT \| -2 \| \[\[718 Open URL\|Open URL\]\] \| Opens a
25 | hyperlink. \|- \| 20 \| FIXED \| 16 \| \[\[718
26 | Projectile\|Projectile\]\] \| Plays a projectile. \|- \| 23 \| FIXED \|
27 | 4 \| \[\[718 Player on IComponent\|Music effect\]\] \| N/A \|- \| 25 \|
28 | FIXED \| 1 \| \[\[718 Run energy\|Run energy\]\] \| Sends the run
29 | energy. \|- \| 30 \| VARIABLE\_BYTE \| -1 \| \[\[718 Send friend quick
30 | chat\|Send friend quick chat\]\] \| Sends a friend a quick chat message.
31 | \|- \| 31 \| FIXED \| 8 \| \[\[718 Model on IComponent\|Model on
32 | IComponent\]\] \| Sends a model to an IComponent (child interface). \|-
33 | \| 32 \| FIXED \| -1 \| \[\[718 Receive friend quick chat\|Receive
34 | friend quick chat\]\] \| Displays a received quick chat message to a
35 | friend. \|- \| 33 \| VARIABLE\_BYTE \| -1 \| \[\[718 Receive personal
36 | message\|Receive personal message\]\] \| Received a private message (PM)
37 | and displays it. \|- \| 39 \| FIXED \| 19 \| \[\[718 Game pane\|Game
38 | pane\]\] \| Sends the game pane. \|- \| 40 \| FIXED \| 12 \| \[\[718
39 | IComponent Settings\|IComponent Settings\]\] \| N/A \|- \| 42 \|
40 | VARIABLE\_SHORT \| -2 \| \[\[718 Load map scene\|Load map scene\]\] \|
41 | Loads a map. \|- \| 44 \| FIXED \| 6 \| \[\[718 Shake camera\|Shake
42 | camera\]\] \| Shakes the camera of the character. \|- \| 45 \| FIXED \|
43 | 2 \| \[\[718 Destroy object\|Destroy object\]\] \| Removes an object
44 | from the screen. \|- \| 55 \| VARIABLE\_SHORT \| -2 \| \[\[718
45 | Ignores\|Ignores\]\] \| Sends a player to a player's ignore list. \|-
46 | \|}
47 |
48 | ===Client -\> Server Packets===
49 |
50 | {
51 | ---
52 |
53 | ! Opcode ! Type ! Length (bytes) ! Name ! Description \|- \| 3 \| FIXED
54 | \| 16 \| \[\[718 Item on item\|Item on item\]\] \| Send an item on item
55 | request. \|- \| 4 \| VARIABLE\_BYTE \| -1 \| \[\[718 Add ignore\|Add
56 | ignore\]\] \| Sends a request to add a person to a person's ignore list.
57 | \|- \| 8 \| VARIABLE\_BYTE \| -1 \| \[\[718 Walk\|Walk\]\] \| Sends a
58 | request to walk to specific coordinates. \|- \| 9 \| FIXED \| 3 \|
59 | \[\[718 NPC Examine\|NPC Examine\]\] \| Sends a request to examine an
60 | NPC. \|- \|}
61 |
--------------------------------------------------------------------------------
/src/474-Protocol.md:
--------------------------------------------------------------------------------
1 | \[\[Category Packet\]\] \[\[Category Packet 474\]\] \[\[Category RS2\]\]
2 |
3 | Not much progress has been made with this revision, don't worry about it
4 | too much.
5 |
6 | == '''Packet structure''' == When the client sends a packet to the
7 | server, the first byte encapsulates its opcode. This specific opcode is
8 | encrypted with a value generated by the ISAAC PRNG seeded with a
9 | dynamically server generated key during the login block. The server
10 | decrypts it and associates the opcode to the packet's respective
11 | predefined size. If the packet does not contain a fixed size, the opcode
12 | will be followed by either a byte or a word - varying per packet - for
13 | its proper size. This is then followed by the payload.
14 |
15 | == '''Login''' == ?
16 |
17 | == '''Game Protocol''' ==
18 |
19 | ===Server -\> Client Packets===
20 |
21 | {
22 | ---
23 |
24 | ! Opcode ! Type ! Length (bytes) ! Name ! Description \|- \| 209 \|
25 | VARIABLE\_BYTE \| N/A \| \[\[474 Send message\|Send message\]\] \| Sends
26 | a server message (e.g. 'Welcome to RuneScape') or trade/duel request.
27 | \|- \| 231 \| VARIABLE\_SHORT \| N/A \| \[\[474 Send string\|Send
28 | string\]\] \| Replaces a string of text. (e.g. Replace: 'Click here to
29 | Play' with 'Play Now!') \|- \|}
30 |
31 | ===Client -\> Server Packets===
32 |
33 | {
34 | ---
35 |
36 | ! Opcode ! Type ! Length (bytes) ! Name ! Description \|- \| 1 \| FIXED
37 | \| 8 \| \[\[474 Remove ignore\|Remove ignore\]\] \| Sent when a player
38 | removes a player from their ignore list. \|- \| 3 \| FIXED \| 6 \|
39 | \[\[474 Fourth Interface Option\|Fourth Interface Option\]\] \| This is
40 | triggered when a fourth interface option has been clicked. \|- \| 4 \|
41 | FIXED \| N/A \| \[\[474 Fourth Object Option\|Fourth Object Option\]\]
42 | \| This is triggered when a fourth object option has been clicked. \|-
43 | \| 11 \| FIXED \| N/A \| \[\[474 Minimap Walk\|Minimap Walk\]\] \| Sends
44 | walking data to the server. \|- \| 13 \| FIXED \| 12 \| \[\[474 Item on
45 | NPC\|Item on NPC\]\] \| Sent when a player uses an item on an NPC. \|-
46 | \| 21 \| FIXED \| 2 \| \[\[474 Npc action 2\|Npc action 2\]\] \| Sent
47 | when a player clicks the second option of an NPC. \|- \| 22 \| FIXED \|
48 | N/A \| \[\[474 Kick Clanchat Participant\|Kick Clanchat Participant\]\]
49 | \| Indicates a friend of the clanChat owner attempts to kick a fellow
50 | clanChatParticipant (non-owner). \|- \| 29 \| FIXED \| N/A \| \[\[474
51 | Sixth Interface Option\|Sixth Interface Option\]\] \| Tells the server a
52 | sixth interface option has been clicked. \|- \| 31 \| FIXED \| 6 \|
53 | \[\[474 Object action 1\|Object action 1\]\] \| Sent when the player
54 | clicks the first option of an object, such as "Cut" for trees. \|- \| 34
55 | \| FIXED \| N/A \| \[\[474 Client Focus\|Client Focus\]\] \| Tells the
56 | server the clients focus has changed. \|- \| 35 \| FIXED \| N/A \|
57 | \[\[474 Use Magic On Player\|Use Magic On Player\]\] \| Indicates the
58 | player wants to use a spell on another player. \|- \| 37 \| FIXED \| N/A
59 | \| \[\[474 Third interface option\|Third interface option\]\] \| This is
60 | triggered when one a third interface option has been clicked. \|- \| 203
61 | \| FIXED \| 6 \| \[\[474 Object action 2\|Object action 2\]\] \| Sent
62 | when the player clicks the second option of an object, such as
63 | "Use-quickly" for Bank Booths. \|- \| 34 \| FIXED \| 1 \| \[\[474 Focus
64 | change\|Focus change\]\] \| Sent when the game client window goes out of
65 | focus. \|- \| 35 \| FIXED \| 8 \| \[\[474 Magic on player\|Magic on
66 | player\]\] \| Sent when the player casts magic on another player.\
67 | \|- \| 226 \| FIXED \| 2 \| \[\[474 Examine object\|Examine object\]\]
68 | \| Sent when you examine an object.\
69 | \|- \|}
70 |
--------------------------------------------------------------------------------
/src/377/377-Protocol.md:
--------------------------------------------------------------------------------
1 | \[\[Category Packet\]\] \[\[Category Packet 377\]\] \[\[Category RS2\]\]
2 |
3 | == '''Login Protocol''' ==
4 |
5 | The Login protocol is identical to the \[\[317 Protocol\#Login Protocol
6 | Overview\|317 Login protocol\]\].
7 |
8 | ==Game Protocol== The game protocol is the in-game communication of
9 | player actions between the server and client.
10 |
11 | ===Server -\> Client Packets===
12 |
13 | {
14 | ---
15 |
16 | ! Opcode ! Type ! Length (bytes) ! Name ! Description \|- ! 2 ! FIXED !
17 | 4 ! \[\[377 Interface Animation\|Interface Animation\]\] ! Sets an
18 | interface's model animation. \|- ! 3 ! FIXED ! 6 ! \[\[377 Move
19 | Camera\|Camera Move\]\] ! Moves the camera. \|- ! 5 ! FIXED ! 0 !
20 | \[\[377 Logout\|Logout\]\] ! Disconnects the client from the server. \|-
21 | ! 10 ! FIXED ! 3 ! \[\[377 Send Sidebar Interface\|Send Sidebar
22 | Interface\]\] ! Assigns an interface to one of the tabs in the game
23 | sidebar. \|- ! 13 ! FIXED ! 0 ! \[\[377 Animation Reset\|Animation
24 | Reset\]\] ! Resets all entity animations in the immediate area. \|- ! 18
25 | ! FIXED ! 6 ! \[\[377 Interface Model Rotation\|Interface Model
26 | Rotation\]\] ! Sets the rotation speed of an item in an interface. \|- !
27 | 21 ! FIXED ! 6 ! \[\[377 Interface Item\|Interface Item\]\] ! Displays
28 | an item model inside an interface. \|- ! 26 ! FIXED ! 5 ! \[\[377 Send
29 | Sound\|Send Sound\]\] ! Sends a sound to be played. \|- ! 29 ! FIXED ! 0
30 | ! \[\[377 Reset Open Interfaces\|Reset Open Interfaces\]\] ! Resets all
31 | opened interfaces. \|- ! 40 ! FIXED ! 2 ! \[\[377 Reset Ground Items and
32 | Objects\|Reset Ground Items and Objects\]\] ! Resets all ground items
33 | and objects in a 8x8 region. \|- \|- ! 41 ! FIXED ! 4 ! \[\[377 Play
34 | Ambient Wave\|Play Ambient Wave\]\] ! Plays an ambient wave. \|- ! 49 !
35 | FIXED ! 6 ! \[\[377 Skill Level\|Skill Level\]\] ! Sends a skill level
36 | to the client. \|- ! 50 ! FIXED ! 2 ! \[\[377 Walkable
37 | Interface\|Walkable Interface\]\] ! Displays an interface in walkable
38 | mode. \|- ! 53 ! VARIABLE\_SHORT ! N/A ! \[\[377 Construct Map
39 | Region\|Construct Map Region\]\] ! Constructs a map region given the
40 | region's x and y coordinate. \|- ! 58 ! FIXED ! 0 ! \[\[377 Input
41 | Amount\|Input Amount\]\] ! Displays the "Input amount" interface. \|- !
42 | 59 ! FIXED ! 6 ! \[\[377 Create Static Graphic\|Create Static
43 | Graphic\]\] ! Creates a static graphic. \|- ! 61 ! FIXED ! 0 ! \[\[377
44 | Clear Waypoint\|Clear Waypoint\]\] ! Resets the waypoint. \|- ! 63 !
45 | VARIABLE\_BYTE ! N/A ! \[\[377 Send Message\|Send Message\]\] ! Sends a
46 | server message (e.g. 'Welcome to RuneScape') or trade/duel request. \|-
47 | ! 67 ! FIXED ! 4 ! \[\[377 Camera Shake\|Camera Shake\]\] ! Causes the
48 | camera to shake. \|- ! 71 ! VARIABLE\_SHORT ! N/A ! \[\[377 Update
49 | Npcs\|Update Npcs\]\] ! Updates NPCs. \|- ! 75 ! FIXED ! 2 ! \[\[377
50 | Send Position\|Send Position\]\] ! Sends a position (used for packets
51 | such as Ground Items and Projectiles) \|- ! 76 ! FIXED ! 23 ! \[\[377
52 | Open Welcome Screen\|Open Welcome Screen\]\] ! Displays the welcome
53 | screen. \|- ! 78 ! FIXED ! 9 ! \[\[377 Send Add Friend\|Send Add
54 | Friend\]\] ! Sends a friend to be added to the friend list. \|- ! 82 !
55 | FIXED ! 3 ! \[\[377 Set Widget Mouse Triggered\|Set Widget Mouse
56 | Triggered\]\] ! Set widget mouse triggered. \|- ! 88 ! FIXED ! 2 !
57 | \[\[377 Create Object\|Create Object\]\] ! Sends a friend to be added to
58 | the friend list. \|- ! 90 ! VARIABLE\_SHORT ! N/A ! \[\[377 Update
59 | Players\|Update Players\]\] ! Updates players. \|- ! 107 ! FIXED ! 5 !
60 | \[\[377 Send Ground Item\|Send Ground Item\]\] ! Adds a ground item to
61 | the server. \|- ! 113 ! FIXED ! 0 ! \[\[377 Reset Button State\|Reset
62 | Button State\]\] ! Resets the button state for all buttons. \|- ! 125 !
63 | FIXED ! 1 ! \[\[377 Run Energy\|Run Energy\]\] ! Sends the players run
64 | energy level. \|- ! 126 ! FIXED ! 3 ! \[\[377 Initialize
65 | Player\|Initialize Player\]\] ! Sends the player's membership status and
66 | their current index on the server's player list. \|- ! 128 ! FIXED ! 4 !
67 | \[\[377 Inventory Overlay\|Inventory Overlay\]\] ! Displays an interface
68 | over the sidebar area. \|-}
69 |
--------------------------------------------------------------------------------
/src/Data-Types.md:
--------------------------------------------------------------------------------
1 | # Data types
2 |
3 | RuneScape uses a number of common and bespoke data types in the
4 | process of data transmission.
5 |
6 | ## Byte Order
7 |
8 | Data types that are two bytes or larger can be stored and ordered in a
9 | variety of different ways.
10 | The traditional byte orders are big endian and little endian.
11 | Generally people either use big endian or little endian.
12 |
13 | RuneScape uses both little and big-endian byte orders throughout the
14 | protocol (however, the 194 client only uses big-endian order).
15 | This presumably to make reverse-engineering of the protocol harder.
16 |
17 | Note: Some confusion has arisen over the byte order as the data types
18 | are named incorrectly in Winterlove's server where little endian data
19 | types are incorrectly named as big endian types.
20 |
21 | ### Big Endian
22 |
23 | In big endian order, the most significant byte (MSB) is stored first and
24 | the least significant byte (LSB) is stored last.
25 |
26 | ### Little Endian
27 |
28 | In little endian order, the least significant byte (LSB) is stored first
29 | and the most significant byte (MSB) is stored last.
30 |
31 | ## Bespoke Byte Orders
32 |
33 | Additionally, RuneScape also uses two endian orders for integers that
34 | are different from a big- or low endian order.
35 | We call these byte orders middle endian.
36 |
37 | ### Middle Endian Big Int
38 |
39 | The bytes are stored in the following order, where A1 is the smallest byte (I.e. LSB) and D4 the bigger (i.e. MSB): C3 D4 A1 B2.
40 |
41 | ### Middle Endian Small Int
42 |
43 | The bytes are stored in the following order, where A1 is the smallest byte (I.e. LSB) and D4 the bigger (i.e. MSB): B2 A1 D4 C3.
44 |
45 | ## Common data types
46 |
47 | These data types are traditional, hence they can typically be written
48 | and read by a standard DataStream, or Buffer implementation.
49 |
50 | Naming conventions:
51 |
52 | | Standardized name | Data-type name | Jagex name | Encoding |
53 | |---|---|---|---|
54 | | Byte | byte | 1,1b | Bytes |
55 | | [Word](./Word.md) | short | 2,2b | Bytes |
56 | | [DWord](./DWord.md) | int, int32 | 2,2b | Bytes |
57 | | [QWord](./QWord.md) | long, int64 | 8,8b | Bytes |
58 | | C-style String | string, String, char*, char[] | str, strbyte | Text bytes followed by `\n` or the byte `10`. |
59 | | Java-string String | string, String, char*, char[] | strraw | Length as a word, followed by the text bytes. |
60 |
61 | Note: In more recent versions of the client, C-style strings are terminated with the null character (i.e. `\0`) or the byte `0` to support multi-line strings.
62 |
63 | ## Bespoke data types
64 |
65 | These data types are bespoke, that is, they were developed with the
66 | sole intention of only being used within Jagex products.
67 |
68 | We presume that this is another technique employed to make
69 | reverse-engineering and packet manipulation harder.
70 |
71 | Naming conventions:
72 |
73 | | Winterlove's name | Jagex name | Read transformation | Write transformation |
74 | |---|---|---|---|
75 | | Special A | Unknown | value - 128 | value + 128 |
76 | | Special C | Unknown | 0 - value | 0 - value |
77 | | Special S | Unknown | 128 - value | 128 - value |
78 | | SpaceSaverA | smarts | `(value[0] < 128) ? (((value[0] - 128) << 8) + value[1]) : value[0]` | `if(value < 128) putword(value+32768) else putbyte(value);` |
79 | | SpaceSaverB | smart | `(value[0] << 24) + (value[1] << 16) + value[2] ` | `putbyte(value >> 24); putbyte(value >> 16); putbyte(value); ` |
80 | | Tribyte, RGBColour, 3Byte, int3, medium | 3 | `(value[0] << 24) + (value[1] << 16) + value[2]` | `putbyte(value >> 24); putbyte(value >> 16); putbyte(value); ` |
81 | | [RS String](./RS-String.md) | jstr | Old engine: read until newline terminated ("\n"). New engine: read until null byte (value 0). | Old engine: write and finish with newline delimiter ("\n"). New engine: write and finish with null byte (value 0). |
82 |
83 | Note: The read transformation is the process which must be applied to
84 | read data, to reconstruct the original.
85 | The write transformation applies analogously, to when data is written.
86 |
87 | ## Bit Access
88 |
89 | ### Initiating Bit Access
90 |
91 | Whenever data is to be sent to the server or to the client using bits;
92 | the stream needs to be prepared by setting the bit position.
93 | The bit position can be calculated by multiplying the current buffer
94 | position by 8. This is because each byte is comprised of 8 bits.
95 |
96 | e.g. `int bitPos = bufferPos * 8;`
97 |
--------------------------------------------------------------------------------
/src/Class-Check.md:
--------------------------------------------------------------------------------
1 | # Class check
2 |
3 | The class check originated with the new Runescape engine update which
4 | took place around the 4xx revisions.
5 | It gives the Jagex servers the ability to check the modifiers, update,
6 | or fetch the value for a field.
7 | It also gives functionality to invoke a method with parameters and get
8 | it's return value, or check it's modifiers.
9 | Each of these functionalities are described with a request type.
10 | A class check request is built up with many of these request types.
11 | Each request is tagged with an unique id.
12 |
13 | ## Request format
14 |
15 | ```
16 | unsigned byte numberOfRequests;
17 | int uid;
18 | byte[] requests_block;
19 | ```
20 |
21 | The `requests_block` is comprised of multiple requests, each with the following format:
22 |
23 | ```
24 | unsigned byte type;
25 | type-dependent data;
26 | ```
27 |
28 | ## Response format
29 |
30 | ```
31 | int uid;
32 | byte[] responses_block;
33 | short payloadCrc;
34 | ```
35 |
36 | The `responses_block` is comprised of multiple responses, each with the following format:
37 |
38 | ```
39 | byte responseCode;
40 | type-dependent data;
41 | ```
42 |
43 | ## Request Types
44 |
45 | For request types 0, 2, 4 there will only be one successful response
46 | code and a short value of the value being requested will be sent.
47 | For request type 1, only the successful response code will be used but no
48 | value will be sent back.
49 |
50 | | Opcode | Name | Description |
51 | |---|---|---|
52 | | 0 | Fetch fumeric field | Fetches the value of a numeric field. |
53 | | 1 | Update numeric field | Updates the value of a numeric field. |
54 | | 2 | Get field modifiers | Gets the modifiers of a field. |
55 | | 3 | Invoke method | Invokes a method and sends back its return object. |
56 | | 4 | Get method modifiers | Gets the modifiers of a method. |
57 |
58 | ## Return Codes
59 |
60 | For opcode 0, there are cases where a numeric value is sent to the server
61 | on fetch requests.
62 | This value is always a short.
63 |
64 | For a method invoke request, there isn't a value that is sent to the server.
65 | It is just assumed that there wasn't a return object from the invoked method.
66 |
67 | | Opcode | Name | On Receive/Response | Description |
68 | |---|---|---|---|
69 | | 0 | Successful | Response | Successfully executed the request. |
70 | | 1 | Successful - Returned numeric value | Response | Successfully executed the request, and returned a numeric value. |
71 | | 2 | Successful - Returned string value | Response | Successfully executed the request, and returned a string value. |
72 | | 4 | Successful - Returned object value | Response | Successfully executed the request, and returned an object value. |
73 | | -1 | ClassNotFoundException | Receive | A ClassNotFoundException was thrown while receiving a request from the server. |
74 | | -2 | SecurityException | Receive | A SecurityException was thrown while receiving a request from the server. |
75 | | -3 | NullPointerException | Receive | A NullPointerException was thrown while receiving a request from the server. |
76 | | -4 | Exception | Receive | An Exception was thrown while receiving a request from the server. |
77 | | -5 | Throwable | Receive | An error or exception was thrown while receiving a request from the server. |
78 | | -10 | ClassNotFoundException | Response | A ClassNotFoundException was thrown while responding to a request from the server. |
79 | | -11 | InvalidClassException | Response | An InvalidClassException was thrown while responding to a request from the server. |
80 | | -12 | StreamCorruptedException | Response | A StreamCorruptedException was thrown while responding to a request from the server. |
81 | | -13 | OptionDataException | Response | An OptionDataException was thrown while responding to a request from the server. |
82 | | -14 | IllegalAccessException | Response | An IllegalAccessException was thrown while responding to a request from the server. |
83 | | -15 | IllegalArgumentException | Response | An IllegalArgumentException was thrown while responding to a request from the server. |
84 | | -16 | InvocationTargetException | Response | An InvocationTargetException was thrown while responding to a request from the server. |
85 | | -17 | SecurityException | Response | A SecurityException was thrown while responding to a request from the server. |
86 | | -18 | IOException | Response | An IOException was thrown while responding to a request from the server. |
87 | | -19 | NullPointerException | Response | A NullPointerException was thrown while responding to a request from the server. |
88 | | -20 | Exception | Response | An Exception was thrown while responding to a request from the server. |
89 | | -21 | Throwable | Response | An error or exception was thrown while receiving a request from the server. |
90 |
--------------------------------------------------------------------------------
/src/OB3.md:
--------------------------------------------------------------------------------
1 | # 0B3
2 |
3 | This page documents the `.ob3` format, a bespoke format for 3D models
4 | created by Jagex.
5 | It is used by the RuneScape Classic engine since client version
6 | \#74.
7 |
8 | Note: There is also an earlier version of this format called `.ob2`.
9 |
10 | ## OB3 Model Class
11 | The following is the fully renamed client code used to represent OB3 models.
12 |
13 | ```java
14 | public class OB3Model {
15 |
16 | private static final int num_seq = 0xbc614e; // 12345678
17 | public int vertex_count;
18 | public int vertices_x[];
19 | public int vertices_y[];
20 | public int vertices_z[];
21 | public int face_count;
22 | public int face_vertex_count[];
23 | public int face_vertices[][];
24 | public int face_fill_back[];
25 | public int face_fill_front[];
26 | public int face_gouraud[];
27 |
28 | public OB3Model(byte data[], int offset) {
29 | int vertex_count = get_uint16(data, offset);
30 | offset += 2;
31 | int face_count = get_uint16(data, offset);
32 | offset += 2;
33 |
34 | vertices_x = new int[vertex_count];
35 | vertices_y = new int[vertex_count];
36 | vertices_z = new int[vertex_count];
37 | face_vertex_count = new int[face_count];
38 | face_vertices = new int[face_count][];
39 | face_fill_back = new int[face_count];
40 | face_fill_front = new int[face_count];
41 | face_gouraud = new int[face_count];
42 |
43 | for (int v = 0; v < vertex_count; v++) {
44 | vertices_x[v] = get_int16b(data, offset);
45 | offset += 2;
46 | }
47 |
48 | for (int v = 0; v < vertex_count; v++) {
49 | vertices_y[v] = get_int16b(data, offset);
50 | offset += 2;
51 | }
52 |
53 | for (int v = 0; v < vertex_count; v++) {
54 | vertices_z[v] = get_int16b(data, offset);
55 | offset += 2;
56 | }
57 |
58 | this.vertex_count = vertex_count;
59 | for (int f = 0; f < face_count; f++)
60 | face_vertex_count[f] = get_ubyte(data[offset++]);
61 |
62 | for (int f = 0; f < face_count; f++) {
63 | face_fill_back[f] = get_int16b(data, offset);
64 | offset += 2;
65 | if (face_fill_back[f] == 32767)
66 | face_fill_back[f] = num_seq;
67 | }
68 |
69 | for (int f = 0; f < face_count; f++) {
70 | face_fill_front[f] = get_int16b(data, offset);
71 | offset += 2;
72 | if (face_fill_front[f] == 32767)
73 | face_fill_front[f] = num_seq;
74 | }
75 |
76 | for (int f = 0; f < face_count; f++) {
77 | int i = get_ubyte(data[offset++]);
78 | if (i == 0)
79 | face_gouraud[f] = 0;
80 | else
81 | face_gouraud[f] = num_seq;
82 | }
83 |
84 | for (int f = 0; f < face_count; f++) {
85 | face_vertices[f] = new int[face_vertex_count[f]];
86 | for (int fv = 0; fv < face_vertex_count[f]; fv++) {
87 | if (vertex_count < 256) {
88 | face_vertices[f][fv] = get_ubyte(data[offset++]);
89 | } else {
90 | face_vertices[f][fv] = get_uint16(data, offset);
91 | offset += 2;
92 | }
93 | }
94 | }
95 |
96 | this.face_count = face_count;
97 | }
98 |
99 | private static int get_ubyte(byte b) {
100 | return (b & 0xff);
101 | }
102 |
103 | private static int get_uint16(byte b[], int start) {
104 | return (get_ubyte(b[start]) << 8) + get_ubyte(b[start + 1]);
105 | }
106 |
107 | private static int get_int16b(byte b[], int start) {
108 | int i = get_ubyte(b[start]) * 256 + get_ubyte(b[start + 1]);
109 | if (i > 32767)
110 | i -= 0x10000;
111 | return i;
112 | }
113 | }
114 | ```
115 |
116 | ## Faces
117 |
118 | A negative face_fill_back or face_fill_front value indicates a solid colour, whereas a positive value indicates a texture.
119 | The texture is defined by its offset in the client's texture array.
120 |
121 | When converting to/from [Wavefront OBJ](https://en.wikipedia.org/wiki/Wavefront_.obj_file)
122 | format, remember that the OB3 face vertices are one less than the OBJ
123 | face vertices.
124 |
125 | The below code will allow you to encode or decode colours in this format.
126 |
127 | ```java
128 | public static int decode_colour(int i) {
129 | i = -(i + 1);
130 | int r = i >> 10 & 0x1f;
131 | int g = i >> 5 & 0x1f;
132 | int b = i & 0x1f;
133 | return (r << 19) + (g << 11) + (b << 3);
134 | }
135 |
136 | public static int encode_colour(int r, int g, int b) {
137 | return -1 - (r / 8) * 1024 - (g / 8) * 32 - b / 8;
138 | }
139 | ```
140 |
--------------------------------------------------------------------------------
/src/508-Protocol.md:
--------------------------------------------------------------------------------
1 | \[\[Category RS2\]\]
2 |
3 | == '''Packet structure''' == When the client sends a packet to the
4 | server, the first byte encapsulates its opcode. This specific opcode is
5 | encrypted with a value generated by the ISAAC PRNG seeded with a
6 | dynamically server generated key during the login block. The server
7 | decrypts it and associates the opcode to the packet's respective
8 | predefined size. If the packet does not contain a fixed size, the opcode
9 | will be followed by either a byte or a word - varying per packet - for
10 | its proper size. This is then followed by the payload.
11 |
12 | == '''Login''' == Every connection to the main 'gateway' server sends a
13 | single byte of data, mostly well known as the connection type. The
14 | connection type tells the main server which type of connection you wish
15 | to initiate. The old engine list consists of:
16 |
17 | - Login initiation - connection type 14
18 | - Update - connection type 15
19 | - Fresh login - connection type 16
20 | - JAGGRAB - connection type 17
21 | - Reconnecting login - connection type 18
22 | - Worldlist - varies, connection type 255 in \#508
23 | - Potentially more...
24 |
25 | The connection type we will cover in the following paragraphs is the
26 | login connection type, 14. After the login handshake initiating
27 | connection type, the client writes a small bit of data derived from the
28 | logging in player's username. This is believed to help select the
29 | appropriate login server. On successful handshake, the server sends back
30 | 8 ignored by
31 |
32 | At this point, the client reads in one byte, called the status code. The
33 | status code 0 is expected to start the login protocol correctly. If the
34 | status code is 0, the client reads a long, dubbed by many as the server
35 | session key. This is used to help generate a unique seed for the client
36 | session's packet opcode masking. The client then stores two ints that
37 | are the upper and lower ints of the client session key, which has the
38 | same purpose as the server's key. The client then starts writing the
39 | login block, which is RSA encrypted.
40 |
41 | The login block starts with the byte 10, which is considered a magic
42 | number. Following it is the client session key and server session key
43 | longs. Trailing behind the session keys comes the client's username
44 | packed to a 64-bit long and password written as a C-string
45 | (NUL-terminated ASCII). This block is then RSA encrypted and stored for
46 | later use.
47 |
48 | Now starts the login request packet. It starts off with a flag telling
49 | the server whether or not the client is reconnecting or connecting for
50 | the first time \[NOW CLASSIFIED AS CONNECTION TYPE\]. The byte is 18 or
51 | 16, respectively. Following is the size of the rest of the login
52 | response packet, including the login block that trails at the end, to
53 | tip the server how much data it should expect. Later comes the client
54 | revision int. After the client revision, an unknown byte is written that
55 | seems to always be zero (possibly the memory usage game-type flag \[low
56 | mem/high mem\]), followed by constantly zero byte and yet another zero
57 | byte. Next the packet writes the game applet width and height in pixels
58 | as shorts, followed quickly after by the UID (unique identifier or user
59 | identifier). Next comes the C-string settings string passed as a param
60 | to the applet, and after it the int affiliate identifier (probably
61 | identifies the game affiliate it was run on) with another int right
62 | after it. This int that trails behind is an unknown int that only has 22
63 | bits used, all of which represent various flags within the client. Any
64 | clues as to what they are would be nice. The packet is just about
65 | crafted completely. \[In 525, a strange short is written here\]. To
66 | finish off the main chunk, the client writes all cache's reference table
67 | index-based CRC32 checksums as ints (29 in 539, 27 in 508, etc). To top
68 | it off, the RSA encrypted login block is appended to the end and the
69 | packet is sent to the server.
70 |
71 | The ISAAC ciphers are seeded for packet opcode masking after adding 50
72 | to each int of the session keys, and the status code is reread. This
73 | finishes the login protocol.
74 |
75 | == '''Game Protocol''' == Game packet header:
76 |
77 |
78 | ubyte - opcode
79 | ubyte - packet size only if packet size is sent as -1 (length: VAR_BYTE)
80 | ushort - packet size only if packet size is sent as -2 (length: VAR_SHORT)
81 |
82 | After the header is read by the server, the packet specific data is then
83 | read and decoded by the server.
84 |
85 | ===Server -\> Client Packets=== {\| border=2 \|- ! Opcode ! Type !
86 | Length (bytes) ! Name ! Description \|- \| 8 \| FIXED \| 2 \| \[\[508
87 | System update\|System update\]\] \| Displays the system update counter
88 | on the player's client. \|- \| 93 \| FIXED \| 7 \| \[\[508 Send
89 | interface\|Send interface\]\] \| \|- \| 99 \| FIXED \| 1 \| \[\[508 Run
90 | energy\|Run energy\]\] \| Sets the players run energy. \|- \| 104 \|
91 | FIXED \| 0 \| \[\[508 Logout\|Logout\]\] \| Logs the player out. \|- \|
92 | 217 \| FIXED \| 6 \| \[\[508 Send skill levels\|Send skill levels\]\] \|
93 | Sends the player's skill levels to the client to be drawn on the skill
94 | tab. \|- \| 218 \| VARIABLE BYTE \| N/A \| \[\[508 Send message\|Send
95 | message\]\] \| Writes a string to the client's chat box. \|- \| 239 \|
96 | FIXED \| 3 \| \[\[508 Set window pane\|Set window pane\]\] \| \|- \| 252
97 | \| VARIABLE BYTE \| N/A \| \[\[508 Send player option\|Send player
98 | option\]\] \| \|}
99 |
100 | ===Client -\> Server Packets===
101 |
102 | {
103 | ---
104 |
105 | ! Opcode ! Type ! Length (bytes) ! Name ! Description \|- \| 63 \| FIXED
106 | \| 6 \| \[\[508 Dialogue Options\|Dialogue Options.\]\] \| Sent when a
107 | player clicks an dialogue button. The data sent is InterfaceId,
108 | buttonId, and something yet not discovered. \|- \|}
109 |
--------------------------------------------------------------------------------
/src/Archive-Format.md:
--------------------------------------------------------------------------------
1 | # Archive format
2 |
3 | From client revision 194 until 377, all the files in cache 0
4 | are in an archive-like format which contains a collection of named
5 | files (e.g. `BADENC.TXT` is a file which contains bad words in the
6 | `wordenc` archive).
7 |
8 | ## Usage
9 |
10 | These files are used by the client for a variety of purpose.
11 |
12 | The files themselves represent either an index, which contains
13 | information about to where to locate data in the cache, and
14 | the data themselves.
15 |
16 | e.g. `DATA` contains data for interfaces.
17 |
18 | e.g. `MAP_INDEX` contains information about where to find the map and landscape files in the cache.
19 |
20 | ## Format
21 |
22 | ```
23 | tribyte uncompressedSize
24 | tribyte compressedSize
25 | ```
26 |
27 | If the uncompressed and compressed sizes are equal, the whole file is
28 | not compressed but the individual entries are compressed using bzip2.
29 | If they are not equal, the entire file is compressed using bzip2 but
30 | the individual entries are not.
31 |
32 | Note: The magic id at the start of the bzip2 entries are not included
33 | in the cache.
34 | If you use an existing API to read the files and want to add this back,
35 | you must append the characters `BZh1` before you decompress.
36 |
37 | ```short fileCount```
38 |
39 | Each file entry has the format:
40 |
41 | ```
42 | int nameHash
43 | tribyte uncompressedSize
44 | tribyte compressedSize
45 | ```
46 |
47 | # Extracting the data
48 |
49 | If you iterate over the files using a for-loop, you need to keep track of the
50 | file offset.
51 | The following pseudo-code demonstates how:
52 |
53 | ```java
54 | int offset = buffer.getCurrentOffset() + numFiles * 10;
55 |
56 | for(int i = 0; i < numFiles; i++) {
57 | // read values
58 | int thisFileOffset = offset;
59 | offset += thisFileCompressedSize;
60 | }
61 | ```
62 |
63 | To acquire a named file using its name, hash the name as follows:
64 |
65 | ```java
66 | public static int hash(String name) {
67 | int hash = 0;
68 | name = name.toUpperCase();
69 |
70 | for(int j = 0; j < name.length(); j++) {
71 | hash = (hash * 61 + name.charAt(j)) - 32;
72 | }
73 | return hash;
74 | }
75 | ```
76 |
77 | Then, loop through the file entries you loaded earlier to find a
78 | matching hash. Read the compressed file size from the offset. If the
79 | whole file is not compressed, you should decompress the individual
80 | entry.
81 |
82 | ## \#194 Archive Format
83 |
84 | The \#194 (RuneScape 2 beta) client worked with a very simple cache
85 | format.
86 | Each file in the cache corresponded to a file on the operating system.
87 |
88 | ### Name hashing
89 |
90 | Every name in the cache was hashed using the following method which is,
91 | incidentally, similar to the way player names are converted to longs.
92 |
93 | ```java
94 | public static final long gethash(String string) {
95 | string = string.trim();
96 | long l = 0L;
97 |
98 | for (int i = 0; i < string.length() && i < 12; i++) {
99 | char c = string.charAt(i);
100 | l \*= 37L;
101 |
102 | if (c >= 'A' && c <= 'Z')
103 | l += (long) ('\\001' + c - 'A');
104 | else if (c >= 'a' && c <= 'z')
105 | l += (long) ('\\001' + c - 'a');
106 | else if (c >= '0' && c <= '9')
107 | l += (long) ('\\033' + c - '0');
108 | }
109 | return l;
110 | }
111 | ```
112 |
113 | The resulting long was converted to a string and the file was given that
114 | name.
115 |
116 | ### Files
117 |
118 | The files in the cache were the ones used in the [JAGGRAB protocol](./JAGGRAB-Protocol.html) (i.e. files in cache 0 in old engine caches),
119 | map (mX_Y), and landscape (lX_Y) files.
120 |
121 | Incidentally, this naming is very similar to the names of the map and
122 | landscape files in new engine caches.
123 |
124 | ## \#317 Archive Format
125 |
126 | The old engine cache is made up two types of files.
127 |
128 | ### Data file
129 |
130 | The data file holds all of the files in the cache and is named
131 | `main_file_cache.dat`.
132 | It is therefore very big, typically ~10-20MB in size.
133 |
134 | ### Index file
135 |
136 | There are several index files, named `main_file_cache.idx` and
137 | then post-fixed with a number.
138 | Each index file holds 'pointers' to where a file is located in
139 | the main cache.
140 | Each index file represents a type of file.
141 |
142 | ### Index file format
143 |
144 | The index file is comprised of a collection of six byte blocks which hold
145 | information about where a file can be located in the data file.
146 |
147 | The format of a single block is as follows:
148 | ```
149 | tribyte fileSize
150 | tribyte initialDataBlockId
151 | ```
152 |
153 | ### Data file format
154 |
155 | The data file is comprised of a collection of 520 byte blocks.
156 |
157 | The format of each of these blocks is as follows:
158 |
159 | ```
160 | short nextFileId
161 | short currentFilePartId
162 | tribyte nextDataBlockId
163 | byte nextFileTypeId
164 | byte[512] blockData
165 | ```
166 |
167 | ### Running example
168 |
169 | Suppose, the client wishes to fetch file type 2, file id 17.
170 |
171 | First off, it will open the `main_file_cache.idx2` file and seek to the
172 | index `17 * 6` (102).
173 | It will then read the two tribytes:
174 | ```
175 | fileSize = 1200
176 | intialDataBlockId = 4
177 | ```
178 |
179 | The client will now open the `main_file_cache.dat` file and seek to the
180 | index `4 * 520` (2080).
181 |
182 | It will then read the following:
183 | ```
184 | nextFileId = 17
185 | currentFilePartId = 0
186 | nextDataBlockId = 5
187 | nextFileTypeId = 2
188 | blockData = ... // 512 bytes of data
189 | ```
190 |
191 | It will read the first 512 bytes of the file and then knows that there
192 | is 688 bytes left.
193 |
194 | Therefore, it has to read the next block:
195 | ```
196 | nextFileId = 17
197 | currentFilePartId = 1
198 | nextDataBlockId = 6
199 | nextFileTypeId = 2
200 | blockData ... // 512 bytes of data
201 | ```
202 |
203 | It reads these next 512 bytes of the file and now knows that there are
204 | 176 bytes left.
205 |
206 | So for a final time, it will read the next block:
207 | ```
208 | nextFileId = 18
209 | currentFilePartId = 2
210 | nextDataBlockId = 7
211 | nextFileTypeId = 2
212 | blockData = ... // 176 bytes of data
213 | ```
214 |
215 | It can ignore most of these values (the next ones are meaningless at
216 | this stage) and read the final 176 bytes.
217 | The whole 1200 byte file has now been read.
218 |
--------------------------------------------------------------------------------
/src/Map-Region-System.md:
--------------------------------------------------------------------------------
1 | # Map region system
2 |
3 | A coordinate system is used to navigate through the RuneScape
4 | world.
5 | That coordinate system is based upon three variables, the absolute
6 | X-, Y-, and Z-coordinates.
7 |
8 | ## Definitions
9 |
10 | A **tile** is the in-game representation of an absolute coordinate.
11 |
12 | e.g. The coordinates `(3222, 3222)` represents one tile in the heart
13 | of the Lumbridge castle.
14 |
15 | A **chunk of tiles**, 8 x 8 in size.
16 | Also known as a region before the scope of a region was understood.
17 | The chunk is considered a point so it has X and Y coordinates.
18 | There are two forms of a Chunk: formatted and non-formatted,
19 | a formatted chunks equation is:
20 |
21 | ```java
22 | int chunkX = (getAbsoluteX() >> 3) - 6;
23 | int chunkY = (getAbsoluteY() >> 3) - 6;
24 | ```
25 |
26 | This centers the chunk on the map, more on that later.
27 |
28 | The normal chunk equation is:
29 |
30 | ```java
31 | int chunkX = (getAbsoluteX() >> 3);
32 | int chunkY = (getAbsoluteY() >> 3);
33 | ```
34 |
35 | e.g. For the coordinates `(3211, 3424)`, chunk X (formatted) is 395 and
36 | the chunk Y (un-formatted) is 428.''
37 |
38 | ## Region
39 |
40 | A **region** is 64 x 64 in size, or 8 x 8 in chunks.
41 | The region is considered a point so it has X and Y coordinates.
42 |
43 | The equation for finding the region the coordinates is within is:
44 |
45 | ```java
46 | int regionX = (getUnformattedRegionX() >> 3); // getUnformatedRegionX() / 8;
47 | int regionY = (getUnformattedRegionY() >> 3); // getUnformatedRegionY() / 8;
48 | ```
49 |
50 | e.g. For the coordinates `(3211, 3424)`, region X is 50, and the
51 | region Y is 53.
52 |
53 | Note: The Region X and Region Y coordinates are traditionally not used
54 | in server location calculations; but practical region systems should use
55 | this calculation for many purposes.
56 |
57 | ## Map
58 |
59 | There is no calculation for a map, and there is no Map X or Map Y.
60 |
61 | A Map is, however, a 104 x 104 area made up of 13 x 13 chunks.
62 | Why is the number not even you may ask?
63 | Because it has a center.
64 | The `(7, 7)` map chunk of the map is the center, and is also the formatted
65 | chunk.
66 |
67 | When a region update is called by the server, a new map is called, but you
68 | must understand that the formatted chunk never changes; the tiles in the
69 | map, however, are updated and trimmed.
70 | When the player moves out of the formatted chunk, the map is re-positioned
71 | to make that chunk the center yet again.
72 | As stated, a new update is not needed every time the player enters a
73 | new region, but when the range of +- 32 from the point in the center of
74 | the chunk is reached, an update is required to update the map to the
75 | new objects so that the 'black space' or fog is not reached. Confused?
76 |
77 | ## Diagram
78 |
79 | 
80 |
81 | The active chunk is the chunk in which the player resides.
82 | The definite rendering chunks are the chunks in which will be rendered
83 | on the players screen no matter where they are in the active chunk.
84 | The indefinite rendering chunks are the chunks in which depending on
85 | where the player is within the active chunk they may be rendered or not.
86 | Remember this depends on the +- distance of 32 from the players
87 | absolute position. The queue chunks are pre-loaded chunks in whichafter the
88 | active chunk is moved may be disposed of or activated depending upon the
89 | direction in which the active chunk changes.
90 |
91 | ## Loading
92 |
93 | The following were the regions loaded for the coordinates `(3183, 3217)`:
94 |
95 | 
96 |
97 | If you can imagine a puzzle, a 64 x 64 piece does not fit equally within
98 | the 104 x 104 area.
99 | So, bits of each region are taken that are within the 104 x 104 map area.
100 |
101 | The amount of regions that are to be loaded can be calculated this way:
102 |
103 | Please note that Region X and Region Y are not formatted.
104 |
105 | ```java
106 | int amt = 0;
107 |
108 | for (int i21 = (player.getLocation().getRegionX() - 6) / 8; i21 <= (player.getLocation().getRegionX() + 6) / 8; i21++) {
109 | for (int k23 = (player.getLocation().getRegionY() - 6) / 8; k23 <= (player.getLocation().getRegionY() + 6) / 8; k23++)
110 | amt++;
111 | }
112 | ```
113 |
114 | Along with this, the base X and base Y of each of the region can be
115 | calculated:
116 |
117 | ```java
118 | for (int i21 = (player.getLocation().getRegionX() - 6) / 8; i21 <= (player.getLocation().getRegionX() + 6) / 8; i21++) {
119 | for (int k23 = (player.getLocation().getRegionY() - 6) / 8; k23 <= (player.getLocation().getRegionY() + 6) / 8; k23++)
120 | System.out.println(i21 + " X " + (i21 << 6) + "," + k23 + " Y " + (k23 << 6));;;
121 | }
122 | ```
123 |
124 | The 'X' and 'Y' coordinates represents the coordinates of the region as
125 | depicted in the diagram. After the regions are loaded they are trimmed
126 | to the tiles that are necessary.
127 |
128 | ## Example Location class
129 |
130 | The following is an example Location class written by sinisoul.
131 | It is not heavily commented due to it being a very simple class,
132 | and it should be easy to follow if you read this section in full.
133 |
134 | ```java
135 | package net.forge.content.world.node;
136 |
137 | /**
138 | * RuneForge (317)
139 | * @version 1.0.0
140 | * @author SiniSoul (SiniSoul@live.com)
141 | */
142 | public final class Location {
143 |
144 | /**
145 | * The Tile X and Y coordinates.
146 | */
147 | private int tilex = 0,
148 | tiley = 0;
149 |
150 | /**
151 | * The Height of the location.
152 | */
153 | private int height = 0;
154 |
155 | /**
156 | * The asynchronous Chunk X and Y coordinates; used in region updating.
157 | */
158 | private int chunkx = 0,
159 | chunky = 0;
160 |
161 | public void setTileX(int tilex) {
162 | this.tilex = (tilex & 0xFFFF);
163 | }
164 |
165 | public int getTileX() {
166 | return tilex;
167 | }
168 |
169 | public void setTileY(int tiley) {
170 | this.tiley = (tiley & 0xFFFF);
171 | }
172 |
173 | public int getTileY() {
174 | return tiley;
175 | }
176 |
177 | /**
178 | * @param formatted If the chunk is formatted for map positioning or
179 | * other formatted chunk comparison.
180 | */
181 | public int calculateChunkX(boolean formatted) {
182 | return formatted ? (getTileX() >> 3) - 6 : (getTileX() >> 3);
183 | }
184 |
185 | /**
186 | * @param formatted If the chunk is formatted for map positioning or
187 | * other formatted chunk comparison.
188 | */
189 | public int calculateChunkY(boolean formatted) {
190 | return formatted ? (getTileY() >> 3) - 6 : (getTileY() >> 3);
191 | }
192 |
193 | public void updateChunkX() {
194 | this.chunkx = calculateChunkX(true);
195 | }
196 |
197 | public void updateChunkY() {
198 | this.chunkx = calculateChunkY(true);
199 | }
200 |
201 | public int getChunkX() {
202 | return chunkx;
203 | }
204 |
205 | public int getMapLocalX() {
206 | return getTileX() - (getChunkX() << 3);
207 | }
208 |
209 | public int getChunkY() {
210 | return chunky;
211 | }
212 |
213 | public int getMapLocalY() {
214 | return getTileX() - (getChunkY() << 3);
215 | }
216 |
217 | public void setHeight(int height) {
218 | this.height = (height & 0x3);
219 | }
220 |
221 | public int getHeight() {
222 | return height;
223 | }
224 |
225 | public int getRegionX() {
226 | return calculateChunkX(false) >> 3;
227 | }
228 |
229 | public int getRegionLocalX() {
230 | return getTileX() - (getRegionX() << 6);
231 | }
232 |
233 | public int getRegionY() {
234 | return calculateChunkY(false) >> 3;
235 | }
236 |
237 | public int getRegionLocalY() {
238 | return getTileY() - (getRegionY() << 6);
239 | }
240 |
241 | public void set(int tilex, int tiley, int height) {
242 | setTileX(tilex);
243 | setTileY(tiley);
244 | setHeight(height);
245 | }
246 |
247 | public Location(int tilex, int tiley, int height) {
248 | set(tilex, tiley, height);
249 | updateChunkX();
250 | updateChunkY();
251 | }
252 | }
253 | ```
254 |
--------------------------------------------------------------------------------
/src/202-Protocol.md:
--------------------------------------------------------------------------------
1 | \[\[Category RSC\]\]
2 |
3 | This page refers to the RSC \#202 client revision (the original
4 | distribution by eXemplar)
5 |
6 | == '''Packet structure''' == ?
7 |
8 | == '''Login''' == ?
9 |
10 | == '''Incoming Data''' == '''TODO:''' Document packet structures
11 |
12 | #define IDX_WEIRD_USERNAME 32
13 | #define IDX_LOGIN 0
14 | #define IDO_LOGOUT_ACK 39 // acknowledge logout command from server
15 | #define IDO_PING 153 // send ping to server, so it knows we're still there
16 | #define IDO_IGNORE_ADD 25 // add name to ignore list
17 | #define IDO_IGNORE_REMOVE 108 // remove name from ignore list
18 | #define IDO_FRIENDS_ADD 168 // add name to friends list
19 | #define IDO_FRIENDS_REMOVE 52 // remove name from friends list
20 | #define IDO_PM_FRIEND 254 // send pm to someone in friends list
21 | #define IDO_SEND_CHAT 145
22 | #define IDO_SEND_SERVER_CMD 90 // sends a command to the server (type "::xxx" in chat and it sends command 'xxx')
23 | #define IDO_UPDATE_SETTINGS 176 // changes settings (chatblock, privateblock, tradeblock, duelblock)
24 |
25 | #define IDO_LOGOUT 129
26 | #define IDO_CHAR_DESIGN 218 // send character design (makeover mage, creation)
27 | #define IDO_SLEEPWORD 72
28 | #define IDO_NEW_PLAYER_ACK 83 // send ids of newly added player back to server, if it wants to
29 |
30 | #define IDO_EXCEPTION_SEND 156
31 | #define IDO_WALKCMD_1 246
32 | #define IDO_WALKCMD_2 132
33 | #define IDO_CLICKDIALOGITEM 154
34 | #define IDO_SETCOMBATSTYLE 41
35 | #define IDO_WITHDRAW 183
36 | #define IDO_DEPOSIT 198
37 | #define IDO_CLOSE_BANK 48
38 | #define IDO_BUYITEM 128
39 | #define IDO_SELLITEM 255
40 | #define IDO_CLOSE_SHOP 253
41 | #define IDO_CANCEL_TRADE 216
42 | #define IDO_CONFIRM_TRADE 53
43 | #define IDO_TRADE_UPDATE 70
44 | #define IDO_ACCEPT_TRADE 211
45 | #define IDO_DUEL_CONFIRM_1 87
46 | #define IDO_DUEL_UPDATE 123
47 | #define IDO_DUEL_FLAG_1 225
48 | #define IDO_DUEL_FLAG_2 252
49 | #define IDO_CANCEL_DUEL 35
50 | #define IDO_PRAYER_OFF 248
51 | #define IDO_PRAYER_ON 56
52 | #define IDO_CHANGE_SETTINGS 157
53 |
54 | // action commands...
55 | #define IDO_CAST_GR_ITEM 104
56 | #define IDO_USEWITH_GR_ITEM 34
57 | #define IDO_TAKE_ITEM 245
58 | #define IDO_CAST_WALLOBJ 67
59 | #define IDO_USEWITH_WALLOBJ 36
60 | #define IDO_WALLOBJ_CMD1 126
61 | #define IDO_WALLOBJ_CMD2 235
62 | #define IDO_CAST_OBJECT 17
63 | #define IDO_USEWITH_OBJECT 94
64 | #define IDO_OBJECT_CMD1 51
65 | #define IDO_OBJECT_CMD2 40
66 |
67 | #define IDO_CAST_INVITEM 49
68 | #define IDO_USEWITH_INVITEM 27
69 | #define IDO_REMOVE_ITEM 92
70 | #define IDO_WEAR_ITEM 181
71 | #define IDO_INVITEM_CMD 89
72 | #define IDO_DROP_ITEM 147
73 |
74 | #define IDO_CAST_NPC 71
75 | #define IDO_USEWITH_NPC 142
76 | #define IDO_TALK_NPC 177
77 | #define IDO_NPC_CMD 74
78 | #define IDO_ATTACK_NPC 73
79 |
80 | #define IDO_CAST_PLAYER 55
81 | #define IDO_USEWITH_PLAYER 16
82 | #define IDO_ATTACK_PLAYER 57
83 | #define IDO_DUEL_PLAYER 222
84 | #define IDO_TRADE_PLAYER 166
85 | #define IDO_FOLLOW_PLAYER 68
86 |
87 | #define IDO_CAST_GROUND 232
88 | #define IDO_CAST_SELF 206
89 |
90 | #define IDO_REPORT_ABUSE 7
91 |
92 |
93 |
94 | |
95 | opcode
96 | |
97 |
98 | usage
99 | |
100 |
101 | size
102 | |
103 |
104 | payload
105 | |
106 |
107 |
108 | |
109 | |
110 |
111 | |
112 |
113 | |
114 |
115 | |
116 |
117 |
118 | == '''Outgoing Data''' == '''TODO:''' Document packet structures
119 |
120 | // login responses...
121 | #define IDX_MOD_ACCEPTED 25 // logged in as player mod
122 | #define IDX_LOGIN_SUCCESS 0
123 | #define IDX_RELOGIN_SUCCESS 1 // connection reestablished after lost connection...
124 | #define IDX_WRONG_PWD 3
125 | #define IDX_NAME_LOGGED_IN 4
126 | #define IDX_CLIENT_UPDATED 5
127 | #define IDX_IP_IN_USE 6
128 | #define IDX_LOGINS_EXCEEDED 7
129 | #define IDX_SERV_REJECTED 8
130 | #define IDX_LOGINSERV_REJCT 9
131 | #define IDX_NAME_IN_USE 10
132 | #define IDX_TEMP_DISABLED 11
133 | #define IDX_PERM_DISABLED 12
134 | #define IDX_SERVER_FULL 14
135 | #define IDX_MEMBERACC_REQ 15 // requires member account to login here
136 | #define IDX_LOGINSERV_DOWN 16
137 | #define IDX_DECODE_FAIL 17
138 | #define IDX_LOGIN_MISMATCH 20
139 |
140 | #define IDI_MESSAGE 48 // (game) messages from server
141 | #define IDI_LOGOUT 222 // logout command from server (forced, or initiated by client IDO_LOGOUT)
142 | #define IDI_LOGOUT_REJECT 136 // not allowed to log out (e.g. when in combat)
143 | #define IDI_FRIENDS_LOAD 249 // when logging in, sends the whole friends list to the client
144 | #define IDI_FRIEND_LOGGED 25 // a friend from friends list logged in or out (also used to add a friend to friends list)
145 | #define IDI_IGNORE_LOAD 2 // when logging in, sends the whole ignore list to the client
146 | #define IDI_SETTINGS_LOAD 158 // load settings upon logging in (blocks)
147 | #define IDI_FRIENDS_PM 170 // someone pm'd us
148 |
149 | #define IDI_PLAYER_MOVEMENT 145 // player movement update
150 | #define IDI_GRITEMS_UPDATE 109 // update ground items
151 | #define IDI_OBJECTS_UPDATE 27
152 | #define IDI_INV_LOAD 114 // load inventory
153 | #define IDI_PLAYER_UPDATE 53
154 | #define IDI_WALLOBJ_UPDATE 95
155 | #define IDI_NPC_MOVEMENT 77 // npc movement update
156 | #define IDI_NPC_UPDATE 190
157 | #define IDI_DIALOG_SHOW 223
158 | #define IDI_DIALOG_CLOSE 127
159 | #define IDI_LOAD_NEWMAPAREA 131 // entering a new region (maparea)
160 | #define IDI_XP_LOAD 180 // load xp and stats
161 | #define IDI_EQUIP_UPDATE 177 // equipment stats (armour, magic, prayer, weapaim/power)
162 | #define IDI_PLAYER_DIED 165
163 | #define IDI_LOADWORLD 115 // load objects, wallobjects, items
164 | #define IDI_DESIGN_CHAR 207
165 | #define IDI_OPEN_TRADE_1 4
166 | #define IDI_CLOSE_TRADE 187
167 | #define IDI_TRADE_UPDATE 250 // opponents offer was updated
168 | #define IDI_TRADE_B_UPDATE 92 // update of opponents acception status
169 | #define IDI_SHOP_OPEN 253
170 | #define IDI_SHOP_CLOSE 220
171 | #define IDI_TRADE_A_UPDATE 18 // update of thisplayers acception status
172 | #define IDI_LOAD_OPTIONS 152 // camera angle, sound, mousebutton settings
173 | #define IDI_PRAYER 209
174 | #define IDI_QUESTS 224
175 | #define IDI_BANK_OPEN 93
176 | #define IDI_BANK_CLOSE 171
177 | #define IDI_XP_UPDATE 211
178 | #define IDI_OPEN_DUEL_1 229
179 | #define IDI_CLOSE_DUEL 160
180 | #define IDI_OPEN_TRADE_2 251 // trade confirmation window
181 | #define IDI_DUEL_UPDATE 63 // opponents offer was updated
182 | #define IDI_DUELOPT_UPDATE 198 // update duel options
183 | #define IDI_BANK_UPDATE 139
184 | #define IDI_INV_ADD 228
185 | #define IDI_INV_REMOVE 191
186 | #define IDI_STAT_UPDATE 208
187 | #define IDI_DUEL_B_UPDATE 65 // update of opponents acception status
188 | #define IDI_DUEL_A_UPDATE 197 // update of thisplayers acception status
189 | #define IDI_OPEN_DUEL_2 147 // duel confirmation window
190 | #define IDI_SOUND 11
191 | #define IDI_SPLASH 23
192 | #define IDI_WELCOMEWINDOW 248
193 | #define IDI_MESSAGE_1 148
194 | #define IDI_MESSAGE_2 64
195 | #define IDI_FATIGUE_UPDATE 126
196 | #define IDI_NEW_SLEEPWORD 219
197 | #define IDI_FATIGUE_SLEEPN 168 // fatigue update in sleeping window
198 | #define IDI_SLEEP_SUCCESS 103
199 | #define IDI_SLEEP_FAILED 15
200 | #define IDI_SYSTEM_UPDATE 172
201 |
202 |
203 |
204 | |
205 | opcode
206 | |
207 |
208 | usage
209 | |
210 |
211 | size
212 | |
213 |
214 | payload
215 | |
216 |
217 |
218 | |
219 | |
220 |
221 | |
222 |
223 | |
224 |
225 | |
226 |
227 |
228 |
--------------------------------------------------------------------------------
/src/204-Protocol.md:
--------------------------------------------------------------------------------
1 | \[\[Category RSC\]\]
2 |
3 | This page refers to the RSC \#204 client revision, all of the opcodes
4 | are the same with the exception of the last three in the Outgoing Data
5 | section.
6 |
7 | == '''Packet structure''' == ?
8 |
9 | == '''Login''' == ?
10 |
11 | == '''Incoming Data''' == '''TODO:''' Document packet structures
12 |
13 | #define IDX_WEIRD_USERNAME 32
14 | #define IDX_LOGIN 0
15 | #define IDO_LOGOUT_ACK 31 // acknowledge logout command from server
16 | #define IDO_PING 67 // send ping to server, so it knows we're still there
17 | #define IDO_IGNORE_ADD 132 // add name to ignore list
18 | #define IDO_IGNORE_REMOVE 241 // remove name from ignore list
19 | #define IDO_FRIENDS_ADD 195 // add name to friends list
20 | #define IDO_FRIENDS_REMOVE 167 // remove name from friends list
21 | #define IDO_PM_FRIEND 218 // send pm to someone in friends list
22 | #define IDO_SEND_CHAT 216
23 | #define IDO_SEND_SERVER_CMD 38 // sends a command to the server (type "::xxx" in chat and it sends command 'xxx')
24 | #define IDO_UPDATE_SETTINGS 64 // changes settings (chatblock, privateblock, tradeblock, duelblock)
25 |
26 | #define IDO_LOGOUT 102
27 | #define IDO_CHAR_DESIGN 235 // send character design (makeover mage, creation)
28 | #define IDO_SLEEPWORD 45
29 | #define IDO_NEW_PLAYER_ACK 163 // send ids of newly added player back to server, if it wants to
30 |
31 | #define IDO_EXCEPTION_SEND 3
32 | #define IDO_WALKCMD_1 16
33 | #define IDO_WALKCMD_2 187
34 | #define IDO_CLICKDIALOGITEM 116
35 | #define IDO_SETCOMBATSTYLE 29
36 | #define IDO_WITHDRAW 22
37 | #define IDO_DEPOSIT 23
38 | #define IDO_CLOSE_BANK 212
39 | #define IDO_BUYITEM 236
40 | #define IDO_SELLITEM 221
41 | #define IDO_CLOSE_SHOP 166
42 | #define IDO_CANCEL_TRADE 230
43 | #define IDO_CONFIRM_TRADE 104
44 | #define IDO_TRADE_UPDATE 46
45 | #define IDO_ACCEPT_TRADE 55
46 | #define IDO_DUEL_CONFIRM_1 77
47 | #define IDO_DUEL_UPDATE 33
48 | #define IDO_DUEL_FLAG_1 8
49 | #define IDO_DUEL_FLAG_2 176
50 | #define IDO_CANCEL_DUEL 197
51 | #define IDO_PRAYER_OFF 254
52 | #define IDO_PRAYER_ON 60
53 | #define IDO_CHANGE_SETTINGS 111
54 |
55 | // action commands...
56 | #define IDO_CAST_GR_ITEM 249
57 | #define IDO_USEWITH_GR_ITEM 53
58 | #define IDO_TAKE_ITEM 247
59 | #define IDO_CAST_WALLOBJ 180
60 | #define IDO_USEWITH_WALLOBJ 161
61 | #define IDO_WALLOBJ_CMD1 14
62 | #define IDO_WALLOBJ_CMD2 127
63 | #define IDO_CAST_OBJECT 99
64 | #define IDO_USEWITH_OBJECT 115
65 | #define IDO_OBJECT_CMD1 136
66 | #define IDO_OBJECT_CMD2 79
67 |
68 | #define IDO_CAST_INVITEM 4
69 | #define IDO_USEWITH_INVITEM 91
70 | #define IDO_REMOVE_ITEM 170
71 | #define IDO_WEAR_ITEM 169
72 | #define IDO_INVITEM_CMD 90
73 | #define IDO_DROP_ITEM 246
74 |
75 | #define IDO_CAST_NPC 50
76 | #define IDO_USEWITH_NPC 135
77 | #define IDO_TALK_NPC 153
78 | #define IDO_NPC_CMD 202
79 | #define IDO_ATTACK_NPC 190
80 |
81 | #define IDO_CAST_PLAYER 229
82 | #define IDO_USEWITH_PLAYER 113
83 | #define IDO_ATTACK_PLAYER 171
84 | #define IDO_DUEL_PLAYER 103
85 | #define IDO_TRADE_PLAYER 142
86 | #define IDO_FOLLOW_PLAYER 165
87 |
88 | #define IDO_CAST_GROUND 158
89 | #define IDO_CAST_SELF 137
90 |
91 | #define IDO_REPORT_ABUSE 206
92 |
93 |
94 |
95 | |
96 | opcode
97 | |
98 |
99 | usage
100 | |
101 |
102 | size
103 | |
104 |
105 | payload
106 | |
107 |
108 |
109 | |
110 | |
111 |
112 | |
113 |
114 | |
115 |
116 | |
117 |
118 |
119 | == '''Outgoing Data''' == '''TODO:''' Document packet structures
120 |
121 | // login responses...
122 | #define IDX_MOD_ACCEPTED 25 // logged in as player mod
123 | #define IDX_LOGIN_SUCCESS 0
124 | #define IDX_RELOGIN_SUCCESS 1 // connection reestablished after lost connection...
125 | #define IDX_WRONG_PWD 3
126 | #define IDX_NAME_LOGGED_IN 4
127 | #define IDX_CLIENT_UPDATED 5
128 | #define IDX_IP_IN_USE 6
129 | #define IDX_LOGINS_EXCEEDED 7
130 | #define IDX_SERV_REJECTED 8
131 | #define IDX_LOGINSERV_REJCT 9
132 | #define IDX_NAME_IN_USE 10
133 | #define IDX_TEMP_DISABLED 11
134 | #define IDX_PERM_DISABLED 12
135 | #define IDX_SERVER_FULL 14
136 | #define IDX_MEMBERACC_REQ 15 // requires member account to login here
137 | #define IDX_LOGINSERV_DOWN 16
138 | #define IDX_DECODE_FAIL 17
139 | #define IDX_LOGIN_MISMATCH 20
140 |
141 | #define IDI_MESSAGE 131 // (game) messages from server
142 | #define IDI_LOGOUT 4 // logout command from server (forced, or initiated by client IDO_LOGOUT)
143 | #define IDI_LOGOUT_REJECT 183 // not allowed to log out (e.g. when in combat)
144 | #define IDI_FRIENDS_LOAD 71 // when logging in, sends the whole friends list to the client
145 | #define IDI_FRIEND_LOGGED 149 // a friend from friends list logged in or out (also used to add a friend to friends list)
146 | #define IDI_IGNORE_LOAD 109 // when logging in, sends the whole ignore list to the client
147 | #define IDI_SETTINGS_LOAD 51 // load settings upon logging in (blocks)
148 | #define IDI_FRIENDS_PM 120 // someone pm'd us
149 |
150 | #define IDI_PLAYER_MOVEMENT 191 // player movement update
151 | #define IDI_GRITEMS_UPDATE 99 // update ground items
152 | #define IDI_OBJECTS_UPDATE 48
153 | #define IDI_INV_LOAD 53 // load inventory
154 | #define IDI_PLAYER_UPDATE 234
155 | #define IDI_WALLOBJ_UPDATE 91
156 | #define IDI_NPC_MOVEMENT 79 // npc movement update
157 | #define IDI_NPC_UPDATE 104
158 | #define IDI_DIALOG_SHOW 245
159 | #define IDI_DIALOG_CLOSE 252
160 | #define IDI_LOAD_NEWMAPAREA 25 // entering a new region (maparea)
161 | #define IDI_XP_LOAD 156 // load xp and stats
162 | #define IDI_EQUIP_UPDATE 153 // equipment stats (armour, magic, prayer, weapaim/power)
163 | #define IDI_PLAYER_DIED 83
164 | #define IDI_LOADWORLD 211 // load objects, wallobjects, items
165 | #define IDI_DESIGN_CHAR 59
166 | #define IDI_OPEN_TRADE_1 92
167 | #define IDI_CLOSE_TRADE 128
168 | #define IDI_TRADE_UPDATE 97 // opponents offer was updated
169 | #define IDI_TRADE_B_UPDATE 162 // update of opponents acception status
170 | #define IDI_SHOP_OPEN 101
171 | #define IDI_SHOP_CLOSE 137
172 | #define IDI_TRADE_A_UPDATE 15 // update of thisplayers acception status
173 | #define IDI_LOAD_OPTIONS 240 // camera angle, sound, mousebutton settings
174 | #define IDI_PRAYER 206
175 | #define IDI_QUESTS 5
176 | #define IDI_BANK_OPEN 42
177 | #define IDI_BANK_CLOSE 203
178 | #define IDI_XP_UPDATE 33
179 | #define IDI_OPEN_DUEL_1 176
180 | #define IDI_CLOSE_DUEL 225
181 | #define IDI_OPEN_TRADE_2 20 // trade confirmation window
182 | #define IDI_DUEL_UPDATE 6 // opponents offer was updated
183 | #define IDI_DUELOPT_UPDATE 30 // update duel options
184 | #define IDI_BANK_UPDATE 249
185 | #define IDI_INV_ADD 90
186 | #define IDI_INV_REMOVE 123
187 | #define IDI_STAT_UPDATE 159
188 | #define IDI_DUEL_B_UPDATE 253 // update of opponents acception status
189 | #define IDI_DUEL_A_UPDATE 210 // update of thisplayers acception status
190 | #define IDI_OPEN_DUEL_2 172 // duel confirmation window
191 | #define IDI_SOUND 204
192 | #define IDI_SPLASH 36
193 | #define IDI_WELCOMEWINDOW 182
194 | #define IDI_MESSAGE_1 89
195 | #define IDI_MESSAGE_2 222
196 | #define IDI_FATIGUE_UPDATE 114
197 | #define IDI_NEW_SLEEPWORD 117
198 | #define IDI_FATIGUE_SLEEPN 244 // fatigue update in sleeping window
199 | #define IDI_SLEEP_SUCCESS 84
200 | #define IDI_SLEEP_FAILED 194
201 | #define IDI_SYSTEM_UPDATE 52
202 |
203 | #define IDX_ACCOUNT_STOLEN 18 // "Account suspected stolen.", "Press 'recover a locked account' on front page."
204 | #define IDX_ACCOUNT_NOT_RSC 21 // "Unable to login.", "That is not an RS-Classic account"
205 | #define IDX_PASSWD_STOLEN 22 // "Password suspected stolen.", "Press 'change your password' on front page."
206 |
207 |
208 |
209 | |
210 | opcode
211 | |
212 |
213 | usage
214 | |
215 |
216 | size
217 | |
218 |
219 | payload
220 | |
221 |
222 |
223 | |
224 | |
225 |
226 | |
227 |
228 | |
229 |
230 | |
231 |
232 |
233 |
--------------------------------------------------------------------------------
/src/SUMMARY.md:
--------------------------------------------------------------------------------
1 | # Summary
2 |
3 | - [Home](./Home.md)
4 | - [About](./About.md)
5 | - [Rules](./Rules.md)
6 | - [IRC](./IRC.md)
7 | - [General disclaimer](./General-disclaimer.md)
8 | - [DMCA policy](./DMCA-policy.md)
9 | - [Privacy policy](./Privacy-policy.md)
10 | - [Data](./Data.md)
11 | - [Data-types](./Data-Types.md)
12 | - [ISAAC cipher](./ISAAC-cipher.md)
13 | - [Word](./Word.md)
14 | - [DWord](./DWord.md)
15 | - [QWord](./QWord.md)
16 | - [RS String](./RS-String.md)
17 | - [JAGGRAB protocol](./JAGGRAB-Protocol.md)
18 | - [Ondemand protocol](./Ondemand-Protocol.md)
19 | - [Archive format](./Archive-Format.md)
20 | - [OB3](./OB3.md)
21 | - [Client functions](./Client-functions.md)
22 | - [Map region system](./Map-Region-System.md)
23 | - [Censorship](./Censorship.md)
24 | - [Mouse coordinate tracking](./Mouse-coordinate-tracking.md)
25 | - [Class-Check](./Class-Check.md)
26 | - [RuneScape Protocol](./RuneScape-Protocol.md)
27 | - [Protocol #135](./135-Protocol.md)
28 | - [Protocol #194](./194-Protocol.md)
29 | - [Clear-screen](./194-Clear-screen.md)
30 | - [Logout](./194-Logout.md)
31 | - [Show-interface](./194-Show-interface.md)
32 | - [Protocol #202](./202-Protocol.md)
33 | - [Protocol #204](./204-Protocol.md)
34 | - [Items](./204-Items.md)
35 | - [NPCs](./204-NPCs.md)
36 | - [Objects](./204-Objects.md)
37 | - [Protocol #289](./289-Protocol.md)
38 | - [Construct-Map-Region](./289-Construct-Map-Region.md)
39 | - [Player-Dialogue-Head](./289-Player-Dialogue-Head.md)
40 | - [Send-Player-Head](./289-Send-Player-Head.md)
41 | - [Send-sidebar-interface](./289-Send-sidebar-interface.md)
42 | - [Protocol #317](./317/317-Protocol.md)
43 | - [Add-friend](./317/317-Add-friend.md)
44 | - [Add-ignore](./317/317-Add-ignore.md)
45 | - [Alternate-item-option-2](./317/317-Alternate-item-option-2.md)
46 | - [Animation-reset](./317/317-Animation-reset.md)
47 | - [Attack-(NPC)](./317/317-Attack-(NPC).md)
48 | - [Audio](./317/317-Audio.md)
49 | - [Bank-10-items](./317/317-Bank-10-items.md)
50 | - [Bank-5-items](./317/317-Bank-5-items.md)
51 | - [Bank-all-items](./317/317-Bank-all-items.md)
52 | - [Bank-X-items-part-1](./317/317-Bank-X-items-part-1.md)
53 | - [Bank-X-items-part-2](./317/317-Bank-X-items-part-2.md)
54 | - [Begin-player-updating](./317/317-Begin-player-updating.md)
55 | - [Button-click](./317/317-Button-click.md)
56 | - [Camera-movement](./317/317-Camera-movement.md)
57 | - [Camera-shake](./317/317-Camera-shake.md)
58 | - [Chat-interface-click](./317/317-Chat-interface-click.md)
59 | - [Chat-interface](./317/317-Chat-interface.md)
60 | - [Chat-settings](./317/317-Chat-settings.md)
61 | - [Clear-inventory](./317/317-Clear-inventory.md)
62 | - [Clear-screen](./317/317-Clear-screen.md)
63 | - [Close-window](./317/317-Close-window.md)
64 | - [Construct-map-region](./317/317-Construct-map-region.md)
65 | - [Create-Projectile](./317/317-Create-Projectile.md)
66 | - [Design-screen](./317/317-Design-screen.md)
67 | - [Display-hint-icon](./317/317-Display-hint-icon.md)
68 | - [Drop-item](./317/317-Drop-item.md)
69 | - [Enter-name](./317/317-Enter-name.md)
70 | - [Equip-item](./317/317-Equip-item.md)
71 | - [Flash-sidebar](./317/317-Flash-sidebar.md)
72 | - [Focus-change](./317/317-Focus-change.md)
73 | - [Follow](./317/317-Follow.md)
74 | - [Force-client-setting](./317/317-Force-client-setting.md)
75 | - [Friends-list-status](./317/317-Friends-list-status.md)
76 | - [Ground-Item-Action](./317/317-Ground-Item-Action.md)
77 | - [Hidden-Interface](./317/317-Hidden-Interface.md)
78 | - [Idle-logout](./317/317-Idle-logout.md)
79 | - [Idle](./317/317-Idle.md)
80 | - [Initialize-player](./317/317-Initialize-player.md)
81 | - [Input-amount](./317/317-Input-amount.md)
82 | - [Interface-animation](./317/317-Interface-animation.md)
83 | - [Interface-color](./317/317-Interface-color.md)
84 | - [Interface-item](./317/317-Interface-item.md)
85 | - [Interface-model-rotation](./317/317-Interface-model-rotation.md)
86 | - [Interface-offset](./317/317-Interface-offset.md)
87 | - [Interface-over-tab](./317/317-Interface-over-tab.md)
88 | - [Inventory-overlay](./317/317-Inventory-overlay.md)
89 | - [Item-action-1](./317/317-Item-action-1.md)
90 | - [Item-on-floor](./317/317-Item-on-floor.md)
91 | - [Item-on-item](./317/317-Item-on-item.md)
92 | - [Item-on-object](./317/317-Item-on-object.md)
93 | - [Item-on-player](./317/317-Item-on-player.md)
94 | - [Light-item](./317/317-Light-item.md)
95 | - [Loading-finished](./317/317-Loading-finished.md)
96 | - [Load-map-region](./317/317-Load-map-region.md)
97 | - [Logout](./317/317-Logout.md)
98 | - [Mage-NPC](./317/317-Mage-NPC.md)
99 | - [Magic-on-items](./317/317-Magic-on-items.md)
100 | - [Magic-on-player](./317/317-Magic-on-player.md)
101 | - [Minimap-State](./317/317-Minimap-State.md)
102 | - [Mouse-click](./317/317-Mouse-click.md)
103 | - [Move-item](./317/317-Move-item.md)
104 | - [Music](./317/317-Music.md)
105 | - [NPC-action-1](./317/317-NPC-action-1.md)
106 | - [NPC-action-2](./317/317-NPC-action-2.md)
107 | - [NPC-action-3](./317/317-NPC-action-3.md)
108 | - [NPC-Dialogue](./317/317-NPC-Dialogue.md)
109 | - [NPC-head-on-interface](./317/317-NPC-head-on-interface.md)
110 | - [Object-action-1](./317/317-Object-action-1.md)
111 | - [Object-action-2](./317/317-Object-action-2.md)
112 | - [Object-action-3](./317/317-Object-action-3.md)
113 | - [Object-removal](./317/317-Object-removal.md)
114 | - [Object-spawn](./317/317-Object-spawn.md)
115 | - [Open-chatbox-interface](./317/317-Open-chatbox-interface.md)
116 | - [Open-welcome-screen](./317/317-Open-welcome-screen.md)
117 | - [Pickup-ground-item](./317/317-Pickup-ground-item.md)
118 | - [Player-command](./317/317-Player-command.md)
119 | - [Player-head-to-interface](./317/317-Player-head-to-interface.md)
120 | - [Player-Option](./317/317-Player-Option.md)
121 | - [Play-song](./317/317-Play-song.md)
122 | - [Privacy-options](./317/317-Privacy-options.md)
123 | - [Region-change](./317/317-Region-change.md)
124 | - [Remove-friend](./317/317-Remove-friend.md)
125 | - [Remove-ignore](./317/317-Remove-ignore.md)
126 | - [Report-player](./317/317-Report-player.md)
127 | - [Reset-button-state](./317/317-Reset-button-state.md)
128 | - [Reset-camera](./317/317-Reset-camera.md)
129 | - [Reset-destination](./317/317-Reset-destination.md)
130 | - [Run-energy](./317/317-Run-energy.md)
131 | - [Scroll-position](./317/317-Scroll-position.md)
132 | - [Send-add-friend](./317/317-Send-add-friend.md)
133 | - [Send-add-ignore](./317/317-Send-add-ignore.md)
134 | - [Send-message](./317/317-Send-message.md)
135 | - [Send-private-message](./317/317-Send-private-message.md)
136 | - [Send-sidebar-interface](./317/317-Send-sidebar-interface.md)
137 | - [Send-Skill](./317/317-Send-Skill.md)
138 | - [Set-interface-text](./317/317-Set-interface-text.md)
139 | - [Show-interface](./317/317-Show-interface.md)
140 | - [Show-multi-combat](./317/317-Show-multi-combat.md)
141 | - [Show-tab](./317/317-Show-tab.md)
142 | - [Skill-level](./317/317-Skill-level.md)
143 | - [Song-Queue](./317/317-Song-Queue.md)
144 | - [System-update](./317/317-System-update.md)
145 | - [Trade-answer](./317/317-Trade-answer.md)
146 | - [Trade-request](./317/317-Trade-request.md)
147 | - [Unequip-item](./317/317-Unequip-item.md)
148 | - [Update-item-container](./317/317-Update-item-container.md)
149 | - [Walkable-interface](./317/317-Walkable-interface.md)
150 | - [Weight](./317/317-Weight.md)
151 | - [Protocol #357](./357-Protocol.md)
152 | - [Protocol #377](./377/377-Protocol.md)
153 | - [Animation-Reset](./377/377-Animation-Reset.md)
154 | - [Camera-Shake](./377/377-Camera-Shake.md)
155 | - [Construct-Map-Region](./377/377-Construct-Map-Region.md)
156 | - [Create-Static-Graphic](./377/377-Create-Static-Graphic.md)
157 | - [Initialize-Player](./377/377-Initialize-Player.md)
158 | - [Input-Amount](./377/377-Input-Amount.md)
159 | - [Interface-Animation](./377/377-Interface-Animation.md)
160 | - [Interface-Item](./377/377-Interface-Item.md)
161 | - [Inventory-Overlay](./377/377-Inventory-Overlay.md)
162 | - [Logout](./377/377-Logout.md)
163 | - [Move-Camera](./377/377-Move-Camera.md)
164 | - [Open-Welcome-Screen](./377/377-Open-Welcome-Screen.md)
165 | - [Play-Ambient-Wave](./377/377-Play-Ambient-Wave.md)
166 | - [Reset-Button-State](./377/377-Reset-Button-State.md)
167 | - [Reset-Ground-Items-and-Objects](./377/377-Reset-Ground-Items-and-Objects.md)
168 | - [Run-Energy](./377/377-Run-Energy.md)
169 | - [Send-Add-Friend](./377/377-Send-Add-Friend.md)
170 | - [Send-Ground-Item](./377/377-Send-Ground-Item.md)
171 | - [Send-Message](./377/377-Send-Message.md)
172 | - [Send-Sidebar-Interface](./377/377-Send-Sidebar-Interface.md)
173 | - [Send-Sound](./377/377-Send-Sound.md)
174 | - [Skill-Level](./377/377-Skill-Level.md)
175 | - [Walkable-Interface](./377/377-Walkable-Interface.md)
176 | - [Protocol #443](./443-Protocol.md)
177 | - [Protocol #464](./464-Protocol.md)
178 | - [Protocol #468](./468-Protocol.md)
179 | - [Protocol #474](./474-Protocol.md)
180 | - [Fourth-Interface-Option](./474-Fourth-Interface-Option.md)
181 | - [Remove-ignore](./474-Remove-ignore.md)
182 | - [Protocol #508](./508-Protocol.md)
183 | - [Protocol #634](./634-Protocol.md)
184 | - [Protocol #666](./666-Protocol.md)
185 | - [Protocol #668](./668-Protocol.md)
186 | - [Protocol #718](./718-Protocol.md)
187 | - [Close-window](./718-Close-window.md)
188 | - [Friends-packet](./718-Friends-packet.md)
189 | - [Interface](./718-Interface.md)
190 | - [Music-effect](./718-Music-effect.md)
191 | - [Open-URL](./718-Open-URL.md)
192 | - [Player-under-NPC-priority](./718-Player-under-NPC-priority.md)
193 | - [Protocol #742](./742-Protocol.md)
194 |
--------------------------------------------------------------------------------