Skip to content

Valhalla-Development/PreWatch

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PreWatch Banner

🔍 PreWatch: Scene Release Monitoring Made Easy 🚀

Discord Stars Forks Issues License
Codacy Powered by discord.js Made with TypeScript

Monitor scene releases in real-time and get instant Discord notifications for your favorite content!


🌟 Welcome to PreWatch!

PreWatch is a Discord bot that monitors scene releases from the PreDB in real-time. Subscribe to search queries and get instant notifications when matching releases are found, built with discordx and discord.js v14.

🎮 Features That Power PreWatch

🔍 Smart Query Monitoring

Subscribe to search queries and get notified when matching scene releases appear.

⚡ Real-time WebSocket Stream

Live connection for instant release notifications as they happen.

🎯 Intelligent Matching

Fuzzy matching algorithm optimized for scene releases with similarity detection.

💾 Lightweight Database

Keyv with SQLite backend for persistent subscription storage without SQL complexity.

🎨 Rich Discord Components

Beautiful Discord Components for all interactions with buttons and styled messages.

🔔 Flexible Notifications

Choose between DM or channel notifications with one-click unsubscribe buttons.

🚀 Requirements

🛠️ Setup Guide

  1. Download the latest release (click on 'Source code (zip)').

  2. Extract and move the files to your desired location.

  3. Install Bun:

    • Mac/Linux:
      curl -fsSL https://bun.sh/install | bash
    • Windows:
      powershell -c "irm bun.sh/install.ps1 | iex"
  4. Navigate to your project folder:

    cd /path/to/your/extracted/source
  5. Rename .env.example to .env and configure your settings:

  6. Install dependencies:

    bun install
  7. Start the bot:

    bun start

🎯 Commands

  • /add <query> - Subscribe to a search query for release notifications
  • /list - View and manage your active subscriptions
  • /help - Display all available commands
  • /ping - Check bot status and performance

📸 Screenshots

Adding Subscriptions
Add Command
Release Notifications
Release Notification
Subscription Management
List Command
Similarity Detection
Smart detection prevents duplicate subscriptions
Similarity Check

🤝 Contributing

We welcome contributions to improve PreWatch! If you'd like to contribute:

  1. Fork the repository
  2. Create a new branch for your feature or bug fix:
    git checkout -b feature/your-feature-name
  3. Make your changes and commit them with a clear, descriptive message:
    git commit -m 'Add feature: brief description of your changes'
  4. Push your changes to your fork:
    git push origin feature/your-feature-name
  5. Open a Pull Request against the main repository's main branch

Please ensure your code follows the existing patterns and include clear descriptions in your Pull Request. Focus on performance and user experience improvements.

📜 License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details. (It's mostly "Share the love, and keep it open!")

🙏 Acknowledgements

  • PredDB for the awesome scene release tracking
  • discord.js for the powerful Discord API wrapper
  • discordx for the decorator-based command framework
  • Bun for the blazing fast JavaScript runtime
  • Keyv for simple key-value storage

📬 Support & Community

Got questions or need help? Join our Discord server for support and to connect with other PreWatch users!


💻 Crafted with ❤️ by Valhalla-Development Built on the ValkyrieCore Discord bot template.

🐛 Spotted an issue? | 💡 Got an idea? | 🤔 Need help?

🔝 Back to Top

About

Monitor scene releases in real-time and get instant Discord notifications for your favorite content!

Resources

License

Stars

Watchers

Forks