Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tyowk/nouactivities
A simple, open-source Discord activities bot, built with HTTP interactions.
https://github.com/tyowk/nouactivities
activities discord discord-activities discord-interactions discord-js express
Last synced: 7 days ago
JSON representation
A simple, open-source Discord activities bot, built with HTTP interactions.
- Host: GitHub
- URL: https://github.com/tyowk/nouactivities
- Owner: tyowk
- License: mit
- Created: 2024-12-09T00:58:33.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-28T14:29:47.000Z (16 days ago)
- Last Synced: 2025-01-28T15:30:20.607Z (16 days ago)
- Topics: activities, discord, discord-activities, discord-interactions, discord-js, express
- Language: JavaScript
- Homepage: https://activities.noujs.my.id
- Size: 134 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://top.gg/bot/1305829720213950474/invite)
# NouActivities
NouActivities is a simple, open-source Discord activities bot built using HTTP interactions.
## Installation
**Vercel Deploy:**
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Ftyowk%2FNouActivities%2Ftree%2Fmain&env=TOKEN,KEY,ID,REPORT,VOTE,AUTH&project-name=activities&repository-name=activities)
**Follow these steps to install and run the bot:**
1. **Clone the repository**:
```bash
git clone https://github.com/tyowk/NouActivities.git
cd NouActivities
```
2. **Install dependencies**:
```bash
npm install
```
3. **Create a `.env` file** in the root of the project directory with the following contents:
```bash
TOKEN="your-bot-token-here"
REPORT="your-report-channel-id-here"
KEY="your-bot-public-key-here"
ID="your-bot-client-id"
PORT="your-server-port-here"
# optional
VOTE="your-vote-channel-logs"
AUTH="topgg-webhook-auth"
```
- Replace `your-bot-token-here` with your Discord bot token (you can get this from the Discord Developer Portal).
- Replace `your-report-channel-id-here` with the channel ID where you want report logs to be sent.
- Replace `your-bot-public-key-here` with your bot's public key (found in the bot's settings in the Discord Developer Portal).
- Replace `your-bot-client-id` with your bot's client id (found in the bot's settings in the Discord Developer Portal).
- Set `your-server-port-here` to the port number your bot will run on.
4. **Run the bot**:
```bash
npm start
```
5. **Configure your bot’s interaction endpoint**:
In the **[Discord Developer Portal](https://discord.com/developers/applications)**, go to your bot's application settings, and navigate to the **Interactions Endpoint URL** section. Set the **Interaction URL** to:
```bash
https:///interactions
```
## Commands
Here are some of the available commands:
- `/activities`: Displays a list of available activities.
- `/help`: Shows a list of all commands and their usage.
- `/invite`: Provides an invite link to add the bot to your server.
- `/ping`: Checks if the bot is responsive.
## Endpoints
Here are some of the available endpoints:
- **`PUT`** `/register`: Register client slash commands (optional, because when the client receives a PING from discord, the slash command will be automatically registered).
- **`POST`** `/interactions`: Accept all POST requests from Discord interactions.
- **`POST`** `/webhook`: Accept all POST requests from Top.gg vote webhook.
## Contributing
We welcome contributions to improve the bot! To contribute:
1. Fork this repository.
2. Create a new branch:
```bash
git checkout -b feature-name
```
3. Make your changes and commit them:
```bash
git commit -m 'Add new feature'
```
4. Push your changes to your forked repository:
```bash
git push origin feature-name
```
5. Open a pull request to the main repository.
Please ensure that your code follows the existing coding style and passes any tests or linters in place.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/tyowk/NouActivities/tree/main/LICENSE) file for more details.
## Acknowledgements
- [discord.js](https://discord.js.org/): The library used to interact with the Discord API.
- [discord-interactions](https://www.npmjs.com/package/discord-interactions): A library that simplifies working with slash commands and Discord interactions.
- [express](https://www.npmjs.com/package/express): A fast and minimalist web framework for Node.js.