MeexReay/meexprox
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs

Browse Source
This commit is contained in:
MeexReay 2024-11-14 19:33:55 +03:00
parent 700bf95a5d
commit 7be66aa527
3 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/index.md Normal file
View File

@ -0,0 +1,7 @@
# Documentation
This is the official Meexprox documentation
#### Overview
- [Main page](index.md)
- [Player Forwarding](player_forwarding.md)

18
docs/meexprox_forwarding.md Normal file
View File

@ -0,0 +1,18 @@
# Meexprox Player Forwarding
Meexprox modifies [Handshake](https://wiki.vg/Protocol#Handshake) packet to transfer IP address
| **Packet ID** | **State** | **Bound To** | **Field Name** | **Field Type** | **Notes** |
|------------------------------------------|---------------|--------------|-------------------------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| *protocol:* `0x00`<br>*resource:* `intention` | Handshaking | Server | **Is IPV6** | Boolean | Indicates if the IP address is using IPV6. |
| | | | **IP Octets** | Byte Array (16) | IP address represented as octets in bytes. 16 bytes if IPV6 and 4 bytes if IPV4. |
| | | | **IP Port** | Unsigned Short | IP port number. |
| | | | **Protocol Version** | VarInt | Protocol version number. Currently 767 in Minecraft 1.21. |
| | | | **Server Address** | String (255) | Hostname or IP, e.g., localhost or 127.0.0.1, used to connect. The server does not use this information. Note: SRV records can redirect; for example, if `_minecraft._tcp.example.com` points to `mc.example.org`. |
| | | | **Server Port** | Unsigned Short | Default is 25565. The server does not use this information. |
| | | | **Next State** | VarInt Enum | Defines the next state: 1 for Status, 2 for Login, 3 for Transfer. |
#### Overview
- [Main page](index.md)
- [Player Forwarding](player_forwarding.md)

23
docs/player_forwarding.md Normal file
View File

@ -0,0 +1,23 @@
# Player Forwarding
Player Forwarding is a protocol that describes how to pass player information (name, uuid, ip, properties, etc.) to backend server from proxy server
Config of player forwarding:
```yml
forwarding:
enabled: false # is player forwarding enabled
type: velocity # player forwarding type
secret: "123456" # player forwarding secret key
```
### Player forwarding types
- `meexprox` - meexprox player forwarding ([about it](meexprox_forwarding.md))
- `velocity` - velocity 'modern' player forwarding, secret key is required
- `bungeecord` (with secret) - bungeecord player forwarding
- `bungeecord` (without secret) - bungeeguard player forwarding
#### Overview
- [Main page](index.md)
- [Player Forwarding](player_forwarding.md)