Logo

Streaming Automation Software

Support
·
Download
·
Report Bug
·
Request Feature

What is xyz?

xyz, is a tool for automating actions based on events from various sources used by streamers (Twitch, OBS, Discord). It can be extended to include other sources. Checkout the Echo Extension for an example of a simple extension.

Prerequisites

These are required for all extensions to work properly.

Configuration

  1. Get your Twitch OAuth Token and Twitch Channel ID
  2. Make a copy of settings.default.toml named settings.toml
  3. Fill out the appropriate fields in settings.toml

Usage

By default running xyz does not output anything, and will send all logs to a new file called activity.log in the same directory. Using -verbose, will send logs to the console instead of to a log file.

Use xyz -help to see all available command options.

Roadmap

  • ALPHA
    • Extensions
      • OBS
      • Twitch IRC
      • Twitch Pub Sub
      • Discord
      • Configurable Event Responses
  • BETA
    • UI
      • Edit Settings Page
      • Setup Configurable Event Responses

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”.
Don’t forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/YourNewExtension)
  3. Commit your Changes (git commit -m 'Add YourNewExtension')
  4. Push to the Branch (git push origin feature/YourNewExtension)
  5. Open a Pull Request

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

Contributors

GitHub

View Github