Kweikobot is a Discord bot designed to be used on a server of a Twitch streamer.
Before you begin, ensure you have met the following requirements:
- You have a Discord account.
- You have a Discord server where you have permission to add bots.
- You have Node.js and npm installed on your local machine.
-
Clone the Repository
git clone https://github.com/jastka4/kweikobot.git cd kweikobot -
Install Dependencies
npm install
-
Setup Environment Variables
Create a
.envfile in the root directory of the project, and add your Discord bot token and Client ID/Application ID:DISCORD_BOT_TOKEN=your-discord-bot-token DISCORD_CLIENT_ID=your-discord-client-id
-
Run the Bot
npm start
-
Invite the Bot to Your Server
Generate an invite link for your bot using the Discord Developer Portal and invite the bot to your server.
-
Use Commands
Once the bot is in your server, use the commands listed below to interact with it.
| Command | Description | Examples |
|---|---|---|
/windows |
Check if Kweik has activated her Windows instance. | /windows |
Contributions are welcome! To contribute, please follow these steps:
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature). - Make your changes and commit them (
git commit -m 'Add some feature'). - Push to the branch (
git push origin feature/your-feature). - Open a pull request to the original repository.
If you have any questions or suggestions, feel free to open an issue or reach out to me.