pep.py/README.md

51 lines
1.3 KiB
Markdown
Raw Normal View History

2016-12-17 14:33:12 +00:00
## pep.py [![Code Health](https://landscape.io/github/osuripple/pep.py/master/landscape.svg?style=flat)](https://landscape.io/github/osuripple/pep.py/master)
2016-11-29 16:21:24 +00:00
- Origin: https://git.zxq.co/ripple/pep.py
- Mirror: https://github.com/osuripple/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
- Cython
2016-12-07 21:31:28 +00:00
- C compiler
- 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, compile all `*.pyx` files to `*.so` or `*.dll` files using `setup.py` (distutils file)
```
$ python3 setup.py build_ext --inplace
```
finally, run pep.py once to create the default config file and edit it
2016-06-11 16:43:27 +00:00
```
$ python3 pep.py
...
2016-06-11 16:43:27 +00:00
$ 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.