Skip to content

Commit f943803

Browse files
authored
[refactor] readme changes
1 parent dd925dc commit f943803

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,35 @@
1+
12
# Discord Misanthropic Petrichor: Cards Against Humanity
23

4+
![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/other_server_bot.png?raw=true)
5+
36
Misanthropic Petrichor is an attempt of an implementation of Cards Against Humanity in Discord. It is coded in JavaScript using the Discord.js library.
47
This implementation is **not supported or endorsed by** https://cardsagainsthumanity.com/.
58

9+
# Features and preview
10+
![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/card_selection.png?raw=true)
11+
12+
*Private message card selection*
13+
14+
![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/czar_selection.png?raw=true)
15+
16+
*Reactions-based Czar card selection*
17+
18+
![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/name_display.png?raw=true)
19+
20+
*Displaying of names of who's the nastiest after a Czar picks*
21+
22+
![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/available_preinstalled_decks.png?raw=true)
23+
24+
*Available pre-installed decks*
25+
26+
![](https://github.com/Chokyotager/discord-cards-against-humanity/blob/master/display/in_discord_configuration.png?raw=true)
27+
28+
*In-Discord game configuration*
29+
30+
31+
This game is fully automatic and requires no commands to be input during gameplay.
32+
633
## Bot set-up
734
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.
835

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

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

70+
4371
Discord: `ChocoParrot#8925`
72+
4473
Twitter: @ChocoParrotFox
74+
4575
Email: lachocoparrot@gmail.com (I don't check this often)
4676

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

4980
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 commit comments

Comments
 (0)