https://github.com/shellbear/web-watcher

A discord bot which monitor and send alerts on website changes.
https://github.com/shellbear/web-watcher

discord discord-bot go golang website

Last synced: 6 days ago
JSON representation

A discord bot which monitor and send alerts on website changes.

• Host: GitHub
• URL: https://github.com/shellbear/web-watcher
• Owner: shellbear
• License: mit
• Created: 2019-09-06T20:38:46.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-07-26T13:43:14.000Z (over 1 year ago)
• Last Synced: 2024-06-20T08:03:40.625Z (5 months ago)
• Topics: discord, discord-bot, go, golang, website
• Language: Go
• Homepage: https://shellbear.github.io/web-watcher/
• Size: 4.23 MB
• Stars: 29
• Watchers: 5
• Forks: 15
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
web-watcher

  
A small Discord bot which aims to alert you on website changes.




  

    

  

  

    

  

  

      

    

  

  

    

  



---

## Recent Update

Due to Discord API changes, please make sure to enable your Discord Bot `Message Content Intent` permission to work and be able to read Discord commands.

![Bot Privilege](www/static/bot-privilege.png)

More instructions here: [https://shellbear.github.io/web-watcher/requirements/](https://shellbear.github.io/web-watcher/requirements/)

---

## Documentation

A full documentation is available at [https://shellbear.github.io/web-watcher](https://shellbear.github.io/web-watcher).

## Usage

```bash

> web-watcher --help

Web-watcher discord Bot.

Options:

  -delay int

        Watch delay in minutes (default 60)

  -prefix string

        The discord commands prefix (default "!")

  -ratio float

        Changes detection ratio (default 1)

  -token string

        Discord token

```

By default, the watch interval for every website is 1 hour, but you can easily change this with the `interval` parameter

followed by the interval in minutes.

```bash

export DISCORD_TOKEN=YOUR_DISCORD_TOKEN

# Set watch interval to 10 minutes, defaults to 60 minutes

web-watcher --interval 10

# OR

# Set watch interval to 10 minutes, defaults to 60 minutes

web-watcher --token YOUR_DISCORD_TOKEN --interval 10

```

## Discord commands

#### !watch [URL]

Add a URL to the watchlist.

#### !unwatch [URL]

Remove a URL from the watchlist.

#### !watchlist

Get the complete watchlist.

## Built With

- [go-difflib](https://github.com/pmezard/go-difflib) - Partial port of Python difflib package to Go

- [xxhash](https://github.com/cespare/xxhash) - Go implementation of the 64-bit xxHash algorithm (XXH64)

- [Gorm](https://github.com/jinzhu/gorm) - The fantastic ORM library for Golang

- [DiscordGo](https://github.com/bwmarrin/discordgo) - Go bindings for Discord

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details