Skip to content

Commit b6d5329

Browse files
Homage to OG contributors (#49)
* Pay homage to prior art * Beef up the README
1 parent 542a070 commit b6d5329

2 files changed

Lines changed: 30 additions & 14 deletions

File tree

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,15 @@
44

55
> This project is undergoing rapid development and should be considered experimental. Use it at your own risk. 🤙
66
7+
A bot to help manage the activities and community of BYU's Computer Science Discord server.
8+
9+
This project is meant as a successor to [Ze-Kaiser](https://github.com/ArkenStorm/Ze-Kaiser), whose original contributors are as follows:
10+
11+
- [**ArkenStorm**](https://github.com/ArkenStorm)
12+
- [**Carterworks**](https://github.com/Carterworks)
13+
- [**EmmaChase**](https://github.com/EmmaChase)
14+
- [**TheZealotAlmighty**](https://github.com/TheZealotAlmighty)
15+
716
## Authors & Contributors
817

918
This list is updated as contributors contribute.
@@ -26,7 +35,7 @@ This list is updated as contributors contribute.
2635
- [Configure the bot](#configure-the-bot)
2736
- [Invite your bot to your server](#invite-your-bot-to-your-server)
2837
- [Important Note for Windows Users](#important-note-for-windows-users)
29-
- [Build the bot server](#build-the-bot-server)
38+
- [Build the bot](#build-the-bot)
3039
- [Register Slash Commands](#register-slash-commands)
3140
- [Run the bot](#run-the-bot)
3241
- [Commands](#commands)
@@ -87,19 +96,12 @@ $ npm config set script-shell "C:\\Program Files\\Git\\bin\\bash.exe"
8796

8897
You must have [Git for Windows](https://git-scm.com/download/win) installed. See this [StackOverflow answer](https://stackoverflow.com/a/46006249) for more details.
8998

90-
### Build the bot server
91-
92-
Be sure to install dependencies, and run a quick lint to generate needed files:
93-
94-
```sh
95-
$ npm ci
96-
$ npm run lint
97-
```
99+
### Build the bot
98100

99-
The first time you download the source, and each time the source code changes, you'll need to run this command before you run the bot:
101+
Be sure to install dependencies, run a quick lint to generate needed files, compile the source, and deploy commands. Here's a handy command to do all of that:
100102

101103
```sh
102-
$ npm run build
104+
$ npm run setup
103105
```
104106

105107
### Register Slash Commands
@@ -124,11 +126,25 @@ $ npm start
124126
$ pm2 start .
125127
```
126128

127-
## Commands
129+
## Chat Input Commands
128130

129131
### /help
130132

131-
Prints the list of commands.
133+
Prints some info about the bot, including the current running version and a link to the code repository.
134+
135+
### /profile
136+
137+
Retrieves the profile picture of the given user.
138+
139+
### /xkcd
140+
141+
Retrieves the most recent [XKCD](https://xkcd.com/) comic, or the given one.
142+
143+
## Context Menu Commands
144+
145+
### Fix Twitter Links
146+
147+
Transforms [twitter.com](https://twitter.com/) links in the given message to [vxtwitter.com](https://vxtwitter.com/) links in an ephemeral reply. Please use vxtwitter in your own messages, especially when the tweet is a video. Twitter's default embed stinks on some platforms.
132148

133149
## Contributing
134150

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"private": true,
66
"scripts": {
77
"start": "NODE_ENV=development ./node_modules/.bin/nodemon --inspect ./dist/main.js",
8-
"setup": "rm -r dist && npm ci && npm run export-version && npm run build:only --production && npm run baseline && npm run prisma:migrate && npm run commands:deploy",
8+
"setup": "rm -rf dist && npm ci && npm run export-version && npm run build:only --production && npm run commands:deploy",
99
"commands:deploy": "node . --deploy",
1010
"commands:revoke": "node . --revoke",
1111
"baseline": "./node_modules/.bin/prisma migrate resolve --applied 20220915022732_initial_state # TODO: Use this to set initial tables on the database",

0 commit comments

Comments
 (0)