MultiplayerLib
MultiplayerLib is a lightweight UDP networking library designed for simple real-time multiplayer games. It provides a minimal, easy-to-integrate API for fast client-server communication with optional compression and encryption.
source code can be found here
Table of Contents
- Features
- Installation
- Quick Start
- Architecture Overview
- API Reference
- Packet Examples
- Troubleshooting
- Security Notes
- Contributors
Features
- UDP networking for low-latency gameplay
- Multi-client server support
- Real-time state synchronization
- Optional packet compression using zlib
- Optional encryption using Fernet (AES) + PBKDF2 key derivation
- JSON-based packet formatting (human readable)
- Background threaded receive loop
- Safe send/receive queue system
- Minimal API surface:
NetworkManager,EncryptionManager
Installation
run the install command to install the package
pip install multiplayerlib
Quick Start Example
Host (Server)
mgr = NetworkManager(
is_host=True,
base_port=5000,
use_compression=True,
use_encryption=False
)
mgr.start()
Client
mgr = NetworkManager(
is_host=False,
peer_ip="1.2.3.4",
base_port=5000,
use_compression=True,
use_encryption=False
)
mgr.start()
Sending / Receiving
mgr.safe_send({
"type": "playerdata",
"position": {"x": 10, "y": 20, "rotation": 0},
"health": 100
})
msg = mgr.safe_receive()
if msg:
# handle decoded packet
pass
Architecture Overview
- The system follows a client-server UDP model:
- One host acts as the server
- Multiple clients can connect and send packets
- The server broadcasts received packets to all connected clients
- Each client sends state updates to the server
Networking Flow
- Client sends packet → Server receives
- Server updates peer registry (heartbeats)
- Server broadcasts packet to all other clients
- Clients receive and process updates via
incoming_queue
Design Notes
- UDP is used for low latency (no built-in reliability)
- Packet delivery is not guaranteed
- Ordering is not enforced
- Designed for frequent state updates (position, actions, etc.)
API Reference
NetworkManager
Constructor
NetworkManager(
is_host=True,
peer_ip=None,
base_port=5000,
use_compression=True,
use_encryption=False,
encryption_key=DEFAULT_KEY,
encryption_salt=DEFAULT_SALT
)
Methods
-
start()Starts background receive and peer cleanup threads. -
safe_send(data: dict)Sends a packet to all connected peers (server) or to the host (client). -
safe_receive() -> dict | NoneNon-blocking receive from internal queue. -
close()Stops networking and closes socket.
Packet Pipeline
Outgoing:
dict → JSON → compress (optional) → encrypt (optional) → UDP packet
Incoming:
UDP packet → decrypt → decompress → JSON decode → dict
EncryptionManager
- Uses PBKDF2-derived key + Fernet encryption
- Requires identical key/salt on both sides
- Encrypt/decrypt operates on bytes
Packet Examples
Common patterns used in games:
Player State
{
"type": "playerdata",
"position": {
"x": 640,
"y": 360,
"rotation": 1.57
},
"health": 100
}
Action Event
{
"type": "shoot",
"pos": [x, y],
"vec": [vx, vy],
"timestamp": 1234567890.0
}
Disconnect
{
"type": "quit"
}
Troubleshooting & Tips
- If bind fails, ensure the port is not in use
- If packets are missing, remember UDP does not guarantee delivery
- If encryption fails, ensure:
- same key
- same salt
- same
use_encryptionsetting
- Keep packets small (UDP safe size ~1–1.5KB recommended)
Security Notes
- Default keys are for development only
- Always generate secure keys for real applications
- Treat UDP as insecure transport unless encrypted
Contributors
griffingreat1
License
MIT License — see LICENSE
Metadata
Release files for multiplayerlib 0.0.2.post3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| multiplayerlib-0.0.2.post3.tar.gz | 8.5 kB | Without provenance | Details for multiplayerlib-0.0.2.post3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| multiplayerlib-0.0.2.post3-py3-none-any.whl | Python 3 | none | any | Details for multiplayerlib-0.0.2.post3-py3-none-any.whl |
Total release size: 16.7 kB
Release files / multiplayerlib-0.0.2.post3.tar.gz
| Download URL | multiplayerlib-0.0.2.post3.tar.gz |
|---|---|
| Size | 8.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
12a9a8572e766026db9c3ca78a17f584251cb77dec5f092329600f45d1cf20a4
|
|
BLAKE2b-256 checksum How to use checksums |
957e6a5ee9d0318f376fa90efe41262252b83a171644f9adc43e22f6085241c3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Release files / multiplayerlib-0.0.2.post3-py3-none-any.whl
| Download URL | multiplayerlib-0.0.2.post3-py3-none-any.whl |
|---|---|
| Size | 8.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4616de0a957f11b79cbd38dcab986c3608f8132ae757bece6c589e855656296d
|
|
BLAKE2b-256 checksum How to use checksums |
1088e94f10adecb6ab082f8a6e663b87f6e2ed615cad84a2788a46e89c5af348
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.6
|
Security for multiplayerlib 0.0.2.post3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.