Update README.md

This commit is contained in:
Ben 2019-09-12 01:09:35 +01:00
parent b9517889a8
commit e228262b0d

View File

@ -1 +1,53 @@
Houdini-asyncio
<p align="center">
<img alt="houdini-asyncio" src="https://user-images.githubusercontent.com/32749673/64740929-d4435c00-d4ee-11e9-9b9f-f45236b8b61f.png">
</p>
#
<p align="center">
<img alt="Solero Discord" src="https://img.shields.io/discord/323290581063172096?color=7289DA&label=discord">
<img alt="Solero Forum" src="https://img.shields.io/discourse/https/solero.me/topics?color=73afb6">
<img alt="Issue Tracker" src="https://img.shields.io/github/issues/solero/houdini-asyncio">
<img alt="License" src="https://img.shields.io/github/license/solero/houdini-asyncio">
</p>
<p align="center">A lightning-fast Club Penguin Private Server written in Python 3.</p>
> NOTE: Currently in early-stages development and things are missing!
## Features :space_invader:
* :clock3: **Cross-era**: Different clients can play together on the same server.
* :exclamation: **Commands**: Built-in extensible commands API.
* :electric_plug: **Powerful Plugin API**: Easy and quick to write your own plugins.
* :speech_balloon: **Chat-filter**: Filter trolls with minimal configuration.
* :shield: **Permissions**: API to restrict access to server functionality & commands.
## Installation
Houdini can be run as a normal Python program under any operating system.
```shell
$ git clone https://github.com/solero/houdini-asyncio
$ cd houdini-asyncio
$ pip install -r requirements.txt
$ python bootstrap.py Login
```
## Game Screenshots
<img alt="Screenshot" width="700px" src="https://user-images.githubusercontent.com/32749673/64743472-05745a00-d4f8-11e9-9eed-f3565dc2e821.png">
<img alt="Screenshot" width="700px" src="https://user-images.githubusercontent.com/32749673/64743711-d8747700-d4f8-11e9-9bab-de08090db34d.png">
<img alt="Screenshot" width="700px" src="https://user-images.githubusercontent.com/32749673/64743891-854ef400-d4f9-11e9-8d78-9d73493eb04d.png">
## Contributing
:heartpulse: So glad to hear of your interest!
If you have suggestions for how this project can be improved, or want to report a bug, please feel free to open an issue! We welcome any and all contributions. We listen to all your questions and are always active on the [Solero Discord server](https://solero.me/discord).
Please note that in this early stage of development we cannot take requests for vanilla Club Penguin features!
## License
MIT Licensed