Skip to content

Commit

Permalink
Rename config.json to config.sample.json
Browse files Browse the repository at this point in the history
  • Loading branch information
Androz2091 committed May 15, 2019
1 parent e6f8d35 commit 0553275
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules

config.json
json.sqlite
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,13 @@ This bot contains the following commands :

## Setup

You need to edit the config.json file before starting the bot.
You need to rename the `config.sample.json` file to `config.json` and edit it before starting the bot.

```Json
{
"token":"your discord bot secret token",
"prefix":"!",
"game":"made by Androz",
"embed":{
"color":"#ff5b5b",
"footer":"By Androz#2091"
Expand All @@ -39,6 +40,7 @@ You need to edit the config.json file before starting the bot.

In the token field, replace `your discord bot secret token` by your bot token.
In the prefix field, put your bot prefix (the character(s) before the command). For example, if the prefix is `$`, the command profile should be called with `$profile` .
The game is the status of your bot, for example "Androz" will show "playing to Androz".
The embed object contains two values : `color` and `footer`.
In the color field, put an hexadecimal color, this will be used for the color to the left of the embeds.
In the footer field, put what you want, it will appear at the bottom of the embeds, maybe the name of your bot?
Expand Down
1 change: 1 addition & 0 deletions config.json → config.sample.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"token":"your discord bot secret token",
"prefix":"!",
"game":"made by Androz",
"embed":{
"color":"#ff5b5b",
"footer":"By Androz#2091 | Open Source DiscordBot"
Expand Down

0 comments on commit 0553275

Please sign in to comment.