https://github.com/decaded/wampierz
A Discord bot for monitoring and displaying server status updates, featuring automated data fetching, status messages, and real-time updates.
https://github.com/decaded/wampierz
api discord-bot server steamid v-rising
Last synced: 3 months ago
JSON representation
A Discord bot for monitoring and displaying server status updates, featuring automated data fetching, status messages, and real-time updates.
- Host: GitHub
- URL: https://github.com/decaded/wampierz
- Owner: Decaded
- License: mit
- Created: 2024-05-19T14:09:10.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-20T23:48:39.000Z (10 months ago)
- Last Synced: 2025-01-18T06:40:12.713Z (5 months ago)
- Topics: api, discord-bot, server, steamid, v-rising
- Language: JavaScript
- Homepage:
- Size: 107 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Wampierz Discord Bot
Wampierz is a Discord bot designed to fetch and display SteamID information for V Rising servers using the [CeloAPI](https://github.com/Celofyz/vrising-server-api). This bot allows server administrators to set the update channel,
update interval, and API URL via Discord commands.
## Features
- **Set Update Channel**: Administrators can specify a channel where server update notifications will be posted.
- **Set Update Interval**: Configurable update interval to fetch server data from the API.
- **Set API URL**: Allows setting the URL for the API to fetch server data.
- **Restart Command**: Supports restarting the bot (requires appropriate permissions).
## Commands
- `/setchannel`: Set the update channel for server notifications.
- `/setinterval`: Set the update interval in seconds (minimum 10 seconds).
- `/setapiurl`: Set the API URL for fetching server data.
- `/setrole`: Set role that will have permission to use this commands.
- `/restart`: Restart the bot.
## Prerequisites
- Node.js >= 14.0.0
- Discord Bot Token
- Discord Server ID
- Role with appropriate permissions (e.g., 'Wampyr' role)
## Installation
1. Clone the repository:
```bash
git clone https://github.com/Decaded/wampierz.git
```
2. Install dependencies:
```bash
npm install
```
3. Configure environment variables:
Create a `.env` file in the root directory with the following variables:
```dotenv
BOT_TOKEN=your_discord_bot_token_here
GUILD_ID=your_discord_server_id_here
CLIENT_ID=your_discord_bot_client_id_here
```
4. Start the bot:
```bash
npm start
```
## Configuration
The bot uses `.env` file for configuration. Ensure you have set the following variables:
`BOT_TOKEN`: Your Discord bot token. `GUILD_ID`: Your Discord server ID. `CLIENT_ID`: Your Discord bot client ID.
## Contributing
Contributions are welcome! If you have suggestions or found a bug, please [open an issue](https://github.com/Decaded/wampierz/issues).
## License
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.