Sueta

RedditAPI

1.2

Allows a plugin to obtain data from reddit via a registered bot, through the Java Reddit API Wrapper

·Plugin


RedditAPI

A very light plugin that provides a reddit API interface.

NON-DEVELOPER INSTRUCTIONS
Download the plugin, run it, then follow instructions 3 to 6 in the Usage section of the GitHub README to set up the plugin.

What does it do?
Essentially, it allows a plugin to obtain data from reddit via a registered bot, through the Java Reddit API Wrapper.

One must register a ConnectHandler when they would like to receive a JRAW RedditClient object, from which queries to the official reddit API are wrapped.

Upon loading/reloading the plugin, or calling the /redditapi connect command, a valid RedditClient object is passed to the registered ConnectHandlers, if a valid one can be obtained from the settings defined in the config.

How do I use it?
See the usage guide in the README of the GitHub repository.

Once you have obtained your RedditClient, refer to the JRAW Cookbook for a usage guide.

Commands and permissions:
Since this plugin is to be used for its RedditClient interface, it has a very minimal set of commands:

  • /redditapi - shows a help message for the plugin.
    Permission node: redditcraft
    Aliases: /ra
  • /redditapi connect - reloads the config and attempts to provide the RedditClient to the plugins using the API. Essentially reloads the plugin in this version.
    Permission node: redditcraft
    Aliases: /ra connect, /ra con

Versions:
Since the plugin is new, the only tested version is the version is was written for: 1.13.

In theory it should work for other versions, but if it doesn't work, please let me know by sending me a message through Discord: omarathon#2226, and I'll look into making it compatible for your erroneous version.
In the meantime, I recommend you construct your own JRAW connection.

I intend to test it for more versions, and to make it compatible for any incompatible versions I discover.

Bugs:
If you discover a bug, please raise an issue in the plugin GitHub repository. Alternatively, send me a message through Discord: omarathon#2226.

Usage Disclaimer:
I take no liability for any of the actions performed, or the security of, any of the authenticated reddit accounts or bots that the plugin may interface with.

Similar projects

Plugin →