Prince

Prince is a simple discord bot to facilitate card games over discord. Created in one evening, so the code is very ugly.

Installation

0. Create a bot on discord. Instructions here.

1. Download and install python, if you don't already have it. You can get it here.

2. Open terminal or command prompt (depending on your operating system) andcd into the directory (folder) you're planning on using.

3. Clone (ie download) the code.

4. Install the dependencies.

   1. You may need to install Visual C++ 14.0. Get it here here.

   pip install -r requirements.txt

5. Edit config-template.json for your values, and rename it to config.json

6. Run python3 src/main.py

7. Invite the bot to your server with the following permissions:

   1. View channels
   2. Send Messages
   3. Read Message History

Usage

Command	Description
!draw	Draw the next card off the deck.
!createdeck	Create a new deck in this channel. Options: --delete-old if a deck already exists in this channel, should delete it before preceding? Defaults to false. --deck the name of the deck to create the new deck from (as defined in cards.json or custom-cards.json. Defaults to standard. --name synonym of --deck.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

Any contributors wave any copyrights to the repository owner, to the extent possible by applicable law.

Software is provided ​“AS IS”. ExtraE113 makes no other warranties, express or implied, and hereby disclaims all implied warranties, including any warranty of merchantability and warranty of fitness for a particular purpose, to the extent possible by applicable law.

Roadmap

It is fairly unlikely that I'll continue developing this (because it works well enough) but if I do:

1. Code refactor. Code is ugly. Commands framework would be nice so we don't have spagetti for parsing that. Deck generators need to be rewritten to be object oriented, and some way of calling them automatically would be nice.
2. Unit and intigration tests. Code is completely untested.
3. Secret draws, so your draw isn't broadcast to the whole channel.