Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sbischoff-ai/pygase
A Python package that contains a high-performance, versatile UDP-based game server, client and network protocol with a simple API.
https://github.com/sbischoff-ai/pygase
client-server game-development network-protocol networking online-games udp
Last synced: 4 days ago
JSON representation
A Python package that contains a high-performance, versatile UDP-based game server, client and network protocol with a simple API.
- Host: GitHub
- URL: https://github.com/sbischoff-ai/pygase
- Owner: sbischoff-ai
- License: mit
- Created: 2018-05-28T12:01:07.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-31T16:22:46.000Z (about 2 months ago)
- Last Synced: 2024-12-17T04:05:57.900Z (11 days ago)
- Topics: client-server, game-development, network-protocol, networking, online-games, udp
- Language: Python
- Homepage:
- Size: 993 KB
- Stars: 44
- Watchers: 2
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://dev.azure.com/pxlbrain/pygase/_build/latest?definitionId=2&branchName=master)
[](https://github.com/ambv/black)
# PyGaSe
**Py**thon **Ga**me **Se**rver
A package for Python 3.6+ that contains a game-ready client-server architecture and UDP-based network protocol.
It deals with problems such as package loss or network congestion so you don't have to. Instead it gives you
a high-level API to easily connect clients and backends that share a synchronized game state and exchange events.
The async framework for this one is [curio](https://github.com/dabeaz/curio), which I highly recommend.
PyGaSe is built to be easy to use, lightweight, fast, scalable and reliable.
You can build a fast-paced real-time online game with this.
You can also build a large-scale MMO with thousands of clients if you like.
I'm actively developing PyGaSe in the context of several Indie game projects and I'm happy to share it.
---
***BREAKING CHANGE**: Version 0.2.0 is basically a new API and updating from 0.1.9 or lower will break you code.*
*It is also much more stable, flexible and powerful, so make sure to use 0.2.0 or higher.*
---
### Installation
```
pip install pygase
```
or better yet `poetry add pygase`. Seriously, use [poetry](https://github.com/sdispater/poetry), it's a revelation.
## Usage
### API Reference & Tutorials
For API documentation and a *Getting Started* section go [here](https://sbischoff-ai.github.io/pygase/).
### Example
[This example game](https://github.com/sbischoff-ai/pygase/tree/master/chase) implements an online game of tag,
in which players can move around, while one of them is the chaser who has to catch another player.
A player who has been catched becomes the next chaser and can catch other players after a 5s protection countdown.
Run `server.py` first, then run `client.py` in additional terminal sessions to add players.
Only use the same player name once.
### Debugging & Logging
You can use the standard `logging` module. On level `INFO` you will get logging output for events such as
startups, shutdowns, new connections or disconnects. On `DEBUG` level you get detailed output right down to the level
of sending, receiving and handling single network packages.
Debug logs are also a good way to understand the inner workings of PyGaSe.
---
## Changes
### 0.3.1
- improved documentation
- minor logging fixes
### 0.3.0
- sticking to SemVer from here on out
- logging added using the standard `logging` module
- improve event handler arguments
- `Backend` class added to reduce server-side boilerplate
- various bugfixes
### 0.2.0
- complete overhaul of pygase 0.1.x with breaking API changes