brown-town/README.md

# Brown-Town
A Discord welcome and moderation bot.

The current features are listed below:

### Features

Note that Brown Town is still early in development. Things are bound to change.

- [x] Send a welcome message when someone joins your Discord guild
- [x] Set a custom status for the bot
- [x] Naughty word filter
- [x] 3 lists that can be added to and removed from in real-time (badwords, potential-badwords, and whitelist)
- [x] Has support for `!bot` commands
- [x] Can DM moderators that choose to enable it

### Planned Features

- [ ] Add an option to send a DM to new guild members
- [ ] More to come

### Using the bot in your server
Currently, I don't host the bot publicly for people to use however, you can host it yourself. To do that, simply modify .env to your needs. [Creating a Discord token](https://www.writebots.com/discord-bot-token/) (give it admin permissions or tweak it to your needs). Now simply run `node index.js` or start `start.sh` and then you're done.

### Systemd (optional)
I included a sample Systemd service for your convience. Modify `/path/to/start.sh` in `brown-town.service` to the path of `start.sh`. Copy `brown-town.service` to `/etc/systemd/system/` or a local path if you'd prefer. Make sure `start.sh` is executable `chmod +x start.sh` then start the service with `systemctl start brown-town.service`.
Added readme and licence 2022-01-08 14:45:00 -07:00			`# Brown-Town`
Updated feature list in README.md 2023-09-09 22:28:47 -06:00			`A Discord welcome and moderation bot.`
Update README.md 2022-01-08 17:49:20 -07:00
Updated the README and added a systemd service file 2023-09-04 16:27:59 -06:00			`The current features are listed below:`
Update README.md 2022-01-08 17:49:20 -07:00
			`### Features`

			`Note that Brown Town is still early in development. Things are bound to change.`

			`- [x] Send a welcome message when someone joins your Discord guild`
			`- [x] Set a custom status for the bot`
Updated the checklist 2022-01-20 13:09:07 -07:00			`- [x] Naughty word filter`
Updated README with updated information 2023-09-04 15:42:32 -06:00			`- [x] 3 lists that can be added to and removed from in real-time (badwords, potential-badwords, and whitelist)`
Updated feature list in README.md 2023-09-09 22:28:47 -06:00			- [x] Has support for `!bot` commands
			`- [x] Can DM moderators that choose to enable it`
Update README.md 2022-01-08 17:49:20 -07:00
			`### Planned Features`

			`- [ ] Add an option to send a DM to new guild members`
			`- [ ] More to come`

			`### Using the bot in your server`
Updated the README and added a systemd service file 2023-09-04 16:27:59 -06:00			Currently, I don't host the bot publicly for people to use however, you can host it yourself. To do that, simply modify .env to your needs. [Creating a Discord token](https://www.writebots.com/discord-bot-token/) (give it admin permissions or tweak it to your needs). Now simply run `node index.js` or start `start.sh` and then you're done.

			`### Systemd (optional)`
			I included a sample Systemd service for your convience. Modify `/path/to/start.sh` in `brown-town.service` to the path of `start.sh`. Copy `brown-town.service` to `/etc/systemd/system/` or a local path if you'd prefer. Make sure `start.sh` is executable `chmod +x start.sh` then start the service with `systemctl start brown-town.service`.