pep.py/README.md

40 lines
888 B
Markdown
Raw Normal View History

2016-08-01 08:40:21 +00:00
## pep.py
2016-06-11 16:43:27 +00:00
This is Ripple's bancho server. It handles:
- Client login
- Online users listing and statuses
- Public and private chat
- Spectator
- Multiplayer
- Fokabot
## Requirements
- Python 3.5
- MySQLdb (`mysqlclient`)
2016-08-23 18:16:47 +00:00
- Tornado
- Bcrypt
- Raven
2016-06-11 16:43:27 +00:00
## How to set up pep.py
2016-10-02 20:56:41 +00:00
First of all, initialize and update the submodules
```
$ git submodule init && git submodule update
```
afterwards, install the required dependencies with pip
2016-06-11 16:43:27 +00:00
```
$ pip install -r requirements.txt
2016-06-11 16:43:27 +00:00
```
then, run pep.py once to create the default config file and edit it
```
$ python3 pep.py
$ nano config.ini
```
you can run pep.py by typing
```
$ python3 pep.py
```
## License
2016-08-01 08:40:21 +00:00
All code in this repository is licensed under the GNU AGPL 3 License.
2016-08-01 09:06:09 +00:00
See the "LICENSE" file for more information
This project contains code taken by reference from [miniircd](https://github.com/jrosdahl/miniircd) by Joel Rosdahl.