From e228262b0d65a2efa9b1ffee7d24df57fa4271eb Mon Sep 17 00:00:00 2001 From: Ben Date: Thu, 12 Sep 2019 01:09:35 +0100 Subject: [PATCH] Update README.md --- README.md | 54 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 53 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f4a560..bbe0910 100644 --- a/README.md +++ b/README.md @@ -1 +1,53 @@ -Houdini-asyncio +

+ houdini-asyncio +

+ +# + +

+Solero Discord +Solero Forum +Issue Tracker +License +

+ +

A lightning-fast Club Penguin Private Server written in Python 3.

+ +> 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 + +Screenshot + +Screenshot + +Screenshot + +## 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 \ No newline at end of file