diff --git a/README.md b/README.md index 9815ca55..ffcea6c4 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,32 @@ +![](https://i.imgur.com/lwD2EOn.png) -[![Discord](https://discordapp.com/api/guilds/492875641713328143/embed.png)](https://discord.gg/3hbeQgY) ![Hex.pm](https://img.shields.io/hexpm/l/plug.svg) ![Github Release](https://img.shields.io/github/release/VenkSociety/Cogent.svg) [![DiscordJS](https://img.shields.io/npm/v/discord.js.svg?maxAge=2592000)](https://www.npmjs.com/package/discord.js) - -![](/lib/img/3d.png) +

+ + + + + +

## A light-weight modular Discord bot built with DiscordJS. + +### Features +- Currency system +- Fun games and commands +- Moderation and logging +- Helpful community and quality support + ### Installation: A couple of dependencies you will need: [NodeJS](https://nodejs.org/en/download/) - A JavaScript runtime, it also has NPM built-in. -Once installed, type the following into a command prompt: +Once NodeJS is installed, install the npm dependencies. For example; the code below will install the `discord.js` package. - ```npm install discord.js``` -- ```npm install got``` -After that, installation is a simple as a couple of mouse clicks *(and patience depending on your internet speed)*. Simply download the latest release .zip from [here](https://github.com/VenkSociety/Cogent/releases), extract and run **_Cogent-Bot.exe_** and you're done, it's that easy! +Do this for each package in [package.json](https://github.com/VenkSociety/Cogent/blob/master/package.json#L18). + +Now that the hard part is over, installation is a simple as a couple of clicks *(and patience depending on your internet speed)*. Simply download the latest release .zip from [here](https://github.com/VenkSociety/Cogent/releases), extract and run **_run.bat_** and you're done, it's that easy! ### Configuration: By default, the only thing you will need to edit in **_config.json_** is the bot's token. If you're not sure on how to get a bot token, you can follow the [tutorial](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token) made by our friends over at [Reactiflux](https://www.reactiflux.com/). @@ -29,8 +42,8 @@ By default, the only thing you will need to edit in **_config.json_** is the bot "default_role": "welcome", "mod_role": "Moderator", - "welcome_channel": "general", - "log_channel": "logs" + "log_channel": "logs", + "welcome_channel": "general" } Optionally, you can edit the other stuff too. If you're not sure what an option means, feel free to take a peak [here](https://github.com/VenkSociety/Cogent/wiki/Config.js). @@ -42,13 +55,7 @@ A full list of commands and how to use them can be found [here](https://github.c Due to the extremely long amount of text, you can find information on editing files, pull requests, merge requests and issues [here](https://github.com/VenkSociety/Cogent/wiki/Contributing-Guidelines). ### Don't want to host the bot yourself? -We have a public instance of the bot which you can add to your Discord [here](https://discordapp.com/oauth2/authorize?client_id=492871769485475840&scope=bot&permissions=8 ). +We have a public instance of the bot which you can add to your Discord [here](https://discordapp.com/oauth2/authorize?client_id=492871769485475840&scope=bot&permissions=1506142455). ### Didn't answer your question? -Why not join the [official Cogent Bot Discord](https://discord.gg/3hbeQg)? With lots of things to do and loads of members to chat with, it's one of the most friendly places on the internet... sorta. - - - - - - +Why not join the [official Cogent Bot Discord](https://discord.gg/3hbeQgY)? With lots of things to do and loads of members to chat with, it's one of the most friendly places on the internet... sorta. diff --git a/commands/help.js b/commands/help.js index b0c6d3eb..c9d78af5 100644 --- a/commands/help.js +++ b/commands/help.js @@ -6,6 +6,7 @@ const embed = new Discord.RichEmbed() .setTitle("Help") .setColor(colors.blue) .setThumbnail("https://cdn.discordapp.com/avatars/492871769485475840/845886deb497cbb6d181243a0d1de13f.png?size=2048") + .setImage("https://i.imgur.com/OYnkRF7.png") .addField("Commands", `Commands can be found by typing \`${prefix}commands\`.`) .addField("Want to invite me to your Discord?", `[Click here to invite me to your server.](https://discordapp.com/oauth2/authorize?client_id=492871769485475840&scope=bot&permissions=1506142455)`) .addField(`Need more assistance?`, `Why not join the official Cogent bot community Discord? \n[Click here to join.](https://discord.gg/3hbeQgY)`); diff --git a/run.bat b/run.bat new file mode 100644 index 00000000..e929def9 --- /dev/null +++ b/run.bat @@ -0,0 +1,2 @@ +cd +node bot \ No newline at end of file