diff --git a/README.md b/README.md index ca7014a..e2b9435 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,57 @@ Discord bot behave as like "komputer". One of character in Star Track parody series created by Dem3000 +# Commands + +- /add-joke {category} {type} {answer} {question} - *komputer zapamiętaj dowcip* - Added new joke to database + - category - REQUIRED - joke category + - type - REQUIRED - joke type + - answer - REQUIRED - joke content + - question - OPTIONAL - additional question part of joke. Required only when you try add joke as **Two-Part** type +- /joke {id} {category} {type} - *komputer powiedz dowcip* - Find joke in JokeDev API, HumorAPI or your mongodb + database. Each option in this command is optional: + - id - jokeID, bot return ID after successful added joke into database + - type - joke type + - category - joke category +- /welcome - *komputer przywitaj się* - Bot welcome you +- spock {name} - *kurwa spock* - komputer says something + - name - OPTIONAL - name of file, that bot should play. Name should be put without file extension e.g .mp3 +- list {name} - *komputer co powiesz mi* - show list of available audio, that komputer play on voice chat + - name - part of file name, which you want to see + +## Joke categories + +Bot recognizes a few categories of joke: + +- Programowanie - programming joke +- Różne - any kind of joke, it's random +- YoMamma - special joke ;) + +## Joke types + +Bot recognized a two types of Joke: + +- Single - Joke without question part. If you put joke in question field, this joke will be ignored +- Two-Parts - Joke with question part. You have to fill answer and question fields in /add-joke command + # Installation + ## Manual installation + Build project and installa with this simple command: + ```sh sudo make install ``` + Bot installs in /opt/komputer directory + ## For NixOS + You can use flake to install bot as NixOS module: ```nix -# Installa in flake +# Installa komputer via flake inputs = { komputer.url = "github:Wittano/komputer"; };