Skip to main content

Modern async networking library for multiplayer games

Project description

repod -- multiplayer networking library for Python games

Python 3.12+ License: LGPL v3 Ruff msgpack asyncio

repod is a networking library designed to make it easy to write multiplayer games in Python. It uses asyncio and msgpack to asynchronously serialize network events and arbitrary data structures, and delivers them to your high-level classes through simple callback methods.

It is a modernized fork of PodSixNet. Same ideas -- channels, action-based message dispatch, synchronous pump loops -- but rebuilt from scratch for Python 3.12+ with async I/O, binary msgpack serialization, and full type annotations. PodSixNet was built on asyncore, which was removed in Python 3.12; repod is the drop-in replacement.

Each class within your game client which wants to receive network events subclasses ConnectionListener and implements Network_* methods to catch specific events from the server. You don't have to wait for buffers to fill, or check sockets for waiting data or anything like that -- just call client.pump() once per game loop and the library handles everything else, passing off events to your listener. Sending data back to the server is just as easy with client.send(mydata). On the server side, events are propagated to Network_* callbacks on your Channel subclass, and data is sent back to clients with channel.send(mydata).

Install

pip install repod

Or with uv:

uv add repod

Examples

Chat example:

  • python examples/chat_server.py
  • and a couple of instances of python examples/chat_client.py

Whiteboard example (requires pygame-ce):

  • python examples/whiteboard_server.py
  • and a couple of instances of python examples/whiteboard_client.py

LagTime example (measures round-trip time from server to client):

  • python examples/lag_time_server.py
  • and a couple of instances of python examples/lag_time_client.py

Quick start -- Server

You need to subclass two classes to make your own server. Each time a client connects, a new Channel instance is created, so you subclass Channel to make your server-side representation of a client:

from repod import Channel

class ClientChannel(Channel):

    def network_received(self, data: dict) -> None:
        print(data)

    def Network_myaction(self, data: dict) -> None:
        print("myaction:", data)

Whenever the client sends data, the network_received() fallback is called if no specific handler exists. The method Network_myaction() is only called if your data has an "action" key with a value of "myaction". In other words, if the data looks like:

{"action": "myaction", "blah": 123, ...}

Next, subclass Server:

from repod import Server

class MyServer(Server):
    channel_class = ClientChannel

    def on_connect(self, channel, addr):
        print("new connection:", channel)

Set channel_class to the Channel subclass you created above. The on_connect() method is called whenever a new client connects.

To run the server, call launch():

MyServer(host="0.0.0.0", port=5071).launch()

That's it. One line. launch() handles the event loop internally and catches Ctrl+C for clean shutdown.

When you want to send data to a specific client, use the send method on the Channel:

channel.send({"action": "hello", "message": "hello client!"})

Quick start -- Client

To connect to your server, subclass ConnectionListener:

import time
from repod import ConnectionListener

class MyClient(ConnectionListener):

    def Network_connected(self, data: dict) -> None:
        print("connected to the server")

    def Network_error(self, data: dict) -> None:
        print("error:", data["error"])

    def Network_disconnected(self, data: dict) -> None:
        print("disconnected from the server")

    def Network_myaction(self, data: dict) -> None:
        print("myaction:", data)

Network events are received by Network_* callback methods. Replace * with the value of the "action" key you want to catch. The connected, disconnected, and error events are sent automatically by repod.

Connect and pump:

client = MyClient()
client.connect("localhost", 5071)

while True:
    client.pump()
    time.sleep(0.01)

Call pump() once per game loop and repod handles everything -- reading from the socket, deserializing, and dispatching to your Network_* methods. Sending data to the server:

client.send({"action": "myaction", "blah": 123, "things": [3, 4, 3, 4, 7]})

This works with any game framework that has a main loop: pygame, raylib, arcade, pyglet, etc. Just drop pump() into the loop.

Documentation

Full tutorial and API reference: docs/DOCS.md

Why not PodSixNet?

PodSixNet was great for its time, but:

  • It's built on asyncore, which was removed in Python 3.12
  • It uses rencode / custom delimiter-based framing (\0---\0), which is fragile with binary data
  • It has no type annotations, no modern tooling support
  • It is no longer maintained (chr15m/PodSixNet#46)

repod keeps the same simple API philosophy but replaces the internals:

  • asyncio instead of asyncore
  • msgpack with length-prefix framing instead of rencode with delimiter framing
  • Full type annotations with PEP 695 generics (optional)
  • Python 3.12+ only -- no compatibility shims

Development

uv sync --group dev
uv run ruff check .
uv run ruff format --check .
uv run ty check
uv run pytest tests/ -v

License

Copyright Walker Gonzales, 2025.

repod is licensed under the terms of the LGPL v3.0 or later. See the COPYING file for details.

This is the same license as PodSixNet, from which repod is forked. In short: you can use repod in any project (commercial or otherwise), but if you modify the repod library code itself, you must make the modified source available.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

repodnet-0.1.0.tar.gz (25.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

repodnet-0.1.0-py3-none-any.whl (16.7 kB view details)

Uploaded Python 3

File details

Details for the file repodnet-0.1.0.tar.gz.

File metadata

  • Download URL: repodnet-0.1.0.tar.gz
  • Upload date:
  • Size: 25.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.10

File hashes

Hashes for repodnet-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ba58ba72ea450ae511bf82b6902a6e728c9b5dcdeeb7bc3c55f3279fb2b799f4
MD5 896944c1669332e3652c71615987ec94
BLAKE2b-256 05ecc942e79ed101c27a9cbf76fc08e511aa870ca93af241e9a22f71c509f8cc

See more details on using hashes here.

File details

Details for the file repodnet-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: repodnet-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.10

File hashes

Hashes for repodnet-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b7a39715ddbac30d705ace267b926e0b085008daabe17310de99e44e7106bc02
MD5 d8b4ceb1907944a3d25b640cafc0f2f0
BLAKE2b-256 7cc243fa906539d4c633b2db2fd8c4cbeb8b41b8980c756fdc681e3816cfa5ba

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page