Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add packets in README #4

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

chore: Add packets in README #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,20 @@ Hades is the shared protocol between Athena and the Wynntils Client.<br>

Packets
========
Currently Implemented packets are

- Authenticate
Currently Implemented packets are:
### Client
- `HCPacketAuthenticate` -> Authentication Packet: The client sends their Athena token forwards the server which decides how to handle it.
- `HCPacketDiscordLobbyClient` **(NO IMPL)** -> Discord Lobby Packet: Used for sending information to join a discord lobby to the server to send to the client joining.
- `HCPacketSocialUpdate` -> Social Update Packet: This packet is used to indicate that a relation (party or friendship) has changed on the client.
- `HCPacketUpdateGuild` **(NOT USED, NEEDS CHANGES)** -> Update Guild Packet: Used to update player's guild.
- `HCPacketUpdateStatus` Update Status Packet: This packet is used by the client to send new data to the server (location and stats).
- `HCPacketUpdateWorld` Update World Packet: Used by the client to set their world.

### Server
- `HSPacketAuthenticationResponse` Authentication Responce Packet: Tells the client whether authentication was successful.
- `HSPacketDisconnect` Disconnet Packet: Tells the client that the server is disconnecting the user.
- `HSPacketDiscordLobbyServer` **(NO IMPL)** Discord Lobby Server Packet: Used for sending information to join a discord lobby to the client joining.
- `HSPacketUpdateMutual` Update Mutual Packet: Sends updates to the client about the user's mutual users' info.
License
========
Protocol Hades is licensed over the license <a href="https://github.com/Wynntils/Hades/blob/master/LICENSE">GNU Affero General Public License v3.0</a>
Protocol Hades is licensed over the license <a href="https://github.com/Wynntils/Hades/blob/master/LICENSE">GNU Affero General Public License v3.0</a>