Skip to content

Streamers-Workshop/Trovo.js

Repository files navigation


trovo.js


Discord server NPM version NPM downloads Patreon

Table of contents

About

trovo.js is a powerful Node.js module that allows you to easily interact with the Trovo API.

Example usage

For an example how to use this library please have a look at TrovoBot.

Reporting a bug

Before creating an issue, please ensure that it hasn't already been reported/suggested.

Contributing

The following infos are meant for developers. If you have any questions feel free to join our Discord (link above) and ask questions. If you would like to contribute in any way (bugfixes, features, etc.) please adhere to the following points

  • Fork this repository, create a feature branch, do your changes in this feature branch and then create a Pull Request from that. Your pull request needs to be auto-mergeable. Therefore if there were any intermediate commits on the project since you created the feature branch, please resolve the conflicts by e.g. rebasing your branch.
  • The project exploded in the first couple of days (feature and commit wise) which resulted in a messy code base. That's why we decided to use Prettier & ESLint. Before creating a Pull Request your code has to match these requirements. To display any errors run node ./node_modules/eslint/bin/eslint.js .

This will display all errors and warnings. Most of these things can probably be fixed automatically (like code formatting). To do this, run node ./node_modules/eslint/bin/eslint.js . --fix

Help

If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official Trovo.js Server.

Events

  • chatEvent ~ Event for a Group of Events
    • Sub Events
      • userJoined ~ When a user has joined a Channel
      • userFollowed ~ When a user has Followed the Channel
      • userSubbed ~ When a user has Subbed to the Channel
      • giftRecieved ~ When a user has sent a Gift to the Channel
  • chatMessage ~ General Chat Message from a User
  • dialog ~ Dialog popup output from the Browser [To be Removed when we move away from puppeteer]
  • console ~ Console output from the Browser [To be Removed when we move away from puppeteer]
  • wsClosed ~ Triggered when a Websocket is Closed.
  • wsCreated ~ Triggered when a Websocket is Created
  • jsonData ~ JsonData received.

Functions

  • newPage ~ Opens a new Page on the headless browsers.
  • login ~ Logins with a user, to a specific page.
  • sendMessage ~ Sends Message to the Channel
  • dialogResponse ~ used for when a dialog is triggered to send a emit [Internal]
  • consoleResponse ~ used for when a console output is triggered to send a emit [Internal]

About

First Trovo Chatbot Client

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published