https://github.com/ayan4m1/screechr

Monitor your Pterodactyl servers and send status updates to Discord.
https://github.com/ayan4m1/screechr

Last synced: 4 months ago
JSON representation

Monitor your Pterodactyl servers and send status updates to Discord.

• Host: GitHub
• URL: https://github.com/ayan4m1/screechr
• Owner: ayan4m1
• License: mit
• Created: 2019-04-14T03:15:26.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-05-07T05:53:13.000Z (about 4 years ago)
• Last Synced: 2025-02-28T07:03:01.478Z (over 1 year ago)
• Language: JavaScript
• Size: 318 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: .github/CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Screechr

This software monitors a configurable list of Pterodactyl servers and notifies a Discord text channel when the status changes.

## Documentation

Our more comprehensive documentation is located at [https://docs.screechr.com](https://docs.screechr.com). It has a full tutorial and more exhaustive explanation of the configuration system.

## Screenshot

![Status updates](https://i.imgur.com/5Ln1oUSl.png)

## Tutorial

The tutorial has moved to the [documentation website](https://docs.screechr.com/).

## Configuration

Screechr uses [Cosmiconfig](https://github.com/davidtheclark/cosmiconfig#cosmiconfig), which supports JSON, YAML, or JS-based configuration. The default configuration file is in YAML format, but it should be easily portable if you prefer to work in another.

Your configuration filename should start with `.screechrrc` (note the two Rs at the end) and end with an extension appropriate for the format of the document (e.g. `.screechrrc.yml`).

Please see the [default configuration](.screechrrc.default.yml) for detailed documentation and examples on each of the available options.

## Support

Please check the [documentation](https://docs.screechr.com/help/) for a variety of ways to get help if you are having trouble with installation, configuration, or use of the software. Please do not open GitHub issues for support requests.