Skip to content

Commit c68c12b

Browse files
committed
Add initial READMEs for cache and world servers.
1 parent 88f91b9 commit c68c12b

File tree

2 files changed

+40
-0
lines changed

2 files changed

+40
-0
lines changed

cache/README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<div align="center">
2+
<img width="200" src="https://github.com/atom0s/XiPackets/raw/main/repo/icon.png" alt="XiPackets">
3+
</br>
4+
</div>
5+
6+
# Cache Server
7+
8+
The `cache` server, often referred to as the `search` server, is responsible for game traffic that may require a longer time to return a response. Unlike the `world` server which uses UDP for its traffic, the `cache` server transmits its traffic on a separate socket, using TCP.
9+
10+
The `cache` server is responsible for the following:
11+
12+
- **Auction House**
13+
- Auction History
14+
- Auction Lists
15+
- **Search**
16+
- List: Linkshell Members
17+
- List: Party / Alliance Members
18+
- List: Search (`/sea`, `/sea all`, etc.)
19+
- Search Comments

world/README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
<div align="center">
2+
<img width="200" src="https://github.com/atom0s/XiPackets/raw/main/repo/icon.png" alt="XiPackets">
3+
</br>
4+
</div>
5+
6+
# World Server
7+
8+
The `world` server, often referred to as the `game` server, is the server responsible for handling the main gameplay traffic for a given zone, or set of zones. On retail servers, the `world` server instances are clustered for an entire server (ie. `Asura`) where each zone is ran on its own instance. This allows retail to take individual zones offline for emergency maintenance.
9+
10+
Through IP and port monitoring, it has been observed that retail generally clusters zones together based on the type of zone, such as cities will run on individual `world` server instances within a single server hosted on the same port.
11+
12+
The `world` server is responsible for all other traffic not already handled by the `cache` and `lobby` servers.
13+
14+
## Documentation Layout
15+
16+
The `world` server documentation is broken into two separate main categories:
17+
18+
- `client` - Contains packet information about packets sent by the client to the server.
19+
- `server` - Contains packet information about packets sent by the server to the client.
20+
21+
Within these folders, each packet will be separated into its own folder and have its own `README.md` file. This allows each packet to contain additional resources and information all contained within its own folder, making it easer to find, read and reference.

0 commit comments

Comments
 (0)