Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mitch0s authored Jun 24, 2022
0 parents commit 45d1018
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
![Gamma Logo](https://i.ibb.co/8K4c6Mc/ezgif-2-b1c4d759f1.png)

# Gamma
### A Minecraft proxy implemented in Python

Gamma is a reverse-TCP proxy implemented in Python using the `Socket` package.

### Features
- Multiple Players
- The proxy supports multiple player connections simultaneously
- Multiple Servers
- Gamma supports proxying players to different servers depending on the hostname that they include in their server list
- Highly Customisable
- In the `Connection` class, there are functions that get called when events happen. Here are a list of the current events that are triggered
- `on_player_ping`
- `on_player_join`
- `on_player_leave`

- Additionally to all of this, we also have a bandwidth counter, `self.conn_bandwidth` which counts the total amount of bytes sent and received from the `upstream` (server) or the `downstream` (player) connection.



### Similar Projects
I would have to say that the biggest inspiration for this project would have to be [infrared](github.com/haveachin/infrared) by [haveachin](github.com/haveachin)

0 comments on commit 45d1018

Please sign in to comment.