https://github.com/compsigh/bot
Discord bot for compsigh, the social computer science club at the University of San Francisco
https://github.com/compsigh/bot
discordjs
Last synced: over 1 year ago
JSON representation
Discord bot for compsigh, the social computer science club at the University of San Francisco
- Host: GitHub
- URL: https://github.com/compsigh/bot
- Owner: compsigh
- Created: 2024-11-18T08:13:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-16T02:01:05.000Z (over 1 year ago)
- Last Synced: 2025-03-16T02:28:36.104Z (over 1 year ago)
- Topics: discordjs
- Language: TypeScript
- Homepage:
- Size: 582 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Compsigh Bot
Compsigh Bot is a Discord bot for the [compsigh](https://compsigh.club/) discord server. This bot is built using Discord.js and TypeScript.
## Table of Contents
- [Compsigh Bot](#compsigh-bot)
- [Table of Contents](#table-of-contents)
- [Features](#features)
- [Contributing](#contributing)
- [Getting Setup](#getting-setup)
- [Adding Commands](#adding-commands)
## Features
- **/ping**: Replies with "Pong!".
- **/petfaadil**: Pets Faadil and returns a random image of him.
- **/workingon**: Sets the project that you are working on to be displayed on the compsigh website's community page.
## Contributing
Contributions welcome! Feel free to make issues or pull requests. If you want to make your own feature, I would recommending messaging a leadership member first to make sure it's something that could get merged.
### Getting Setup
1. Fork the repo and clone.
2. Install dependencies:
```sh
npm install
```
3. Create a `.env` file in the root directory with your own variables:
```env
DISCORD_TOKEN=""
MONGO_URI=""
MARQUEE_API_KEY=""
```
4. Make a testing server with your version of the bot.
5. In `src/index.ts`, update the applicationId and add your server to the whitelist.
6. Run the bot
```sh
npm run dev
```
### Adding Commands
To add more commands, follow these steps:
1. Create a new file in the `src/commands` directory, e.g., `newcommand.ts`.
2. Define your command using the [`SlashCommandBuilder`](https://discord.js.org/docs/packages/discord.js/14.18.0/SlashCommandBuilder:Class) and implement the `execute` function. The ping is a good example to get started.
See also: https://discordjs.guide/creating-your-bot/slash-commands.html#individual-command-files
3. Import and add your command to the `commands` array in `src/commands.ts`.