Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dev documentation #63

Open
wants to merge 1 commit into
base: devel
Choose a base branch
from
Open

Dev documentation #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,20 @@
# scepter
Spiritual successor to Nixbot

## Requirements
* Node >= 10.15
* [A Discord bot account](https://www.digitaltrends.com/gaming/how-to-make-a-discord-bot/)

## Contributing

* Clone the repo
* Install dependencies `npm i`
* Set up the required environment variables:

* SCEPTER_BOT_GUILD: The bot's instance's main server, in which logging will occur
* SCEPTER_DISCORD_TOKEN: The bot's token, as given to you by Discord's development site
* SCEPTER_OWNER_IDS: A colon-separated list of user IDs with elevated permissions

* Make sure your changes pass the linter before submitting them

* The repo's husky hook should take care of it, but just in case keep its checks in mind