Skip to content

Commit

Permalink
add README
Browse files Browse the repository at this point in the history
  • Loading branch information
paul-mueser committed Feb 20, 2024
1 parent 5837baf commit c46ac1b
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# Basic discord bot using discord js

## [](#before-starting)Before starting
### [](#setup)Setup
After you have cloned the repo make sure to create a `.env` file with the `TOKEN` specified for example

```
TOKEN=xxx
```

### [](#developing-and-testing)Developing & testing
For testing, you can change the `testServer` and `devs` properties in `config.json` for example

```
testServer=xxx
devs=[xxx,yyy,zzz]
```

## [](#commands)Commands
### [](#misc)Misc
- ping - Pong!

### [](#moderation)Moderation
- ban {target-user} {reason} - bans a member from the server
- kick {target-user} {reason} - kicks a member from the server
- timeout {target-user} {duration} {reason} - timeout a user for the specified time

### [](#quotes)Quotes
- authorstats - replies with the authorstats of "Zitate"
- quoteby {author} - replies with the quotes of a specific person
- stats - replies with the stats of "Zitate"

0 comments on commit c46ac1b

Please sign in to comment.