Skip to content

Latest commit

 

History

History
93 lines (68 loc) · 3.49 KB

README.md

File metadata and controls

93 lines (68 loc) · 3.49 KB
Raw

Header

🚀 Introduction

Welcome to the Discord Activity Tracker Bot repository. This advanced bot provides real-time tracking and broadcasting of user activities on Discord, including special integrations for music tracking via Spotify.

⏱️ Features

  • Activity Tracking: Tracks what users are playing, listening to, or watching in real-time.
  • Spotify Integration: Displays details about songs being played on Spotify.
  • Custom Status Updates: Updates user status based on their current activity.
  • Dynamic User Management: Supports user configuration via users.json for flexible activity tracking across multiple users.
  • Docker Support: Easy to deploy and manage using Docker.

💻 Technologies

This bot is developed using:

🐳 Installation and Setup

To set up the Discord Activity Tracker Bot, follow these instructions:

  1. Clone the Repository: Clone the repository to your machine or server.

    git clone https://github.com/nicokempe/discord-tracker.git

  2. Set Up Environment Variables:

  • Copy the .env.example file to a new file named .env.

    cp .env.example .env

  • Edit the .env file and replace the placeholder values with your actual Discord bot token, user ID, and the channel ID where messages will be posted.

    DISCORD_TOKEN=your_actual_discord_bot_token
GUILD_ID=your_guild_id

  1. Configure User Tracking: The bot allows tracking multiple users dynamically through a users.json file. This file specifies which users the bot should track and in which channels to post updates.

    Example users.json:

    {
  "users": [
    {
      "userId": "1234567890",
      "channelId": "9876543210",
      "isFanClub": false,
      "prefix": ":boom:",
      "mentionUser": true
    },
    {
      "userId": "0987654321",
      "channelId": "5678901234",
      "isFanClub": true,
      "prefix": ":star:",
      "mentionUser": false
    }
  ]
}

  2. Docker Setup: Make sure Docker is installed on your system. Use the Dockerfile to build and run the bot with Docker.

    Build and run with Docker:

    docker build -t discord-tracker .
docker run -d --name discord-tracker -v $(pwd)/config:/usr/src/app/config discord-tracker
    • The users.json should be placed inside the config folder in your project root, and Docker will mount this directory at runtime.

  3. Start the Bot: After setting everything up, start the bot. It will automatically begin tracking the specified users and post updates to the designated channels.

🚀 Usage

After setting up, the bot will automatically start tracking your Discord activities and update its status. It will also post updates about your activities in the designated Discord channel. Ensure the bot has the necessary permissions in your Discord server to function properly.

📝 Contributing

Contributions to the Discord Activity Tracker Bot are welcome. Please feel free to fork the repository, make your changes, and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.