v2.2.0

Author: wardenre

CHANGELOG.md

@@ -2,6 +2,22 @@
 
 All notable changes to FishNet will be documented in this file.
 
+## \[v2.2.0\] - 2026.06.07
+
+### Added:
+- Modular includes architecture: headers are now included individually (e.g., `<fishnet/FishServer.h>`, `<fishnet/bedrock/BedrockServer.h>`).
+- Separated Bedrock extension headers into an isolated `include-bedrock` directory that is only exposed when the `bedrock` configuration is enabled.
+
+### Removed:
+- Removed the monolithic `fishnet.h` and `fishnet-bedrock.h` umbrella headers.
+- Removed the deprecated `--examples` build parameter.
+
+### Fixed:
+- Fixed multiple packet header files containing duplicate `#pragma once` directives.
+
+### Updated:
+- Updated `getting-started.md`, `api-reference.md`, and `architecture.md` to reflect the new modular include paths and directory structure.
+
 ## \[v2.1.0\] - 2025.04.12
 
 ### Fixed:
@@ -12,8 +28,8 @@ All notable changes to FishNet will be documented in this file.
 -   GamePacket types
 
 ### Updated:
--    docs
--    github actions
+    docs
+    github actions
 
 ## \[v2.0.0\] - 2025.04.04
 
@@ -35,5 +51,5 @@ All notable changes to FishNet will be documented in this file.
 -   Compression API (Zlib/Snappy/None) via user-supplied functions
 -   Cross-platform: Windows (x64/arm64), macOS (x64/arm64), Linux (x64/arm64)
 -   Shared library build (fishnet.dll / [libfishnet.so](http://libfishnet.so) / libfishnet.dylib)
--   xmake build system with --bedrock and --examples options
--   Packet logging in debug builds (FISHNET\_DEBUG)
+-   xmake build system with --bedrock option
+-   Packet logging in debug builds (FISHNET\_DEBUG)

README.md

@@ -28,7 +28,7 @@ xmake build
 ### Server
 
 ```cpp
-#include <fishnet.h>
+#include <fishnet/FishServer.h>
 #include <iostream>
 #include <thread>
 #include <atomic>

docs/api-reference.md

@@ -31,10 +31,15 @@ Complete documentation of every public class, method, type, and constant in Fish
 
 ## Headers
 
-| Header | Description |
-|--------|-------------|
-| `<fishnet.h>` | Everything in core FishNet (no Bedrock) |
-| `<fishnet-bedrock.h>` | Core + all Bedrock extensions |
+FishNet uses modular headers. You only need to include the specific components you use.
+
+| Example Component | Header Path |
+|-------------------|-------------|
+| `FishServer` | `<fishnet/FishServer.h>` |
+| `FishClient` | `<fishnet/FishClient.h>` |
+| `Connection` | `<fishnet/Connection.h>` |
+| `BedrockServer` | `<fishnet/bedrock/BedrockServer.h>` |
+| `BedrockClient` | `<fishnet/bedrock/BedrockClient.h>` |
 
 ---
 

docs/architecture.md

@@ -5,35 +5,6 @@
 ```
 fishnet/
 ├── src/                              Core FishNet (always compiled)
-│   ├── include/
-│   │   ├── fishnet.h                 Umbrella header
-│   │   └── fishnet/
-│   │       ├── platform.h            Cross-platform sockets
-│   │       ├── FishPeer.h            Core engine (250 lines)
-│   │       ├── FishServer.h          Server wrapper
-│   │       ├── FishClient.h          Client wrapper
-│   │       ├── Connection.h          Per-peer state
-│   │       ├── PacketHandler.h       Callback types
-│   │       ├── protocol/
-│   │       │   ├── Constants.h       Magic, reliability, packet IDs
-│   │       │   └── EncapsulatedPacket.h  Frame structure
-│   │       ├── packets/              One file per packet type
-│   │       │   ├── UnconnectedPing.h
-│   │       │   ├── UnconnectedPong.h
-│   │       │   ├── OpenConnectionRequest1.h
-│   │       │   ├── OpenConnectionReply1.h
-│   │       │   ├── OpenConnectionRequest2.h
-│   │       │   ├── OpenConnectionReply2.h
-│   │       │   ├── ConnectionRequest.h
-│   │       │   ├── ConnectionRequestAccepted.h
-│   │       │   ├── NewIncomingConnection.h
-│   │       │   ├── ConnectedPing.h
-│   │       │   ├── DisconnectionNotification.h
-│   │       │   └── AckNak.h
-│   │       └── utils/
-│   │           ├── BinaryBuffer.h    Binary read/write
-│   │           ├── Address.h         sockaddr_in wrapper
-│   │           └── AddressSerialization.h  RakNet wire format
 │   ├── core/
 │   │   ├── FishPeer.cpp              Lifecycle, dispatch
 │   │   ├── FishPeerSend.cpp          Sending, split
@@ -43,23 +14,38 @@ fishnet/
 │   ├── server/FishServer.cpp
 │   └── client/FishClient.cpp
 │
-├── src-bedrock/                      Bedrock extension (--bedrock=y)
-│   ├── include/
-│   │   ├── fishnet-bedrock.h         Umbrella header
-│   │   └── fishnet-bedrock/
-│   │       ├── BedrockMotd.h         MOTD string builder
-│   │       ├── BedrockServer.h       Server + GamePacket handling
-│   │       ├── BedrockClient.h       Client + GamePacket handling
-│   │       └── GamePacket.h          0xFE wrap/unwrap, batch, compression
+├── include/                          Standard headers (always compiled)
+│   └── fishnet/
+│       ├── platform.h            Cross-platform sockets
+│       ├── FishPeer.h            Core engine (250 lines)
+│       ├── FishServer.h          Server wrapper
+│       ├── FishClient.h          Client wrapper
+│       ├── Connection.h          Per-peer state
+│       ├── PacketHandler.h       Callback types
+│       ├── protocol/
+│       │   ├── Constants.h       Magic, reliability, packet IDs
+│       │   └── EncapsulatedPacket.h  Frame structure
+│       ├── packets/              One file per packet type
+│       │   ├── UnconnectedPing.h
+│       │   ├── UnconnectedPong.h
+│       │   └── ...
+│       └── utils/
+│           ├── BinaryBuffer.h    Binary read/write
+│           ├── Address.h         sockaddr_in wrapper
+│           └── AddressSerialization.h  RakNet wire format
+│
+├── src-bedrock/                      Bedrock extension source (--bedrock=y)
 │   └── core/
 │       ├── BedrockServer.cpp
 │       └── BedrockClient.cpp
 │
-├── examples/
-│   ├── server.cpp                    Generic FishNet server
-│   ├── client.cpp                    Generic FishNet client
-│   ├── bedrock_server.cpp            Bedrock server with GamePacket
-│   └── bedrock_client.cpp            Bedrock bot with GamePacket
+├── include-bedrock/                  Bedrock extension headers (--bedrock=y)
+│   └── fishnet/
+│       └── bedrock/
+│           ├── BedrockMotd.h         MOTD string builder
+│           ├── BedrockServer.h       Server + GamePacket handling
+│           ├── BedrockClient.h       Client + GamePacket handling
+│           └── GamePacket.h          0xFE wrap/unwrap, batch, compression
 │
 ├── docs/                             Documentation
 ├── .github/workflows/                CI/CD
@@ -100,7 +86,6 @@ fishnet/
 | `-m debug` | — | Debug build with packet logging |
 | `-m release` | — | Optimized build, no logging |
 | `--bedrock=y` | `n` | Include Bedrock extension |
-| `--examples=y` | `n` | Build example programs |
 
 ## Platforms
 

docs/getting-started.md

@@ -32,7 +32,7 @@ xmake run myapp
 
 ### Server
 ```cpp
-#include <fishnet.h>
+#include <fishnet/FishServer.h>
 #include <iostream>
 #include <thread>
 #include <csignal>
@@ -70,7 +70,7 @@ int main() {
 
 ### Client
 ```cpp
-#include <fishnet.h>
+#include <fishnet/FishClient.h>
 #include <iostream>
 #include <thread>
 
@@ -93,7 +93,7 @@ int main() {
 
 ### Bedrock Server
 ```cpp
-#include <fishnet-bedrock.h>
+#include <fishnet/bedrock/BedrockServer.h>
 #include <iostream>
 #include <thread>
 #include <csignal>
@@ -151,11 +151,7 @@ xmake build
 xmake f -m release --bedrock=y
 xmake build
 
-# With examples
-xmake f -m release --bedrock=y --examples=y
-xmake build
-
 # Debug (with packet logging)
-xmake f -m debug --bedrock=y --examples=y
+xmake f -m debug --bedrock=y
 xmake build
 ```