-
Notifications
You must be signed in to change notification settings - Fork 3
Getting Started
This page serves as a guide for a new user to start using the Prodosia application. It will go over the required steps to make the application functional.
Go to the latest release for this project:
https://github.com/RoseLaLuna/Prodosia/releases/latest
From this release, download Prodosia.vx.x.x.zip (where vx.x.x stands for the version number) and put it in a folder on your computer. This application will create several separate documents that will be placed in the same folder.
If updating the application from an old version, only the Prodosia.jar file needs to be replaced.
If issues are encountered while trying to open the application, ensure you have Java JRE 8 installed on your computer.
Main article: Imgur API Credentials
In order for the application to function, it is required to setup Imgur credentials. The above main article explains in detail how these credentials can be obtained and inserted into the application. When the bot is first opened it will direct to the API keys.
The keys for both the Imgur Api credentials and the Discord token are stored in a file named keys.txt which can be found in the same folder as the application executable. Should it be necessary to look them up or replace them, it can be done outside of the application as well by opening it with a text editor. For these changes to apply, the application needs to be restarted. For any change to the Imgur credentials it is also necessary to delete the cookie.txt file. If keys.txt is deleted, the Api credentials will have to be given again.
Be mindful of spreading the keys.txt file, regard it as if it were your password.
Main article: Discord token
It is optional, though highly recommended, to setup a discord bot account for the Prodosia application:
- Keep subscriptions and unsubscriptions in a central place.
- Maintain automated archives for specified taglists.
- Significantly faster response times than through imgur comments.
After the application is opened and the Imgur API credentials have been set up, the application will request for a login. Any comments posted by the application will be posted through this account.
Another file in the application folder, cookie.txt pertains to a cookie that is stored after a user has logged in. While a cookie is still active and functional, the application can be restarted without having to login again.
Sometimes after an imgur update the old cookie credentials won't be valid anymore. If experiencing issues with the bot not functioning, first attempt to remove the cookie, restart the application and then log in again. This should solve most problems.
The command prefix is a small piece of text which indicates that a command will follow. It is possible to set up a custom prefix.
In the application, go to
Status -> Prefix
By default, the prefix for Imgur is @Tagaroo and the prefix for Discord is the name of the Discord bot (visible as its ID). It is possible to set any number of prefixes for either service. Keep in mind that if no prefixes are selected for Imgur, it will not be possible to issue commands on Imgur.
It is not required for the prefix to be a mention, any text will do. Keep in mind that if the prefix is too short or ambiguous (like the for example) it might trigger on comments that do not contain commands.
It is possible to make a prefix case-insensitive by surrounding it with (?i) at the start and (?-i) at the end.
If you would like to know more about the components in the application and how they function, please refer to
Instructions
If you already know the components of the system, you will likely want to know more about
Commands and Syntax
If you would like to know more about the features of the application and their intentions, please refer to
Features
Find any bugs? Please consider making an account and starting an issue so it can be resolved.
New Issue