171 lines
10 KiB
Markdown
171 lines
10 KiB
Markdown
# NadekoBot
|
|
|
|
Nadeko Discord chatbot written in C# using Discord.net library.
|
|
You might want to join my discord server where i can provide help etc. https://discord.gg/0ehQwTK2RBhxEi0X
|
|
|
|
##This section will guide you through how to setup NadekoBot from the source code
|
|
#### If you want to semi-easily setup the bot, go to [releases](https://github.com/Kwoth/NadekoBot/releases)
|
|
After you have cloned this repo, move the libopus and libsodium from the DLLs folder to the bin/debug. And after removing all of Discord.Net's project references, add other dlls from dll folder as a reference. Those are part of the libraries you will need for your project. The other part should resolve after you start the project for the first time.
|
|
|
|
In your bin/debug folder (or next to your exe), you must have a file called 'credentials.json' in which you will store all the necessary data to make the bot know who the owner is, where to store data, etc.
|
|
|
|
**This is how the credentials.json should look like:**
|
|
```json
|
|
{
|
|
"Username":"bot_email",
|
|
"BotMention":"<@bot_id>",
|
|
"Password":"bot_password",
|
|
"GoogleAPIKey":"google_api_key",
|
|
"OwnerID":123123123123,
|
|
"ParseID":"parse_app_id",
|
|
"ParseKey":"parse_api_key",
|
|
"TrelloAppKey": "your_trello_app_key",
|
|
"ForwardMessages": true,
|
|
}
|
|
```
|
|
##### You can omit:
|
|
- googleAPIKey if you don't want music
|
|
- TrelloAppKey if you don't need trello notifications
|
|
- ForwardMessages if you don't want bot PM messages to be redirected to you
|
|
```json
|
|
{
|
|
"Username":"bot_email",
|
|
"BotMention":"<@bot_id>",
|
|
"Password":"bot_password",
|
|
"OwnerID":123123123123,
|
|
"ParseID":"parse_app_id",
|
|
"ParseKey":"parse_api_key",
|
|
}
|
|
```
|
|
- BotMention(bot\_id) and OwnerID are **NOT** names of the owner and the bot. If you do not know the id of your bot, put 2 random numbers in those fields, run the bot and do `.uid @MyBotName` - that will give you your bot\_id, do the same for yourself `.uid @MyName` and copy the numbers in their respective fields.
|
|
- For google api key, you need to enable URL shortner and Youtube video search in the [dev console](https://console.developers.google.com/).
|
|
- For **ParseID** and **ParseKey**, you need to register on http://www.parse.com, get those values and create an app with these 3 classes: `'CommandsRan', 'Requests' and 'Stats'` in order to make the logging work http://i.imgur.com/bXsL19z.png.
|
|
- If you have **Windows7**, you need to install [Parse.Api](https://www.nuget.org/packages/Parse.Api/) instead of the library that comes with this project
|
|
- If you want to have music, you need to download FFMPEG from this link http://ffmpeg.zeranoe.com/builds/ (static build version) and add ffmpeg/bin folder to your PATH environment variable. You do that by opening explorer -> right click 'This PC' -> properties -> advanced system settings -> In the top part, there is a PATH field, add `;` to the end and then your ffmpeg install location /bin (for example ;C:\ffmpeg-5.6.7\bin) and save. Open command prompt and type ffmpeg to see if you added it correctly. If it says "command not found" then you made a mistake somewhere. There are a lot of guides on the internet on how to add stuff to your PATH, check them out if you are stuck.
|
|
|
|
Download [this folder](http://s000.tinyupload.com/index.php?file_id=54172283263968075500) which contains images and add it next to your .exe in order to make the $draw, $flip, rip and similar functions work.
|
|
|
|
You should replace nadeko's image with the image of your bot in order to make the hide/unhide commands work as intended.
|
|
You should **remove** Discord.Net projects from your solution, and use DLLs instead, as instructed above.
|
|
|
|
**You are all set.**
|
|
Fire up visual studio, wait for it to resolve dependencies and start NadekoBot.
|
|
|
|
Enjoy
|
|
|
|
##List of commands
|
|
(may be incomplete) last updated: 22.1.2016
|
|
|
|
Official repo: **github.com/Kwoth/NadekoBot/**
|
|
|
|
### Administration
|
|
Command and aliases | Description | Usage
|
|
----------------|--------------|-------
|
|
`-h`, `-help`, `@BotName help`, `@BotName h` | Help command
|
|
`-hgit` | Help command stylized for github readme
|
|
`.sr`, `.setrole` | Sets a role for a given user. | .sr @User Guest
|
|
`.rr`, `.removerole` | Removes a role from a given user. | .rr @User Admin
|
|
`.r`, `.role`, `.cr` | Creates a role with a given name, and color. | .r AwesomeRole Orange
|
|
`.color`, `.c` | Set a role's color to the rgb(0-255 0-255 0-255) color value provided. | .color Admin 255 255 255
|
|
`.b`, `.ban` | Bans a mentioned user
|
|
`.ub`, `.unban` | Unbans a mentioned user
|
|
`.k`, `.kick` | Kicks a mentioned user.
|
|
`.rvch` | Removes a voice channel with a given name.
|
|
`.vch`, `.cvch` | Creates a new voice channel with a given name.
|
|
`.rch`, `.rtch` | Removes a text channel with a given name.
|
|
`.ch`, `.tch` | Creates a new text channel with a given name.
|
|
`.st`, `.settopic` | Sets a topic on the current channel.
|
|
`.uid`, `.userid` | Shows user id
|
|
`.cid`, `.channelid` | Shows current channel id
|
|
`.sid`, `.serverid` | Shows current server id
|
|
`.stats` | Shows some basic stats for nadeko
|
|
`.leaveall` | Nadeko leaves all servers
|
|
`.prune` | Prunes a number of messages from the current channel. | .prune 50
|
|
`.die` | Works only for the owner. Shuts the bot down.
|
|
`.clr` | Clears some of nadeko's messages from the current channel.
|
|
`.newname` | Give the bot a new name.
|
|
`.setgame` | Sets the bot's game.**Owner only**.
|
|
`.greet` | Enables or Disables anouncements on the current channel when someone joins the server.
|
|
`.greetmsg` | Sets a new announce message. Type %user% if you want to mention the new member. | .greetmsg Welcome to the server, %user%.
|
|
`.bye` | Enables or Disables anouncements on the current channel when someone leaves the server.
|
|
`.byemsg` | Sets a new announce leave message. Type %user% if you want to mention the new member. | .byemsg %user% has left the server.
|
|
`.checkmyperms` | Checks your userspecific permissions on this channel.
|
|
`.commsuser` | Sets a user for through-bot communication. Only works if server is set.**Owner only**.
|
|
`.commsserver` | Sets a server for through-bot communication.**Owner only**.
|
|
`.send` | Send a message to someone on a different server through the bot.**Owner only.**
|
|
| .send Message text multi word!
|
|
|
|
### Conversations
|
|
Command and aliases | Description | Usage
|
|
----------------|--------------|-------
|
|
`\o\` | Nadeko replies with /o/
|
|
`/o/` | Nadeko replies with \o\
|
|
`@BotName copyme`, `@BotName cm` | Nadeko starts copying everything you say. Disable with cs
|
|
`@BotName cs`, `@BotName copystop` | Nadeko stops copying you
|
|
`@BotName uptime` | Shows how long is Nadeko running for.
|
|
`@BotName die` | Works only for the owner. Shuts the bot down.
|
|
`@BotName randserver` | Generates an invite to a random server and prints some stats.
|
|
`@BotName do you love me` | Replies with positive answer only to the bot owner.
|
|
`@BotName how are you` | Replies positive only if bot owner is online.
|
|
`@BotName insult` | Only works for owner. Insults @X person. | @NadekoBot insult @X.
|
|
`@BotName praise` | Only works for owner. Praises @X person. | @NadekoBot praise @X.
|
|
`@BotName are you real` | Useless.
|
|
`@BotName are you there`, `@BotName !`, `@BotName ?` | Checks if nadeko is operational.
|
|
`@BotName draw` | Nadeko instructs you to type $draw. Gambling functions start with $
|
|
`@BotName fire` | Shows a unicode fire message. Optional parameter [x] tells her how many times to repeat the fire. | @NadekoBot fire [x]
|
|
`@BotName rip` | Shows a grave image.Optional parameter [@X] instructs her to put X's name on the grave. | @NadekoBot rip [@X]
|
|
`@BotName j` | Joins a server using a code.
|
|
`@BotName save` | Saves something for the owner in a file.
|
|
`@BotName ls` | Shows all saved items.
|
|
`@BotName slm` | Shows the message where you were last mentioned in this channel (checks last 10k messages)
|
|
`@BotName cs` | Deletes all saves
|
|
`@BotName bb` | Says bye to someone. | @NadekoBot bb @X
|
|
`@BotName req`, `@BotName request` | Requests a feature for nadeko. | @NadekoBot req new_feature
|
|
`@BotName lr` | PMs the user all current nadeko requests.
|
|
`@BotName dr` | Deletes a request. Only owner is able to do this.
|
|
`@BotName rr` | Resolves a request. Only owner is able to do this.
|
|
`@BotName call` | Useless. Writes calling @X to chat. | @NadekoBot call @X
|
|
`@BotName hide` | Hides nadeko in plain sight!11!!
|
|
`@BotName unhide` | Unhides nadeko in plain sight!1!!1
|
|
`@BotName dump` | Dumps all of the invites it can to dump.txt
|
|
`@BotName av`, `@BotName avatar` | Shows a mentioned person's avatar. | ~av @X
|
|
|
|
### Gambling
|
|
Command and aliases | Description | Usage
|
|
----------------|--------------|-------
|
|
`$draw` | Draws a card from the deck.If you supply number [x], she draws up to 5 cards from the deck. | $draw [x]
|
|
`$flip` | Flips a coin, heads or tails, and shows an image of it.
|
|
`$roll` | Rolls 2 dice from 0-10. If you supply a number [x] it rolls up to 30 normal dice. | $roll [x]
|
|
|
|
### Games
|
|
Command and aliases | Description | Usage
|
|
----------------|--------------|-------
|
|
`t`, `-t` | Starts a game of trivia.
|
|
`tl`, `-tl`, `tlb`, `-tlb` | Shows a current trivia leaderboard.
|
|
`tq`, `-tq` | Quits current trivia after current question.
|
|
`>` | Attack a person. Supported attacks: 'splash', 'strike', 'burn', 'surge'. | > strike @User
|
|
`poketype` | Gets the users element type. Use this to do more damage with strike
|
|
|
|
### Music
|
|
Command and aliases | Description | Usage
|
|
----------------|--------------|-------
|
|
`!m n`, `!m next` | Goes to the next song in the queue.
|
|
`!m s`, `!m stop` | Completely stops the music and unbinds the bot from the channel and cleanes up files.
|
|
`!m p`, `!m pause` | Pauses the song
|
|
`!m q`, `!m yq` | Queue a song using keywords or link. **You must be in a voice channel**. | `!m q Dream Of Venice`
|
|
`!m np`, `!m playing` | Shows what song is playing.
|
|
`!m lq`, `!m ls`, `!m lp` | Lists up to 10 currently queued songs.
|
|
`!m clrbfr`, `!m clearbuffers` | Clears the music buffer across all servers. **Owner only.**
|
|
`!m sh` | Shuffles the current playlist.
|
|
|
|
### Searches
|
|
Command and aliases | Description | Usage
|
|
----------------|--------------|-------
|
|
`~yt` | Queries youtubes and embeds the first result
|
|
`~ani`, `~anime`, `~aq` | Queries anilist for an anime and shows the first result.
|
|
`~mang`, `~manga`, `~mq` | Queries anilist for a manga and shows the first result.
|
|
`~randomcat` | Shows a random cat image.
|
|
`~i`, `img` | Pulls a first image using a search parameter. Does not work atm. | @NadekoBot img Multiword_search_parameter
|
|
`~ir`, `imgrandom` | Pulls a random image using a search parameter. Does not work atm. | @NadekoBot img Multiword_search_parameter
|
|
`lmgtfy` | Google something for an idiot.
|