Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/endbug/uptime-monitor
A package that lets you quickly set up a Discord bot that notifies you when one of your tracked targets goes offline.
https://github.com/endbug/uptime-monitor
discord discord-bot discord-js hacktoberfest javascript nodejs npm
Last synced: 18 days ago
JSON representation
A package that lets you quickly set up a Discord bot that notifies you when one of your tracked targets goes offline.
- Host: GitHub
- URL: https://github.com/endbug/uptime-monitor
- Owner: EndBug
- License: mit
- Created: 2018-06-08T17:21:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-20T09:55:28.000Z (5 months ago)
- Last Synced: 2024-10-18T17:15:35.584Z (20 days ago)
- Topics: discord, discord-bot, discord-js, hacktoberfest, javascript, nodejs, npm
- Language: TypeScript
- Homepage:
- Size: 349 KB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# uptime-monitor [](https://npmjs.org/package/uptime-monitor) [](https://npmjs.org/package/uptime-monitor) [](https://lgtm.com/projects/g/EndBug/uptime-monitor/context:javascript)
A Discord bot that notifies you when one of the watched bots/users goes offline for a continued period of time.
## Installation
```sh
$ npm install --save uptime-monitor
```
## Settings
To use the bot, you'll need to create an object with these settings:
- `commands`: an object structured as `commandName:boolean` where you can choose wich commands to activate (by default they all get loaded). Available commands are `on`, `off` and `list`.
- `list`: an array of arrays where you can add your targets; you can find more info about the format under this list.
- `refresh`: number of milliseconds for the bot to refresh; by default is every five seconds.
- `owner_id`: your ID.
- `other_owners`: the ID/an array with the IDs of other owners (people that can use the commands).
- `send_to`: the user/guild channel (in the `'guildID/channelID'` format) to send the messages to. By default, this is the owner.
- `status.on` & `status.off`: two objects with a `text` and a `type` that will be used for the bot presence.
- `token`: your token.
In `list` every element has to follow this format: `[codeName, discordID, timeout]`, with `timeout` as a number. `codeName` is a name that will be used to identify the bot for debugging purposes; `timeout` is the number of minutes the bot has to wait to notify you: you can set this to zero, but it'll notify you even if your bot goes offline for a very little time.
If your IDE has TypeScript support then it'll help you by showing you which settings you can use and their documentation.
You can look at the example in the [Usage](#usage) section.
## Improvements
If you want to contribute to this package please take a look at the [contributing guide](CONTRIBUTING.md). If you find a bug feel free to open an issue on [GitHub](https://github.com/EndBug/uptime-monitor/issues) or submit a PR.
## Usage
```js
const UptimeMonitor = require('uptime-monitor');
const bot = new UptimeMonitor.Bot({
commands: {
on: true,
off: true,
list: true
},
list: [
['Its name', 'Its ID', 3]
],
refresh: 5000,
owner_id: 'Your ID',
other_owners: ['Their IDs'],
send_to: 'Their ID or guildID/channelID',
status: {
on: {
name: 'text displayed while online',
type: 'WATCHING'
},
off: {
name: 'text displayed by offline',
type: 'WATCHING'
}
},
token: 'Your bot\'s token'
});
```
You can also try this example online with [RunKit](https://npm.runkit.com/uptime-monitor).
## Changelog
To see the version changelog, you can look [here](https://github.com/EndBug/uptime-monitor/blob/master/CHANGELOG.md).
## License
MIT © [Federico Grandi](https://github.com/EndBug)
[View full license](https://github.com/EndBug/uptime-monitor/blob/master/LICENSE)