Skip to content

Commit

Permalink
[refactor] readme changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Chokyotager authored May 13, 2018
1 parent dd925dc commit f943803
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,35 @@

# Discord Misanthropic Petrichor: Cards Against Humanity

![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/other_server_bot.png?raw=true)

Misanthropic Petrichor is an attempt of an implementation of Cards Against Humanity in Discord. It is coded in JavaScript using the Discord.js library.
This implementation is **not supported or endorsed by** https://cardsagainsthumanity.com/.

# Features and preview
![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/card_selection.png?raw=true)

*Private message card selection*

![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/czar_selection.png?raw=true)

*Reactions-based Czar card selection*

![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/name_display.png?raw=true)

*Displaying of names of who's the nastiest after a Czar picks*

![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/available_preinstalled_decks.png?raw=true)

*Available pre-installed decks*

![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/in_discord_configuration.png?raw=true)

*In-Discord game configuration*


This game is fully automatic and requires no commands to be input during gameplay.

## Bot set-up
Clone or download this repository and run it remotely on your server. Please note that you require the minimum Node version **10.1.0** to run this bot.

Expand Down Expand Up @@ -40,10 +67,14 @@ Document for command-based configuration: https://docs.google.com/document/d/1IO

I'm reachable through Discord, Twitter, and email.


Discord: `ChocoParrot#8925`

Twitter: @ChocoParrotFox

Email: [email protected] (I don't check this often)


If you need to contact me for anything, Discord is probably the best way.

You can also join my public Discord server that comes with this bot, where you can mess with the bot first before you install it or anything: http://discord.gg/BPDfxCG

0 comments on commit f943803

Please sign in to comment.