SWGANH Wiki - User contributions [en]

SOE Protocol Breakdown

2011-12-13T16:07:37Z

Mugly: /* Packet Type -- '''00 02''' */

{{PageHeader|Guides|SOE Protocol Breakdown}}
SOE's Protocol is a systematic way to enhance the UDP protocol to make it more reliable, and also save bandwidth by merging and grouping packets. It can be combined in various ways, or not be used at all.

The format of the SOE Protocol varies depending on what type of operation it is. SOE Protocol can function as a stand alone packet, or as a Header to SWG Packets. What is true about all of the SOE Protocol is that the beginning contains 2 bytes known as the SOE Opcode. Majority also contain a footer. Assume all packets have footers unless otherwise mentioned. The table of opcodes are as follows:

'''Note''' <font color=orange>''An SOE Opcode is stored as an unsigned short (uint16), and is in net byte order.''</font>

{{InfoboxPacketDetail|SOE OpCodes|
<pre>
(SOE Opcode)"in hex" (Meaning) ( (ENUM_NAME) "used in code"

00 01 Session Request (SOE_SESSION_REQUEST)
00 02 Session Response (SOE_SESSION_REPLY)
00 03 Multiple SOE Protocols (SOE_MULTI_SOE)
00 04 Not Used (SOE_NOT_USED)
00 05 Disconnect (SOE_DISCONNECT)
00 06 Keep Alive (SOE_PING)
00 07 Client Network Status Update (SOE_NET_STATUS_REQ)
00 08 Server Network Status Update (SOE_NET_STATUS_RES)

00 09 Channel 0 - Data Packet (SOE_CHL_DATA_A)
00 0A Channel 1 - Data Packet (SOE_CHL_DATA_B)
00 0B Channel 2 - Data Packet (SOE_CHL_DATA_C)
00 0C Channel 3 - Data Packet (SOE_CHL_DATA_D)

00 0D Channel 0 - Fragmented Data Packet (SOE_DATA_FRAG_A)
00 0E Channel 1 - Fragmented Data Packet (SOE_DATA_FRAG_B)
00 0F Channel 2 - Fragmented Data Packet (SOE_DATA_FRAG_C)
00 10 Channel 3 - Fragmented Data Packet (SOE_DATA_FRAG_D)

00 11 Channel 0 - Out of Order Packet (SOE_OUT_ORDER_PKT_A)
00 12 Channel 1 - Out of Order Packet (SOE_OUT_ORDER_PKT_B)
00 13 Channel 2 - Out of Order Packet (SOE_OUT_ORDER_PKT_C)
00 14 Channel 3 - Out of Order Packet (SOE_OUT_ORDER_PKT_D)

00 15 Channel 0 - Acknowledge Packet (SOE_ACK_A)
00 16 Channel 1 - Acknowledge Packet (SOE_ACK_B)
00 17 Channel 2 - Acknowledge Packet (SOE_ACK_C)
00 18 Channel 3 - Acknowledge Packet (SOE_ACK_D)

00 19 Channel 0 - Multi SWG Packets (SOE_MULTI_SWG_A)
00 1A Channel 1 - Multi SWG Packets (SOE_MULTI_SWG_B)
00 1B Channel 2 - Multi SWG Packets (SOE_MULTI_SWG_C)
00 1C Channel 3 - Multi SWG Packets (SOE_MULTI_SWG_D)

00 1D *Serious Error Acknowledge (SOE_FATAL_ERR)
00 1E *Serious Error Reply (SOE_FATAL_ERR_REP)
</pre>
}}

'''Note''' <font color=orange>''These functions are seen on very malformed packets. Very rare occurance and the client will usually disconnect. It's inclusion in the documentation is for completion ONLY. SWGEmu will disconnect automatically when reciving a Error Acknowledge, and it will NOT send any, rather just disconnect itself.''</font>

SOE has their protocol premade to allow various channels of data transmission. However, no game to this date utilizes the multiple channels. SWG will only be using channel 0 and it will be assumed throughout the rest of the packet documentation.

The following data is of packet breakdowns and explainations on each type. See the article "Packet Breakdown Format" for information on the specific used for documentation.

==Packet Type -- '''00 01'''==

{{InfoboxPacketDetail|Packet Type 00 01|
<pre>
00 01 - Session Request (Client -> Server)
SOE Opcode - Net Byte SHORT
CRC Length - Net BYte INT
Connection ID - Net Byte INT
ClientUDPSize - Net Byte INT
</pre>
}}

* '''SOE Opcode''' is just the opcode number to identify the packet.
* '''CRC Length''' is the amount of length of the CRC checksum to append at the end of a packet. SWG uses 2 bytes.
* '''Note''' <font color=orange>''CRC32 checksums are 32bit, making them 4 bytes, but only 2 are appended.''</font>
* '''Connection ID''' is some type of identification used for the connection. Only other time seen is during a disconnect.
* '''ClientUDPSize''' is the maximum size allocated for the client's UDP packet buffer. No packet is allowed to exceed this size. If it is larger, it must be fragmented. This size is equal to 496 bytes.

'''Note''' <font color=orange>''This opcode DOES NOT have a footer.''</font>

===Packet Samples -- '''00 01'''===

{{InfoboxPacketSample|Client MAX Session Request 0x0001|
<pre>0x0001</pre>
|<pre>00 00 00 02 27 38 24 61 00 00 01 F0</pre>
|<pre>....'8$a....</pre>
}}

{{InfoboxPacketSample|Client MIN Session Request 0x0001|
<pre>0x0001</pre>
|<pre>00 00 00 02 3C D6 0F BF 00 00 01 F0</pre>
|<pre>....<.......</pre>
}}

==Packet Type -- '''00 02'''==

{{InfoboxPacketDetail|Packet Type 00 02 - Session Response (Server -> Client)|
<pre>
SOE Opcode - Net Byte SHORT
Connection ID - Net Byte INT
CRCSeed - Net Byte INT
CRCLength - BYTE
UseCompression - BYTE
SeedSize - BYTE
ServerUDPSize - Net Byte INT
</pre>
}}

* '''Connection ID''' is replied using the same ID sent by the Session Request.
* '''CRCSeed''' is a seed value used for the calculation of the CRC32 Checksum.
* '''CRCLength'''
* '''UseCompression''' 0/1 Compression on/off
* '''SeedSize''' Size in bytes for the XOR encryption key. Strange that this appears after the CRCSeed. Seed seems to have a max value of 5bytes. Standard is 4
* '''ServerUDPSize''' is the maximum size allocated for the server's UDP packet buffer. No packet is allowed to exceed this size. So far the client has not sent anything large enough to fill this, or be fragmented. This size is equal to 496 bytes.

'''Note''' <font color=orange>''This opcode DOES NOT have a footer.''</font>

===Packet Sample -- ''00 02''===

{{InfoboxPacketSample|Server MAX SessionResponse 0x0002|
<pre>0x0002</pre>
|<pre>27 38 24 61 37 E4 BF 63 02 01 04 00 00 01 F0</pre>
|<pre>'8$a7..c.......</pre>
}}

{{InfoboxPacketSample|Server MIN SessionResponse 0x0002|
<pre>0x0002</pre>
|<pre>3C D6 0F BF 3B BF 9B D5 02 01 04 00 00 01 F0</pre>
|<pre><...;..........</pre>
}}

==Packet Type -- '''00 03'''==

{{InfoboxPacketDetail|Packet Type 00 03 - Multiple SOE Protocols(Various)|
<pre>
SOE Opcode - Net Byte SHORT
Data Size - (VARIOUS)
DATA - (VARIOUS)
Data Size - (VARIOUS)
DATA - (VARIOUS)
...
</pre>
}}

These packets allow the combination of 2 or more SOE Protocol packets or stand alone SWG Packets with SOE Protocol packets.

(SOE Protocol)((SOE Protocol)(SWG Packet)) or
(SOE Protocol)(SWG Packet)

or as a better example:

(Multiple SOE Proto)(Ackowledge)(Data) or
(Multiple SOE Proto)(Acknowledge)(SWG Packet) or
(Multiple SOE Proto)(Acknowledge)(Acknowledge)

Each seperate packet is preceded by it's size. So a better example would be:
(Multiple SOE Proto)(size1)(Acknowlede)(size2)(Data)

so a very basic hexadecimal version would be:

<pre>
(00 03) (04) (00 15 00 00) (0A) (00 09 00 01 01 00 FF FF FF FF)
multi size acknowledge size data
</pre>

* '''NOTE''': ''The Size field will never exceed 255.

===Packet Sample -- '''00 03'''===

{{InfoboxPacketSample|Server MAX MultiPacket 0x0003|
<pre>0x0003</pre>
|<pre>06 01 00 AF F9 6C A1 1C 0A 00 08 F8 24 1B A8 1C
95 AF 22 00 00 00 A2 54 40 01 2D 55 45 02 00 00
00 D1 00 00 1C 0A 00 08 F8 24 1B A2 04 95 AF 22
00 00 00 70 54 40 01 47 55 55 02 00 00 09 EB 00
00 1C 0A 00 08 F8 24 1B AC 04 95 AF 22 00 00 00
4E 54 40 01 5A 55 2D 01 00 00 0A EF 00 00 1C 0A
00 08 F8 24 1B 70 04 95 AF 22 00 00 00 48 54 40
01 16 55 17 02 00 00 0A 15 00 00 1C 0A 00 08 F8
24 1B DB FA 94 AF 22 00 00 00 72 54 40 01 5E 55
06 02 00 00 0A 30 00 00 1C 0A 00 08 F8 24 1B CA
FD 94 AF 22 00 00 00 13 54 40 01 86 56 C3 06 00
00 00 FC 00 00 1C 0A 00 08 F8 24 1B C0 FD 94 AF
22 00 00 00 11 54 40 01 87 56 96 06 00 00 00 FD
00 00 1C 0A 00 08 F8 24 1B 8E FD 94 AF 22 00 00
00 55 53 40 01 8C 57 FC 06 00 00 02 D2 00 00 1C
0A 00 08 F8 24 1B 70 FD 94 AF 22 00 00 00 61 53
40 01 BF 57 26 07 00 00 02 D2 00 00 1C 0A 00 08
F8 24 1B AC FD 94 AF 22 00 00 00 0F 54 40 01 86
56 AE 06 00 00 00 FD 00 00 C1 00 09 19 64 00 19
1C 0A 00 08 F8 24 1B 7A 04 95 AF 22 00 00 00 8D
54 41 01 B8 54 EA 04 00 00 00 02 00 00 1C 05 00
46 5E CE 80 1B 00 00 00 31 01 00 00 C9 1C 95 AF
22 00 00 00 00 00 00 00 0E 01 46 05 00 46 5E CE
80 1B 00 00 00 CC 00 00 00 AC 04 95 AF 22 00 00
00 00 00 00 00 C0 B1 16 F3 AC 04 95 AF 22 00 00
00 B2 04 95 AF 22 00 00 00 00 10 00 B7 2C 10 73
00 01 00 C9 1C 95 AF 22 00 00 00 0E 01 00 00 4D
0A 1C 0A 00 08 F8 24 1B B6 FD 94 AF 22 00 00 00
11 54 40 01 86 56 92 06 00 00 00 FD 00 00 1C 0A
00 08 F8 24 1B 0F F7 94 AF 22 00 00 00 C7 53 40
01 0E 56 5A 08 00 00 02 29 00 00</pre>
|<pre>.....l......$....."....T@.-UE...........
.$....."...pT@.GUU............$....."...
NT@.ZU-............$.p..."...HT@..U.....
........$....."...rT@.^U.....0.......$..
..."....T@..V.............$....."....T@.
.V.............$....."...US@..W.........
....$.p..."...aS@..W&............$....."
....T@..V............d.......$.z..."....
TA..T...........F^......1.......".......
..F..F^.............."..............."..
.....".......,.s.......".......M......$.
...."....T@..V.............$....."....S@
..VZ....)..</pre>
}}

{{InfoboxPacketSample|Server MIN MultiPacket 0x0003|
<pre>0x0003</pre>
|<pre>04 00 11 01 8E 04 00 11 01 8F</pre>
|<pre>..........</pre>
}}

{{InfoboxPacketSample|Client MAX MultiPacket 0x0003|
<pre>0x0003</pre>
|<pre>04 00 15 0B 1E 9E 00 09 07 9E 00 19 2E 05 00 46
5E CE 80 23 00 00 00 16 01 00 00 13 6C 35 E3 16
00 00 00 00 00 00 00 80 00 00 00 02 B7 A8 D6 9B
FC 19 AE 1A 00 00 00 00 00 00 00 22 05 00 46 5E
CE 80 83 00 00 00 26 01 00 00 13 6C 35 E3 16 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 22 05
00 46 5E CE 80 83 00 00 00 26 01 00 00 13 6C 35
E3 16 00 00 00 00 00 00 00 DF B5 1A AE 1A 00 00
00 22 05 00 46 5E CE 80 83 00 00 00 26 01 00 00
13 6C 35 E3 16 00 00 00 00 00 00 00 9B FC 19 AE
1A 00 00 00 4F 05 00 46 5E CE 80 21 00 00 00 F1
00 00 00 13 6C 35 E3 16 00 00 00 00 00 00 00 81
49 E9 85 A2 01 00 00 EF B4 1A AE 1A 00 00 00 00
00 00 00 33 FD 68 BD 00 00 00 00 E5 95 7F 3F D8
AE 3E 3F 33 33 33 3F CA 56 49 40 00 00 00 41 00
00 00 00 00 F0 00 09 07 9F 00 19 2E 05 00 46 5E
CE 80 23 00 00 00 16 01 00 00 13 6C 35 E3 16 00
00 00 00 00 00 00 80 00 00 00 02 B7 A8 D6 9B FC
19 AE 1A 00 00 00 00 00 00 00 22 05 00 46 5E CE
80 83 00 00 00 26 01 00 00 13 6C 35 E3 16 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 22 05 00
46 5E CE 80 83 00 00 00 26 01 00 00 13 6C 35 E3
16 00 00 00 00 00 00 00 9B FC 19 AE 1A 00 00 00
2E 05 00 46 5E CE 80 23 00 00 00 16 01 00 00 13
6C 35 E3 16 00 00 00 00 00 00 00 80 00 00 00 02
B7 A8 D6 9B FC 19 AE 1A 00 00 00 00 00 00 00 22
05 00 46 5E CE 80 83 00 00 00 26 01 00 00 13 6C
35 E3 16 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 22 05 00 46 5E CE 80 83 00 00 00 26 01 00
00 13 6C 35 E3 16 00 00 00 00 00 00 00 9B FC 19
AE 1A 00 00 00</pre>
|<pre>...............F^..#........l5..........
..................."..F^......&....l5...
.............."..F^......&....l5........
........."..F^......&....l5.............
....O..F^..!........l5..........I.......
...........3.h.......?..>?333?.VI@...A.
..............F^..#........l5...........
.................."..F^......&....l5....
............."..F^......&....l5.........
...........F^..#........l5..............
..............."..F^......&....l5.......
.........."..F^......&....l5............
.....</pre>
}}

{{InfoboxPacketSample|Client MIN MultiPacket 0x0003|
<pre>0x0003</pre>
|<pre>04 00 15 02 0B 04 00 15 02 0F</pre>
|<pre>..........</pre>
}}

==Packet Type -- '''00 05'''==

{{InfoboxPacketDetail|Packet Type 00 05 - Disconnect (VARIOUS)|
<pre>
SOE Opcode - Net Byte SHORT
Connection ID - Net Byte INT
Reason ID - Net Byte SHORT
</pre>
}}

* '''Connection ID''' is the ID number assigned during the session request. Each client sends its own Connection ID. Reason ID is an ID number that corresponds for a reason for the disconnection.

This packet is sent whenever one side wants to disconnect. It resends the clients specific Connection ID established during the session handshake, and then a reason for disconnection. So far the standard reason ID seen has been 6. Others have been tested and do not have any different effect.

<font color=red>'''No table correspnding IDs to reasons has been located.'''</font>

==Packet Type -- '''00 06'''==

{{InfoboxPacketDetail|00 06 - Keep Alive(VARIOUS)|
<pre>
SOE Opcode - Comp / CRC
</pre>
}}

This packet is simply a keep alive to tell the other side that is still connected, but idle. It only consists of the opcode and a footer.

===Packet Samples -- '''00 06'''===

{{InfoboxPacketSample|Server MAX Ping 0x0006|
<pre>0x0006</pre>
|<pre>CB 3A 78</pre>
|<pre>.:x</pre>
}}

{{InfoboxPacketSample|Server MIN Ping 0x0006|
<pre>0x0006</pre>
|<pre>16 01 A7</pre>
|<pre>...</pre>
}}

{{InfoboxPacketSample|Client MAX Ping 0x0006|
<pre>0x0006</pre>
|<pre>C7 23 8F</pre>
|<pre>.#.</pre>
}}

{{InfoboxPacketSample|Client MIN Ping 0x0006|
<pre>0x0006</pre>
|<pre>CB 3A 78</pre>
|<pre>.:x</pre>
}}

==Packet Type -- '''00 07'''==

{{InfoboxPacketDetail|00 07 - Client Network Status Update|
<pre>
SOE Opcode - Net Byte SHORT
Client TickCount - Net Byte SHORT
Last update - Net Byte INT
Average update - Net Byte INT
Shortest update - Net Byte INT
Longest update - Net Byte INT
Last Server update - Net Byte INT
Packets sent - Net Byte LONG
Packets received - Net Byte LONG
</pre>
}}

These packets consist of various data and network statistics. Because we do not care about network statistics, we will ignore these. To ignore these we send a special malformed Server Network Status Update.

'''Note''': <font color=orange>''This packet is usually compressed but is optional.''</font>

===Packet Samples -- '''00 07'''===

{{InfoboxPacketSample|Client MAX NetStatRequest 0x0007|
<pre>0x0007</pre>
|<pre>CA 3A 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 02 00 00
00 00 00 00 00 01</pre>
|<pre>.:....................................</pre>
}}

{{InfoboxPacketSample|Client MIN NetStatRequest 0x0007|
<pre>0x0007</pre>
|<pre>D2 C7 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 02 00 00
00 00 00 00 00 01 </pre>
|<pre>......................................</pre>
}}

==Packet Type -- '''00 08'''==

{{InfoboxPacketDetail|00 08 - Server Network Status Update|
<pre>
SOE Opcode - Net Byte SHORT
Client TickCount - Net Byte SHORT (As in request)
Server TickCount - Net Byte INT (I think this should be old server tickcount + client tickcount)
client packets sent - Net Byte LONG
client packets received - Net Byte LONG
server packets sent - Net Byte LONG
server packets received - Net Byte LONG
</pre>
}}
===Packet Samples -- '''00 08'''===
{{InfoboxPacketSample|Server MIN NetStatResponse 0x0008|
<pre>0x0008</pre>
|<pre>D2 C7 90 96 3F 20 00 00 00 00 00 00 00 02 00 00
00 00 00 00 00 01 00 00 00 00 00 00 00 02 00 00
00 00 00 00 00 02 </pre>
|<pre>....?.................................</pre>
}}

{{InfoboxPacketSample|Server MAX NetStatResponse 0x0008|
<pre>0x0008</pre>
|<pre>CA 3A 63 75 DB 1D 00 00 00 00 00 00 00 02 00 00
00 00 00 00 00 01 00 00 00 00 00 00 00 02 00 00
00 00 00 00 00 02 </pre>
|<pre>.:cu..................................</pre>
}}

{{InfoboxPacketSample|Client MIN NetStatResponse 0x0008|
<pre>0x0008</pre>
|<pre>00 B9 6F 02 76 00 00 30 00 75 00 FE 7F 5F A8 2B
CF 00 00 00 00 07 08 00 C6 27 F7 90 </pre>
|<pre>..o.v..0.u.._.+.........'..</pre>
}}

{{InfoboxPacketSample|Client MAX NetStatResponse 0x0008|
<pre>0x0008</pre>
|<pre>00 B9 6F 02 76 00 00 31 00 75 00 FE 7F 5F A8 2B
CF 00 00 00 00 00 00 00 D3 03 F7 90 </pre>
|<pre>..o.v..1.u.._.+............</pre>
}}

This packet is supposed to contain the Servers network statistics, however we felt it was a waste of time to reverse
these as we do not care about the statistics. Instead we send 38 bytes of 0x00, and then compress the packet, but skip appending a CRC.
The client seems to register that it recieved the servers statistics, but notices a bad CRC (or none in our case),
and tosses out the packet as malformed. Because it recieved the packet it continues on without erroring.

Note: This packet is usually compressed but is optional.

==Packet Type -- '''00 09'''==

{{InfoboxPacketDetail|00 09 - Channel 0 Data|
<pre>
SOE Opcode - Net Byte SHORT
Sequence # - Net Byte SHORT
SWG PACKET..
</pre>
}}

===Packet Samples -- '''00 09'''===

{{InfoboxPacketSample|Server MIN DataChannel 0x0009|
<pre>0x0009</pre>
|<pre>00 03 01 00 BE E9 2F D7 </pre>
|<pre>....../.</pre>
}}

{{InfoboxPacketSample|Server MAX DataChannel 0x0009|
<pre>0x0009</pre>
|<pre>54 06 00 19 A4 05 00 2A 2F F1 F3 F2 BB 21 B6 1E
00 00 00 00 00 04 00 00 00 09 00 63 6F 6E 64 69
74 69 6F 6E 07 00 00 00 31 00 30 00 30 00 2F 00
31 00 30 00 30 00 06 00 76 6F 6C 75 6D 65 01 00
00 00 31 00 2D 00 63 61 74 5F 73 6B 69 6C 6C 5F
6D 6F 64 5F 62 6F 6E 75 73 2E 40 73 74 61 74 5F
6E 3A 73 74 72 65 6E 67 74 68 5F 6D 6F 64 69 66
69 65 64 02 00 00 00 31 00 37 00 20 00 40 70 72
6F 63 2F 70 72 6F 63 3A 72 65 71 75 69 72 65 64
5F 63 6F 6D 62 61 74 5F 6C 65 76 65 6C 02 00 00
00 38 00 35 00 FF FF FF FF 26 05 00 2A 2F F1 F3
D5 C5 21 B6 1E 00 00 00 00 00 01 00 00 00 06 00
76 6F 6C 75 6D 65 01 00 00 00 31 00 FF FF FF FF
FF 01 18 05 00 2A 2F F1 F3 D6 C5 21 B6 1E 00 00
00 00 00 08 00 00 00 06 00 76 6F 6C 75 6D 65 01
00 00 00 31 00 20 00 40 70 72 6F 63 2F 70 72 6F
63 3A 72 65 71 75 69 72 65 64 5F 63 6F 6D 62 61
74 5F 6C 65 76 65 6C 02 00 00 00 32 00 30 00 15
00 40 70 72 6F 63 2F 70 72 6F 63 3A 72 65 75 73
65 5F 74 69 6D 65 07 00 00 00 35 00 20 00 2F 00
20 00 73 00 65 00 63 00 17 00 40 70 72 6F 63 2F
70 72 6F 63 3A 65 66 66 65 63 74 5F 6C 65 76 65
6C 02 00 00 00 32 00 30 00 14 00 40 70 72 6F 63
2F 70 72 6F 63 3A 70 72 6F 63 5F 6E 61 6D 65 18
00 00 00 40 00 75 00 69 00 5F 00 62 00 75 00 66
00 66 00 3A 00 61 00 67 00 69 00 63 00 6F 00 6E
00 73 00 75 00 6D 00 61 00 62 00 6C 00 65 00 31
00 35 00 04 00 74 69 65 72 01 00 00 00 32 00 0C
00 74 6F 6F 6C 74 69 70 2E 74 69 65 72 01 00 00
00 32 00 0C 00 6E 75 6D 5F 69 6E 5F 73 74 61 63
6B 01 00 00 00 36 00 FF FF FF FF </pre>
|<pre>T......*/....!.............condition....
1.0.0./.1.0.0...volume....1.-.cat_skill_
mod_bonus.@stat_n:strength_modified....1
.7...@proc/proc:required_combat_level...
.8.5.....&..*/....!.............volume..
..1..........*/....!.............volume.
...1...@proc/proc:required_combat_level.
...2.0...@proc/proc:reuse_time....5.../.
..s.e.c...@proc/proc:effect_level....2.0
...@proc/proc:proc_name....@.u.i._.b.u.f
.f.:.a.g.i.c.o.n.s.u.m.a.b.l.e.1.5...tie
r....2...tooltip.tier....2...num_in_stac
k....6.....</pre>
}}

{{InfoboxPacketSample|Client MIN DataChannel 0x0009|
<pre>0x0009</pre>
|<pre>01 F5 01 00 E0 5E 80 31 </pre>
|<pre>.....^.1</pre>
}}

{{InfoboxPacketSample|Client MAX DataChannel 0x0009|
<pre>0x0009</pre>
|<pre>20 46 05 00 46 5E CE 80 23 00 00 00 16 01 00 00
48 12 06 E1 01 00 00 00 00 00 00 00 80 0D 00 00
EF 50 45 16 00 00 00 00 00 00 00 00 DD 00 00 00
36 00 37 00 32 00 37 00 33 00 37 00 31 00 34 00
33 00 30 00 36 00 20 00 30 00 20 00 31 00 30 00
38 00 37 00 38 00 36 00 38 00 39 00 30 00 33 00
39 00 37 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 38 00 36 00 39 00 31 00 39 00 39 00
30 00 33 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 38 00 37 00 30 00 39 00 30 00 37 00
32 00 34 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 38 00 37 00 31 00 31 00 37 00 37 00
33 00 31 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 39 00 35 00 31 00 36 00 33 00 36 00
34 00 37 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 39 00 35 00 31 00 36 00 38 00 32 00
32 00 34 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 39 00 35 00 31 00 39 00 30 00 37 00
33 00 30 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 39 00 35 00 32 00 31 00 34 00 35 00
31 00 30 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 39 00 35 00 32 00 34 00 33 00 39 00
34 00 38 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 39 00 35 00 32 00 39 00 30 00 38 00
31 00 39 00 20 00 2D 00 31 00 20 00 31 00 30 00
38 00 37 00 39 00 35 00 32 00 39 00 35 00 30 00
39 00 37 00 20 00 2D 00 31 00 20 00 31 00 31 00
30 00 36 00 30 00 36 00 34 00 34 00 32 00 35 00
37 00 36 00 20 00 30 00 20 00 31 00 31 00 30 00
36 00 37 00 39 00 33 00 38 00 33 00 35 00 31 00
36 00 20 00 2D 00 31 00 20 00 </pre>
|<pre>.F..F^..#.......H................PE.....
........6.7.2.7.3.7.1.4.3.0.6...0...1.0.
8.7.8.6.8.9.0.3.9.7...-.1...1.0.8.7.8.6.
9.1.9.9.0.3...-.1...1.0.8.7.8.7.0.9.0.7.
2.4...-.1...1.0.8.7.8.7.1.1.7.7.3.1...-.
1...1.0.8.7.9.5.1.6.3.6.4.7...-.1...1.0.
8.7.9.5.1.6.8.2.2.4...-.1...1.0.8.7.9.5.
1.9.0.7.3.0...-.1...1.0.8.7.9.5.2.1.4.5.
1.0...-.1...1.0.8.7.9.5.2.4.3.9.4.8...-.
1...1.0.8.7.9.5.2.9.0.8.1.9...-.1...1.0.
8.7.9.5.2.9.5.0.9.7...-.1...1.1.0.6.0.6.
4.4.2.5.7.6...0...1.1.0.6.7.9.3.8.3.5.1.
6...-.1...</pre>
}}

Sequence # is a sequence number applied to every data packet. It increments in order for each packet and is used to help determine
out of order packets. This protocol is used to send an SWG Packet that NEEDS to be recieved by the other end.
The reciver is then supposed to respond with a an ACKNOWLEDGE packet that contains the same sequence so the sender knows it
has been recieved. This system ensures packets not only get sent correctly, but also stay in order.

After the sequence # comes the encapsulated SWG Packet.

Note* it is possible to combine multiple SWG PACKETs into a single 09.
This is done similar to the 0x0003 packet, a multi data example:
<pre>
(00 09) (sequence) (00 19) (Size1) (SWG PACKET) (Size2) (SWG PACKET)
SOE op. sequence multi size data size data
</pre>
if the Size byte is FF the following 2 bytes are the size Word Little ended (16bit).
Example:
<pre>
(00 09) (sequence) (00 19) (size byte) (size word) (SWG PACKET) (size byte) (SWG PACKET)
SOE op. sequence multi FF 01 99 data 33 data
</pre>
In the above the first packet size is 409 Dec.

Use these to combine SWG PACKETs together into 1 data packet/sequence number.

==Packet Type -- '''00 0D'''==

{{InfoboxPacketDetail|00 0D - Fragmented Data Packet|
<pre>
SOE Opcode - Net Byte SHORT
Sequence # - Net Byte SHORT
*FragmentSize - Net Byte INT
SWG Packet...
</pre>
}}
===Packet Samples -- '''00 0D'''===
{{InfoboxPacketSample|Client MIN DataFrag 0x000D|
<pre>0x000D</pre>
|<pre>04 CC 00</pre>
|<pre>...</pre>
}}

{{InfoboxPacketSample|Client MAX DataFrag 0x000D|
<pre>0x000D</pre>
|<pre>00 02 00 00 02 00 03 00 B9 63 1C C1 1B 00 00 00
02 00 00 00 04 00 42 72 69 61 80 8F FF FF 03 00
00 00 05 00 41 68 61 7A 69 80 8F FF FF 0C 00 00
00 06 00 46 6C 75 72 72 79 80 8F FF FF 0D 00 00
00 08 00 49 6E 74 72 65 70 69 64 80 8F FF FF 0E
00 00 00 09 00 4B 65 74 74 65 6D 6F 6F 72 80 8F
FF FF 0F 00 00 00 07 00 4E 61 72 69 74 75 73 80
8F FF FF 10 00 00 00 06 00 53 63 79 6C 6C 61 80
8F FF FF 11 00 00 00 09 00 53 75 6E 72 75 6E 6E
65 72 80 8F FF FF 12 00 00 00 06 00 56 61 6C 63
79 6E 80 8F FF FF 13 00 00 00 07 00 54 65 6D 70
65 73 74 80 8F FF FF 28 00 00 00 0C 00 4A 61 70
61 6E 2D 4B 61 74 61 6E 61 00 00 00 00 29 00 00
00 0B 00 4A 61 70 61 6E 2D 48 61 72 6C 61 00 00
00 00 19 00 00 00 09 00 53 74 61 72 73 69 64 65
72 80 8F FF FF 1A 00 00 00 09 00 54 61 72 71 75
69 6E 61 73 80 8F FF FF 1B 00 00 00 0A 00 57 61
6E 64 65 72 68 6F 6D 65 80 8F FF FF 1C 00 00 00
0A 00 53 68 61 64 6F 77 66 69 72 65 80 8F FF FF
05 00 00 00 08 00 42 6C 6F 6F 64 66 69 6E 80 8F
FF FF 06 00 00 00 09 00 43 68 69 6C 61 73 74 72
61 80 8F FF FF 07 00 00 00 07 00 45 63 6C 69 70
73 65 80 8F FF FF 08 00 00 00 06 00 47 6F 72 61
74 68 80 8F FF FF 09 00 00 00 05 00 4B 61 75 72
69 80 8F FF FF 0A 00 00 00 05 00 4C 6F 77 63 61
80 8F FF FF 0B 00 00 00 07 00 52 61 64 69 61 6E
74 80 8F FF FF 04 00 00 00 09 00 43 6F 72 62 61
6E 74 69 73 80 8F FF FF 22 00 00 00 0F 00 45 75
72 6F 70 65 2D 43 68 69 6D 61 65 72 61 80 8F FF
FF 23 00 00 00 0E 00 45 75 72 6F 70 65 2D 46 61
72 53 74 61 72 80 8F FF FF 24 00 </pre>
|<pre>.........c............Bria..........Ahaz
i..........Flurry..........Intrepid.....
.....Kettemoor..........Naritus.........
.Scylla..........Sunrunner..........Valc
yn..........Tempest....(.....Japan-Katan
a....).....Japan-Harla..........Starside
r..........Tarquinas..........Wanderhome
..........Shadowfire..........Bloodfin..
........Chilastra..........Eclipse......
....Gorath..........Kauri..........Lowca
..........Radiant..........Corbantis....
".....Europe-Chimaera....#.....Europe-Fa
rStar....$.</pre>
}}

* '''Sequence #''' is the same type of sequence number described in the "00 09 - Channel 0 Data" section. All the same rules apply.

* '''FragmentSize''' is the total size of the combined fragments. This only appears in the FIRST packet of a group of fragmented packets.

Next is just the piece data of the large SWG Packet. Fragments are made when the total UNCOMPRESSED packet exceeds the packet buffer size, which is 496 bytes.

==Packet Type -- '''00 11'''==

{{InfoboxPacketDetail|Packet Type 00 11 - Out of Order Packet|
<pre>
SOE Opcode - Net Byte SHORT
Sequence # - Net Byte SHORT
</pre>
}}
===Packet Samples -- '''00 11'''===
{{InfoboxPacketSample|Server MIN DataOrder 0x0011|
<pre>0x0011</pre>
|<pre>0B A0 </pre>
|<pre>..</pre>
}}

{{InfoboxPacketSample|Server MAX DataOrder 0x0011|
<pre>0x0011</pre>
|<pre>0B 87 </pre>
|<pre>..</pre>
}}

{{InfoboxPacketSample|Client MIN DataOrder 0x0011|
<pre>0x0011</pre>
|<pre>20 C8 </pre>
|<pre>..</pre>
}}

{{InfoboxPacketSample|Client MAX DataOrder 0x0011|
<pre>0x0011</pre>
|<pre>20 C7 </pre>
|<pre>..</pre>
}}

Sequence # is the sequence number of the out of order packet recieved.
It will send one for every packet that is out of order, and the ones following.

So if packet sequences recieved are:

<pre>
00 00
00 01
</pre>

And then:

<pre>
00 03
</pre>

an out of order will be sent for the packet with sequence 00 03.

If the packet sequences recieved are:
<pre>
00 00
00 01
</pre>

And then:

<pre>
00 03
00 04
00 05
</pre>

An out of order packet will be sent for all 3 of the out of order sequences.

==Packet Type -- '''00 15'''==

{{InfoboxPacketDetail|Packet Type 00 15 - Acknowledge|
<pre>
SOE Opcode - Net Byte SHORT
Sequence # - Net Byte SHORT
</pre>
}}
===Packet Samples -- '''00 15'''===
{{InfoboxPacketSample|Server MIN DataAck 0x0015|
<pre>0x0015</pre>
|<pre>00 00 </pre>
|<pre>..</pre>
}}

{{InfoboxPacketSample|Server MAX DataAck 0x0015|
<pre>0x0015</pre>
|<pre>00 00 </pre>
|<pre>..</pre>
}}

{{InfoboxPacketSample|Client MIN DataAck 0x0015|
<pre>0x0015</pre>
|<pre>00 00 </pre>
|<pre>..</pre>
}}

{{InfoboxPacketSample|Client MAX DataAck 0x0015|
<pre>0x0015</pre>
|<pre>00 00 </pre>
|<pre>..</pre>
}}

* '''Sequence #''' is the sequence number of the packet to acknowledge to the sender that it was recieved correctly.
Every packet sent with a sequence number MUST be acknowledeged.

They do not neccesarily need to be Acknowledeged 1 by 1. For example:
If packet sequences recieved are:
00 00
00 01
00 02

An Acknowledge of 00 15 00 02 will cover all the packets up to the sequence 00 02.

The client will stop processing packets after about 4 unacknowledeged packets so frequent acknowledges are needed.

==Appendix==

[[SWGPacketExamples|SWG Packet Examples used in this document]]

<font color=blue>'''Thanks to Acid1789 for the abundant information on the SOE Protocol!'''</font>

SuiCreatePageMessage

2009-10-31T23:15:38Z

Mugly: /* Variable Descriptions */

{{PageHeader|Server Packet|SuiCreatePageMessage (D44B7259)}}
{| border="0" width="90%" cellpadding=6
|-
|valign=top|
===Struct===
----
{| align="center"
|-
||
{| class="wikitable"
|-
|{{short}}|'''Opperand Count'''
|-
|{{int}}|'''opcode'''
|-
|{{int}}|'''window ID'''
|-
|{{a_string}}|'''UI Script Name'''
|-
|{{int}}|'''List Size'''
|-
|{{byte}}|'''Change Identifier'''
|-
|align="center" style="background:#C6C600; color:white;"|'''...'''||'''...'''
|}
{| border="0" width="90%" cellpadding=6
|-
|valign=top|

<pre>
case 01: {

INT: List Size
INT: List Size
A_String: New List Location }

case 02: { unknown }

case 03: {

INT: List Size
U_String: New Variable Value

INT: List Size
A_String: Variable Location
A_String: Variable to be changed }

case 04: {
INT: List Size
U_String: New variable default value

INT: List Size
A_String: New variable location
A_String: New variable name }

case 05: {
INT: List Size

INT: List Size
A_String: Strange String ("09")
A_String: Strange String ("0A")
A_String: Function Receiving Text
{ inputBox and listBox only
A_String: Input Name
A_String: Input Type
A_String: Variable Location
A_String: Variable Name
}

}
</pre>
|valign=top|
|}

{| class="wikitable"
|-
|{{long}}|'''Object Id'''
|-
|{{float}}|'''Max Distance'''
|-
|{{long}}|{{unknown}}
|}
|}

===Variable Descriptions===
----

Operand_Count = '''2'''

Opcode = '''D44B7259'''
----
*'''Script Name''' = Script.Name -- ( <page Name="this is what goes after the .">
: Note: Sometimes Script. needs to be omitted
*'''window ID''' = Unique ID used to identify window in the SuiEventNotifaction packet
*'''Change Identifier''' = Identifies change that is to be made to the *.inc file
*'''New Variable Value''' = Unicode String of what the new value should be... this is always Unicode no matter variable type
*'''Variable Location''' = In the .inc File you see <page Name="page1"> you would send page1. In the case of the variable being in a nested page tag EX: <page name="Page1"><page name="SubPage1"></page><page name="SubPage2"></page></page>Then you'd send Page1.SubPage1 or Page1.SubPage2
*'''Variable To Be Changed''' = Variable at above location that is being modified.
*'''@STF:StringName''' = The format to get strings from *.stf file.
:EX: @guild:create_name_prompt is @string/en/guild.stf:create_name_prompt.

*'''Object Id''' = Any object Id. Used for the Cui3dViewer widget
*'''Max distance''' = The window is closed if the distance to object is greater than this value. Use 0 to allow any distance.
*'''NOTE: There is more to this packet to explore!!!'''

|valign=top|

===Tags===
----
{| align="center"
|-
||{{ServerPacket}}
|-
||{{75%}}
|-
|}

===Comments===
----
:The \ui\*.inc files need to be studied while trying to understand this file. They contain the basic template of the ui box. The variables in that file get changed in order to customize the box to suit your needs.

'''Change Identifier'''
*01 - creates a new element
*02 - unknown
*03 - modifies a variable in an element
*04 - defines a variable in an element
*05 - defines script name and input type

:NOTE: Input Boxes need to be better documented. The input box appears to need to be created with the packet.

|}

===Example Packet===
----

====Input Box Example====
02 00 //WORLDUPDATE
59 72 4B D4 //SuiCreatePageMessage
83 52 02 00 //UI Window ID
0F 00 //String Size(15)
53 63 72 69 70 74 2E 69 6E 70 75 74 42 6F 78 //Script.inputBox
0C 00 00 00 //# of Variable Updates
//--------------------cmbInput Is Created Here----------------------------------
05 //change Identifier
00 00 00 00 //Number of Variable Changes
07 00 00 00 //List Size
00 00 //unknown String 1
01 00 09 //unknown String 2
19 00 //String Size(25)
6F 6E 47 75 69 6C 64 43 72 65 61 74 65 4E
61 6D 65 52 65 73 70 6F 6E 73 65 //onGuildCreateNameResponse
08 00 //String Size(8)
74 78 74 49 6E 70 75 74 //txtInput
09 00 //String Size(9)
4C 6F 63 61 6C 54 65 78 74 //LocalText
08 00 //String Size(8)
63 6D 62 49 6E 70 75 74 //cmbInput
0C 00 //String Size(12)
53 65 6C 65 63 74 65 64 54 65 78 74 //SelectedText
//-----------------------cmbInput Is Created Here-------------------------------------------
05 //Change Identifier
00 00 00 00 //num of Variable Changes
07 00 00 00 //list size
00 00 //unknown string 1
01 00 0A //unknown string 2
19 00 //String Size(25)
6F 6E 47 75 69 6C 64 43 72 65 61 74
65 4E 61 6D 65 52 65 73 70 6F 6E 73 65 //onGuildCreateNameResponse
08 00 //String Size(8)
74 78 74 49 6E 70 75 74 //txtInput
09 00 //String Size(9)
4C 6F 63 61 6C 54 65 78 74 //LocalText
08 00 //String Size(8)
63 6D 62 49 6E 70 75 74 //cmbInput
0C 00 //String Size(12)
53 65 6C 65 63 74 65 64 54 65 78 74 //SelectedText
//------lblPromp's Text Is changed to string/en/guild.stf StringName:create_name_prompt-----------
03 //Change Type
01 00 00 00 //List Size
19 00 00 00 //UNICODE STRING SIZE(25)
40 00 67 00 75 00 69 00 6C 00 64 00
3A 00 63 00 72 00 65 00 61 00 74 00
65 00 5F 00 6E 00 61 00 6D 00 65 00
5F 00 70 00 72 00 6F 00 6D 00 70 00 74 00 //UNICODE (@guild:create_name_prompt)
02 00 00 00 //List Size
10 00 //String Size(16)
50 72 6F 6D 70 74 2E 6C 62 6C 50
72 6F 6D 70 74 //Prompt.lblPrompt
04 00 //String Size(4)
54 65 78 74 //Text
//-------------Title is changed to @guild:create_name_title-----------------------------------
03 //Change Type
01 00 00 00 //List Size
18 00 00 00 //UNICODE STRING SIZE(24)
40 00 67 00 75 00 69 00 6C 00 64 00 3A 00
63 00 72 00 65 00 61 00 74 00 65 00 5F 00
6E 00 61 00 6D 00 65 00 5F 00 74 00 69 00
74 00 6C 00 65 00 //UNICODE (@guild:create_name_title )
02 00 00 00 //List Size
13 00 //String Size(19)
62 67 2E 63 61 70 74 69 6F 6E 2E 6C 62 6C
54 69 74 6C 65 //bg.caption.lblTitle
04 00 //String Size(4)
54 65 78 74 //Text
//------------Set Cancel Button to string/en/sui.stf StringName cancel------------
03 //Change Type
01 00 00 00 //List Size
07 00 00 00 //UNICODE STRING SIZE(7)
40 00 63 00 61 00 6E 00 63 00 65 00 6C 00 //UNICODE (@cancel)
02 00 00 00 //List Size
09 00 //String Size(9)
62 74 6E 43 61 6E 63 65 6C //btnCancel
04 00 //String Size(4)
54 65 78 74 //Text
//----------Set Ok Button to string/en/sui.stf StringName ok-----------------------
03 //Change Type
01 00 00 00 //List Size
03 00 00 00 //UNICODE STRING SIZE(3)
40 00 6F 00 6B 00 //@ok
02 00 00 00 //List Size
05 00 //String Size(5)
62 74 6E 4F 6B //btnOk
04 00 //String Size(4)
54 65 78 74 //Text
//---------------This Enables the Input Field-----------------------------------------
03 //Change Type
01 00 00 00 //List Size
04 00 00 00 //String Size(4)
74 00 72 00 75 00 65 00 //true
02 00 00 00 //List Size
08 00 //String Size(8)
74 78 74 49 6E 70 75 74 //txtInput
07 00 //String Size(7)
45 6E 61 62 6C 65 64 //Enabled
//-------------This Makes the Input Field Visable--------------------------------------
03 //Change Type
01 00 00 00 //List Size
04 00 00 00 //UNICODE STRING SIZE(4)
74 00 72 00 75 00 65 00 //UNICODE (true)
02 00 00 00 //List Size
08 00 //String Size(8)
74 78 74 49 6E 70 75 74 //txtInput
07 00 //String Size(7)
56 69 73 69 62 6C 65 //Visible
//------------This disables The DropDown Box-----------------------------------------------
03 //Change Type
01 00 00 00 //List Size
05 00 00 00 //UNICODE STRING COUNT (5)
66 00 61 00 6C 00 73 00 65 00 //UNICODE (false)
02 00 00 00 //List Size
08 00 //String Size(8)
63 6D 62 49 6E 70 75 74 //cmbInput
07 00 //String Size(7)
45 6E 61 62 6C 65 64 //Enabled
//------------This Removes the DropDown Box-------------------------------------------------
03 //Change Type
01 00 00 00 //List Size
05 00 00 00 //UNICODE STRING SIZE(5)
66 00 61 00 6C 00 73 00 65 00 //UNICODE (false)
02 00 00 00 //List Size
08 00 //String Size(8)
63 6D 62 49 6E 70 75 74 //cmbInput
07 00 //String Size(7)
56 69 73 69 62 6C 65 //Visible
//------------Sets The Max Char Count to 127---------------------------------------------------
03 //Change Type
01 00 00 00 //List Size
03 00 00 00 //UNICODE STRING SIZE (3)
31 00 32 00 37 00 //UNICODE (127)
02 00 00 00 //List Size
08 00 //String Size(8)
74 78 74 49 6E 70 75 74 //txtInput
09 00 //String Size(9)
4D 61 78 4C 65 6E 67 74 68 //MaxLength
//-------------Sets cmbInput's Max Chat Count to 127----------------------------------
03 //Change Type
01 00 00 00 //List Size
03 00 00 00 //UNCIDE STRING SIZE (3)
31 00 32 00 37 00 //UNICODE (127)
02 00 00 00 //List Size
08 00 //String Size(8)
63 6D 62 49 6E 70 75 74 //cmbInput
09 00 //String Size(9)
4D 61 78 4C 65 6E 67 74 68 //MaxLength
00 00 00 00 00 00 00 00 //unk DATA 1
00 00 00 00 //unk DATA 2
00 00 00 00 00 00 00 00 //unk DATA 3

====List Box Example====
02 00 //WORLDUPDATE
59 72 4B D4 //SuiCreatePageMessage
83 5A 02 00 //Window ID
0E 00 //String Size(14)
53 63 72 69 70 74 2E 6C 69 73 74 42 6F 78 //Script.listBox
0B 00 00 00 //List Size, Number of Changes(11)
//---------------------------------
05 //Change Type
00 00 00 00 //num of Variable Changes
07 00 00 00 //List Size
00 00 //Strange String 1
01 00 09 //Strange String 2
1F 00 //String Size(31)
6F 6E 47 75 69 6C 64 53 70 6F 6E 73 6F 72 65 64
4F 70 74 69 6F 6E 73 52 65 73 70 6F 6E 73 65 //onGuildSponsoredOptionsResponse
0C 00 //String Size(12)
4C 69 73 74 2E 6C 73 74 4C 69 73 74 //List.lstList
0B 00 //String Size(11)
53 65 6C 65 63 74 65 64 52 6F 77 //SelectedRow
13 00 //String Size(19)
62 67 2E 63 61 70 74 69 6F 6E 2E 6C 62 6C 54 69 74 6C 65 //bg.caption.lblTitle
04 00 //String Size(4)
54 65 78 74 //Text
//-----------------------------------------------------------
05 //Change Type
00 00 00 00 //num of Variable Changes
07 00 00 00 //List Size
00 00 //Strange String 1
01 00 0A //Strange String 2
1F 00 //String Size(31)
6F 6E 47 75 69 6C 64 53 70 6F 6E 73 6F 72 65 64
4F 70 74 69 6F 6E 73 52 65 73 70 6F 6E 73 65 //onGuildSponsoredOptionsResponse
0C 00 //String Size(12)
4C 69 73 74 2E 6C 73 74 4C 69 73 74 //List.lstList
0B 00 //String Size(11)
53 65 6C 65 63 74 65 64 52 6F 77 //SelectedRow
13 00 //String Size(19)
62 67 2E 63 61 70 74 69 6F 6E 2E 6C 62 6C 54 69 74 6C 65 //bg.caption.lblTitle
04 00 //String Size(4)
54 65 78 74 //Text
//---------------------------------------------
03 //
01 00 00 00 //Component Count
1E 00 00 00 //UNICODE STRING SIZE(30)
40 00 67 00 75 00 69 00 6C 00 64 00 3A 00 73 00
70 00 6F 00 6E 00 73 00 6F 00 72 00 65 00 64 00
5F 00 6F 00 70 00 74 00 69 00 6F 00 6E 00 73 00
5F 00 74 00 69 00 74 00 6C 00 65 00 //@guild:sponsored_options_title
02 00 00 00 //Component Count
13 00 //String Size(19)
62 67 2E 63 61 70 74 69 6F 6E 2E 6C 62 6C 54 69 74 6C 65 //bg.caption.lblTitle
04 00 //String Size(4)
54 65 78 74 //Text
//-------------------------------------------------
03
01 00 00 00 //Component Count
90 00 00 00 //UNICODE STRING SIZE(144)
53 00 70 00 6F 00 6E 00 73 00 6F 00 72 00 65 00
64 00 20 00 66 00 6F 00 72 00 20 00 6D 00 65 00
6D 00 62 00 65 00 72 00 73 00 68 00 69 00 70 00
3A 00 20 00 52 00 6F 00 6B 00 69 00 67 00 20 00
44 00 61 00 65 00 6C 00 61 00 27 00 2E 00 0A 00
59 00 6F 00 75 00 20 00 6D 00 61 00 79 00 20 00
61 00 63 00 63 00 65 00 70 00 74 00 20 00 74 00
68 00 65 00 6D 00 20 00 69 00 6E 00 74 00 6F 00
20 00 74 00 68 00 65 00 20 00 67 00 75 00 69 00
6C 00 64 00 2C 00 20 00 64 00 65 00 63 00 6C 00
69 00 6E 00 65 00 20 00 74 00 68 00 65 00 69 00
72 00 20 00 6D 00 65 00 6D 00 62 00 65 00 72 00
73 00 68 00 69 00 70 00 2C 00 20 00 6F 00 72 00
20 00 63 00 61 00 6E 00 63 00 65 00 6C 00 20 00
74 00 6F 00 20 00 6C 00 65 00 61 00 76 00 65 00 //Sponsored for membership: Rokig Daela
20 00 74 00 68 00 65 00 6D 00 20 00 75 00 6E 00 //You may accept them into the guild.
63 00 68 00 61 00 6E 00 67 00 65 00 64 00 20 00 //decline their membership or
66 00 6F 00 72 00 20 00 6E 00 6F 00 77 00 2E 00 //cancel to leave them unchanges for now.
02 00 00 00 //Component Count
10 00 //String Size(16)
50 72 6F 6D 70 74 2E 6C 62 6C 50 72 6F 6D 70 74 //Prompt.lblPrompt
04 00 //String Size(4)
54 65 78 74 //Text
//------------------------------------------------
03
01 00 00 00 //Component Count
07 00 00 00 //UNICODE STRING SIZE(7)
40 00 63 00 61 00 6E 00 63 00 65 00 6C 00 //@cancel
02 00 00 00
09 00 //String Size(9)
62 74 6E 43 61 6E 63 65 6C //btnCancel
04 00 //String Size(4)
54 65 78 74 //Text
//--------------------------------
03
01 00 00 00 //Component Count
03 00 00 00 //UNICODE STRING SIZE(3)
40 00 6F 00 6B 00 //@ok
02 00 00 00
05 00 //String Size(5)
62 74 6E 4F 6B //btnOk
04 00 //String Size(4)
54 65 78 74 //Text
//-----------------------------------------
01
00 00 00 00
01 00 00 00
0D 00 //String Size(13)
4C 69 73 74 2E 64 61 74 61 4C 69 73 74 //List.dataList
//------------------------------------------
04
01 00 00 00 //List Size
01 00 00 00 //UNICODE STRING SIZE (1)
30 00 //UNICODE ('0')
02 00 00 00 //Component Count
0D 00 //String Size(13)
4C 69 73 74 2E 64 61 74 61 4C 69 73 74 //List.dataList
04 00 //String Size(4)
4E 61 6D 65 //Name
//----------------------------------------
03
01 00 00 00 //Component Count
0D 00 00 00 //UNICODE STRING SIZE(13)
40 00 67 00 75 00 69 00 6C 00 64 00 3A 00
61 00 63 00 63 00 65 00 70 00 74 00 //@guild:accept
02 00 00 00 //Component Count
0F 00 //String Size(15)
4C 69 73 74 2E 64 61 74 61 4C 69 73 74 2E 30 //List.dataList.0
04 00 //String Size(4)
54 65 78 74 //Text
//----------------------------------------------------------
04
01 00 00 00
01 00 00 00 //UNICODE STRING SIZE(1)
31 00 //UNICODE(1)
02 00 00 00 //Component Count
0D 00 //String Size(13)
4C 69 73 74 2E 64 61 74 61 4C 69 73 74 //List.dataList
04 00 //String Size(4)
4E 61 6D 65 //Name
//-------------------------------------------------
03
01 00 00 00 //Component Count
0E 00 00 00 //UNICODE STRING SIZE(14)
40 00 67 00 75 00 69 00 6C 00 64 00 3A 00 64 00
65 00 63 00 6C 00 69 00 6E 00 65 00 //@guild:decline
02 00 00 00 //Component Count
0F 00 //String Size(15)
4C 69 73 74 2E 64 61 74 61 4C 69 73 74 2E 31 //List.dataList.1
04 00 //String Size(4)
54 65 78 74 //Text
//-----------------------------------------------------
00 00 00 00 00 00 00 00 //unk DATA 1
00 00 00 00 //unk DATA 2
00 00 00 00 00 00 00 00 //unk DATA 3

====messageBox Example====
02 00 //WORLDUPDATE
59 72 4B D4 //SuiCreatePageMessage
83 84 02 00 //Window ID
11 00 53 63 72 69 70 74 2E 6D 65 73 73
61 67 65 42 6F 78 //Script.messageBox
09 00 00 00 //Script Update List Size(9)
//---------------------------------
05
00 00 00 00
03 00 00 00 //List Size
00 00 //Strange String 3
01 00 09 //Strange String 2
13 00 6F 6E 47 75 69 6C 64 49 6E 66 6F 52 65
73 70 6F 6E 73 65 //onGuildInfoResponse
//------------------------------
05
00 00 00 00
03 00 00 00 //List Size
00 00
01 00 0A
13 00 6F 6E 47 75 69 6C 64 49 6E 66 6F 52 65
73 70 6F 6E 73 65 //onGuildInfoResponse
//--------------------------------
03
01 00 00 00 //List Size
59 00 00 00 //UNICODE STRING SIZE(89)
47 00 75 00 69 00 6C 00 64 00 20 00 4E 00 61 00 6D 00 65 00
3A 00 20 00 61 00 72 00 79 00 73 00 6C 00 61 00 74 00 20 00
72 00 61 00 69 00 67 00 6E 00 65 00 0A 00 47 00 75 00 69 00
6C 00 64 00 20 00 41 00 62 00 62 00 72 00 65 00 76 00 69 00
61 00 74 00 69 00 6F 00 6E 00 3A 00 20 00 61 00 72 00 79 00
73 00 0A 00 47 00 75 00 69 00 6C 00 64 00 20 00 4C 00 65 00
61 00 64 00 65 00 72 00 3A 00 20 00 52 00 6F 00 6B 00 69 00
67 00 20 00 44 00 61 00 65 00 6C 00 61 00 27 00 0A 00 4D 00
65 00 6D 00 62 00 65 00 72 00 73 00 3A 00 20 00 32 00
//UNICODE ('Guild Name: aryslat raigne Guild Abbreviation: arys Guild Leader: Rokig Daela' Members: 2')
02 00 00 00 //List Size
10 00 50 72 6F 6D 70 74 2E 6C 62 6C
50 72 6F 6D 70 74 //Prompt.lblPrompt
04 00 54 65 78 74 //Text
//-----------------------------------------
03
01 00 00 00 //List Size
11 00 00 00 40 00 67 00 75 00 69 00 6C 00
64 00 3A 00 69 00 6E 00 66 00
6F 00 5F 00 74 00 69 00 74 00 6C 00 65 00 //UNICODE ('@guild:info_title')
02 00 00 00 //List Size
13 00 62 67 2E 63 61 70 74 69 6F 6E 2E 6C 62
6C 54 69 74 6C 65 //bg.caption.lblTitle
04 00 54 65 78 74 //Text
//-----------------------------------------------
03
01 00 00 00 //List Size
05 00 00 00 46 00 61 00 6C 00 73 00 65 00 //UNICODE ('False')
02 00 00 00 //List Size
09 00 62 74 6E 52 65 76 65 72 74 //btnRevert
07 00 45 6E 61 62 6C 65 64 //Enabled
//----------------------------------------------
03
01 00 00 00 //List Size
05 00 00 00 46 00 61 00 6C 00 73 00 65 00 //UNICODE('false')
02 00 00 00 //List Size
09 00 62 74 6E 52 65 76 65 72 74 //btnRevert
07 00 56 69 73 69 62 6C 65 //Visible
//----------------------------------------------
03
01 00 00 00 //List Size
05 00 00 00 46 00 61 00 6C 00 73 00 65 00 //UNICODE('False')
02 00 00 00 //List Size
09 00 62 74 6E 43 61 6E 63 65 6C //btnCancel
07 00 45 6E 61 62 6C 65 64 //Enabled
//-------------------------------------------------
03
01 00 00 00 //List Size
05 00 00 00 46 00 61 00 6C 00 73 00 65 00 //UNICODE('False')
02 00 00 00 //List Size
09 00 62 74 6E 43 61 6E 63 65 6C //btnCancel
07 00 56 69 73 69 62 6C 65 //Visible
//-----------------------------------------------------
03
01 00 00 00
03 00 00 00 //List Size
40 00 6F 00 6B 00 //UNICODE('@ok')
02 00 00 00 //List Size
05 00 62 74 6E 4F 6B //btnOk
04 00 54 65 78 74 //Text
//---------------------------------------------------
00 00 00 00 00 00 00 00
00 00 00 00
00 00 00 00 00 00 00 00

SuiCreatePageMessage

2009-10-31T23:11:50Z

2008-06-15T10:25:19Z

Mugly:

File:Bh component.png

2008-04-22T14:53:43Z

Mugly:

File:Light saber.png

2008-04-22T14:52:26Z

Mugly:

CREO03

2008-02-17T21:35:58Z

Mugly: /* Deltas Struct */

{{PageHeader|Baseline|CREO03}}
{|align="center"
|-
||{{CREOArchitectureNAV}}
|-
|}
<br>
{| border="0" width="90%" cellpadding=6
|-
|valign=top|
===BaseLine Struct===
----

<pre>
SHORT: ObjectOpperandCount
FLOAT: Complexity
ASTRING: STFName
INT: ??
ASTRING: DefaultName
USTRING: CustomName
INT: Volume
CSTRING: Customization
INT: ??ListSize
INT: UpdateCounter
{
INT: ??
}
INT: OptionsBitmask
INT: IncapTimer
INT: ConditionDamage
INT: MaxCondition
BYTE: ??
BYTE: Posture
BYTE: FactionRank
LONG: OwnerID
FLOAT: Height
INT: BattleFatigue
LONG: StatesBitmask
INT: WoundHAMListSize
INT: UpdateCounter
{
INT: WoundHAMValue
}
</pre>

===Deltas Struct===
----

<pre>
SHORT: UpdateCount
SHORT: UpdateType
{
00:
FLOAT: Complexity
01:
A_STRING: STFName
INT: ??
A_STRING: DefaultName
02:
U_STRING: CustomName
03:
INT: Volume
04:
A_STRING: Customization
05:
INT: ??ListSize
INT: UpdateCount
{
BYTE: SubType
{
00:(remove)
INT: ??
01:(add)
INT: ??
02:(clearall)
}
}
06:
INT: OptionsBitmask
07:
INT: IncapTimer
08:
INT: ConditionDamage
09:
INT: MaxCondition
0A:
BYTE: Posture Update Counter (used for delta messages)
0B:
BYTE: Posture
0C:
BYTE: FactionRank
0D:
LONG: OwnerID
0E:
INT: Height
0F:
INT: BattleFatigue
10:
INT: StatesBitmask
11:
INT: WoundHAMListSize
INT: UpdateCounter
{
BYTE: SubType
{
00:(remove)
SHORT: HAMBarIndex
01:(add)
SHORT: HAMBarIndex
INT: HAMValue
02:(change)
SHORT: HAMBarIndex
INT: HAMValue
03:(resetall)
SHORT: NewListSize
{
INT: HAMValue
}
04:(clearall)
}
}
}
</pre>

|valign=top|

===Variable Descriptions===
----

ObjectOpperandCount = 18
----

*'''SpeciesSTF''':
:The STF File information for the creatures name and default description.

*'''Name''':
:The name of the creature. There is a default STF and a custom Unicode name.
:This is the name that will display when set.
:Use to display Custom Names and Player Names.

*'''Customization''':
:This is the CSTRING used to contain customization variables for this object.
:Appearance data appears here.

*'''OptionsBitmask''':
:This bitmask contains flags to set various option aspects such as converse,
:vendor, mount, etc.

{| align="center"
|-
||
{{OptionsBitmask}}
|}

*'''IncapTimer''':
:This sets the incap timer on this creature when it becomes incapacitated.

*'''ConditionDamage''':
:This is the current damage taken by a vehicle creature object(and possibly others..)

*'''MaxCondition''':
:This is the maximum HP(condition) of a vehicle creature object.

*'''Posture''':
:This is an ID of the current posture stance of the creature.
:Refer to the Posture.iff for values.

*'''FactionRank''':
:This byte sets the current rank of the creature object with their faction.
:Refer to the FactionRanks for values.

*'''OwnerID''':
:This ID contains the ID of the object that owns this object. This is used
:for pets and vehicles.

*'''Height''':
:This is the height/scale of the object from its original model.

*'''BattleFatigue''':
:This is the value of the objects current battle fatigue.

*'''StatesBitmask''':
:This bitmask contains flags for player states. Refer to the States.iff
:for values.

*'''WoundHAMList''':
:This list contains the wound values for each HAM bar.

===Tags===
----
{| align="center"
|-
||{{100%}}
|-
|}
|}

===Sample Packet===
----
<pre>
</pre>

File:Builds.jpg

2008-02-01T23:12:47Z

Mugly: Never let it go!

Never let it go!

ChatSendToRoom

2007-08-25T08:40:42Z

Mugly: /* Sample Packet */

__NOTOC__

{| border="0" width="90%" cellpadding=6
|-
|valign=top|
===Struct===
----

{| class="wikitable"
|-
|{{short}}||'''Opperand_Count'''
|-
|{{int}}||'''Opcode'''
|-

|-
||...
|}

===Variable Descriptions===
----

Opperand_Count = '''1'''

Opcode = '''20E4DBE3'''

|valign=top|

===Details===
----

This packet is ...

===Tags===
----
{| align="center"
|-
||{{ClientPacket}}
|-
||{{25%}}
|-
|}

|}

----

==Sample Code==
----

<pre>
Insert Code Snippet Here...
</pre>

==Sample Packet==

<pre>
00 09
00 55
05 00
E3 DB E4 20 // ChatSendToRoom
12 00 00 00 // string count
74 00 // t.
65 00 73 00 74 00 69 00 6E 00 67 00 20 00 67 00 // e.s.t.i.n.g...g.
75 00 69 00 6C 00 64 00 20 00 63 00 68 00 61 00 // u.i.l.d...c.h.a.
74 00 // t
00 00 00 00 // uknown
68 D5 28 03 // room ID
01 00 00 00 // Message counter

AD F9
</pre>

2007-07-03T18:54:37Z

Mugly: /* Sample Packets */

{{PageHeader|Command|Requestbadges (CA604B86)}}
{| border="0" width="90%" cellpadding=6
|-
|valign=top|
===Struct===
----
{| align="center"
|-
||
{| class="wikitable"
|-
|''' '''||
|-
|''' '''||
|-
|''' '''||
|-
|''' '''||
|-
|}
|}

===Variable Descriptions===
----

Opperand_Count = ''' '''

Opcode = '''CA604B86'''
----

*

|valign=top|

===Tags===
----
{| align="center"
|-
||{{ClientPacket}}
|-
||{{0%}}
|-
||{{CommandQueueEnqueue}}
|-
||{{ClientCommands}}
|-
|}

|}

==Sample Command Strings==

Search for a Rebel Human Architect Master Architect
<pre>
4 7 0 0 0 370444368 0 crafting_architect_master ""
</pre>

Search for an Imperial Human Architect Master Architect
<pre>
4 7 0 0 0 -615855020 0 crafting_architet_master ""
</pre>

Search for a Neutral Human Architect Master Architect
<pre>
4 7 0 0 0 0 0 crafting_architect_master ""
</pre>

Search for a Neutral Wookiee Architect Master Architect
<pre>
4 7 0 0 0 0 4 crafting_architect_master ""
</pre>

Search for a Neutral Wookiee
<pre>
4 7 0 0 0 0 4 "" ""
</pre>

Unicode string break down ['''Flags bitmask'''] ['''Faction CRC'''] ['''Species'''] ['''Title'''] ['''?''']

'''Flags bitmask:''' (ie: 4 7 0 0 0) Means 0x47. This value is the bitmask for the 3 possible flags.

The 3 lasts bits of the byte define 3 boolean values as follow : [Roleplay] [Newbie] [LFG]

possible flags
<pre>
01000001 = 0x41 = LFG
01000010 = 0x42 = Newbie
01000011 = 0x43 = LFG + Newbie
01000100 = 0x44 = RolePlayer
01000101 = 0x45 = LFG + RolePlay
01000110 = 0x46 = Newbie + RolePlayer
01000111 = 0x47 = LFG + Newbie + Roleplayer
</pre>

'''faction CRC:'''
This is the string of the int value of the crc of either "imperial" or "rebel" 0_o

-615855020 = 0xDB4ACC54 = CRC("imperial")

370444368 = 0x16148850 = CRC("rebel")

0 = neutral

'''Species:'''

an integrer representing the race. 0 beeing for Humans

'''Title:'''

a system-name for titles. Note if no title is selected but only the prof, the names becomes a prof name.

Profession->Architect Title->Master = crafting_architect_master

Profession->Architect Title->Any = crafting_architect

Profession->Any = ""

'''[?]'''

An unknown parameter. GM/CSR only? Not implemented? Always seen "" (empty parameter)

Requestcharactermatch (8A19D7E1)

Mugly: /* Variable Descriptions */

__NOTOC__

{| border="0" width="90%" cellpadding=6
|-
|valign=top|
===Struct===
----
{| class="wikitable"
|{{int}}|'''player count'''
|-
|}

{| class="wikitable"
|{{int}}|{{unknown}}
|-
|{{int}}|{{unknown}}
|-
|{{int}}|{{unknown}}
|-
|{{int}}|{{unknown}}
|-
|{{int}}|{{unknown}}
|-
|{{u_string}}|'''player name'''
|-
|{{int}}|'''race'''
|-
|{{a_string}}|'''client region STF'''
|-
|{{a_string}}|'''planet'''
|-
|{{a_string}}|'''guild'''
|-
|{{a_string}}|{{unknown}}
|-
|}

===Variable Descriptions===
----
controllerID = '''000001E7'''
----
[[Image:Communitysearchcy2.jpg]]

==Sample Packet==

<pre>
07 00 00 00 // player count

==============================================================================

04 00 00 00
38 00 00 00
00 00 00 00 // unknown
00 00 00 00
00 00 00 00

11 00 00 00
44 00 6F 00 6D 00 65 00
73 00 74 00 69 00 63 00 // player name & surname
61 00 20 00 54 00 72 00
61 00 64 00 69 00 61 00 72 00

06 00 00 00 // race (Twil'ek)

1E 00
40 74 61 74 6F 6F 69 6E
65 5F 72 65 67 69 6F 6E //@tatooine_region_names:bestine
5F 6E 61 6D 65 73 3A 62
65 73 74 69 6E 65

08 00
74 61 74 6F 6F 69 6E 65 // tatooine

00 00 // no specified guild

00 00 // something else not specified

==============================================================================

04 00 00 00
38 00 00 00
00 00 00 00 // unknown
00 00 00 00
00 00 00 00

0A 00 00 00
53 00 65 00 6A 00 75 00
6F 00 20 00 44 00 75 00 // Sejuo Dune (player name)
6E 00 65 00

00 00 00 00 // race (human)

1E 00
40 74 61 74 6F 6F 69 6E
65 5F 72 65 67 69 6F 6E //@tatooine_region_names:bestine
5F 6E 61 6D 65 73 3A 62
65 73 74 69 6E 65

08 00
74 61 74 6F 6F 69 6E 65 // tatooine

00 00 // no specified guild

00 00 // something else not specified

==============================================================================

04 00 00 00
38 00 00 00
00 00 00 00 // unknown
00 00 00 00
00 00 00 00

07 00 00 00
52 00 6F 00 75 00 20 00 // player name
42 00 6F 00 74 00

31 00 00 00 // race (Sullustan)

1E 00
40 74 61 74 6F 6F 69 6E
65 5F 72 65 67 69 6F 6E // region-name STF
5F 6E 61 6D 65 73 3A 62
65 73 74 69 6E 65

08 00
74 61 74 6F 6F 69 6E 65 // tatooine

00 00 // no specified guild

00 00 // something else not specified

==============================================================================

04 00 00 00
38 00 00 00
00 00 00 00 // unknown
00 00 00 00
00 00 00 00

0B 00 00 00
6B 00 69 00 6C 00 6C 00
2D 00 63 00 72 00 69 00 // player name
7A 00 6F 00 77 00

04 00 00 00 // race (Wookiee)

00 00 // no specified region

08 00
74 61 74 6F 6F 69 6E 65 // tatooine

03 00
52 45 44 // RED (guild)

00 00 // something else not specified

==============================================================================

04 00 00 00
38 00 00 00
00 00 00 00 // unknown
00 00 00 00
00 00 00 00

04 00 00 00
56 00 6F 00 68 00 75 00 // player name (Vohu)

00 00 00 00 // race (Human)

1E 00
40 74 61 74 6F 6F 69 6E
65 5F 72 65 67 69 6F 6E // region-name STF
5F 6E 61 6D 65 73 3A 62
65 73 74 69 6E 65

08 00
74 61 74 6F 6F 69 6E 65 // tatooine

00 00 // no specified guild

00 00 // something else not specified

==============================================================================

04 00 00 00
38 00 00 00
00 00 00 00 // unknown
00 00 00 00
00 00 00 00

05 00 00 00
56 00 65 00 67 00 61 00 27 00 // player name

07 00 00 00 // race (Zabrak)

2B 00
40 74 61 74 6F 6F 69 6E
65 5F 72 65 67 69 6F 6E
5F 6E 61 6D 65 73 3A 76 // region-name STF
61 6C 5F 68 61 75 6C 5F
73 70 61 77 6E 5F 62 6C
6F 63 6B

08 00
74 61 74 6F 6F 69 6E 65 // tatooine

00 00 // no specified guild

00 00 // something else not specified

==============================================================================

04 00 00 00
38 00 00 00
00 00 00 00 // unknown
00 00 00 00
00 00 00 00

04 00 00 00
4E 00 61 00 74 00 27 00 // player name

00 00 00 00 // race (Human)

00 00 // no specified region

08 00
74 61 74 6F 6F 69 6E 65 // tatooine

00 00 // no specified guild

00 00 // something else not specified
</pre>

|valign=top|
===Tags===
----
{| align="center"
|-
||{{ObjControllerMessageTag}}
|-
||{{25%}}
|-
|}

|}

2007-06-22T09:23:43Z

Mugly: /* Tags */

__NOTOC__
{|
|- align="center"
||{{PacketGuide}}
|-
|}

{| border="0" width="90%" cellpadding=6
|-
|valign=top|
===Struct===
----

{| class="wikitable"
|-
|align="center" style="background:#3C548A; color:white;"|'''INT'''||'''OpCode'''
|-
|align="center" style="background:#D8F2E0; color:#3C4565;"|'''A_STRING'''||'''URL'''
|-
|}

===Variable Descriptions===
----

Opperand_Count = '''?'''

Opcode = '''0x8DE7E213'''
----

* '''URL''' server adress without "http://"

|valign=top|

===Tags===
----
{| align="center"
|-
||{{ServerPacket}}
|-
||{{100%}}
|-
|}

|}

----

==Sample Code==
----

<pre>
Insert Code Snippet Here...
</pre>

==Sample Packet==

<pre>
09 00
13 E2 E7 8D
0A 00
73 77 67 61 6E 68 2E 63 6F 6D // swganh.com
</pre>