The GUI for chatoverflow is still in development.
That's why whe have the Better REPL, an easy-to-use one-page dashboard, where everything can be controlled.
When using the GUI for the first time use the [Advanced] run configuration that packages the gui into the chatoverflow jar.
For all further runs you may use the [Simple] run configuration which is way faster.
Once the framework is running open http://localhost:2400/ in a browser and wait for the server status to display Connected!. Now click on OPEN BETTER REPL.
When running for the first time enter a password that you want to use for securing your credentials and click on REGISTER.
If you already are registered, use your password to login.
If the login was successful the gui will display the authentication key for this session.
Before running a plugin you have to create a plugin instance.
All available plugins are listed under Plugin types.
Add more plugins by putting the plugin .jar files into the plugins folder.
Enter the plugin name as well as the author of the plugin and give the instance a name (whatever you like), then click on CREATE:
The plugin instance should now be listed under Plugin instances:
You can use the pen to copy the name of an instance.
There are buttons that allow you to START / STOP an instance, to show its log (if running) or requirements and a button to DELETE the instance (just make sure to stop it before deleting it).
Before you can start a plugin you need to set its requirements.
A plugin can require a lot of things, for example Strings, Inputs or Outputs.
To view all requirements of a plugin enter the instance name and click on SHOW REQUIREMENTS.
You see that each requirement has a type and needs a value.
You see which requirements are already set and which ones are optional.
To set or change the value click on the blue pen, enter the required value and click on PUT.
For inputs and outputs the value should be the source identifier of a connector - which you first have to define.
To add a connector use whatever source identifier you like, specify the connector type (a list of all types can be found in the connector types box above) and click ADD. It will then be displayed in the list on the left side.
Every connector requires you to set the credentials for that service.
Use the blue pen to copy the identifier and the type to the connector and then use the manage credentials field to set key and value of the credentials.
Currently the only way to view which credentials a connector requires is to click on GET in the manage credentials section and have a look at the returned response which is displayed in the Last request section. It should look similar to this:
{"found":true,"sourceIdentifier":"twitch","uniqueTypeString":"org.codeoverflow.chatoverflow.requirement.service.twitch.chat.TwitchChatConnector","areCredentialsSet":true,"isRunning":false,"requiredCredentialKeys":["oauth"],"optionalCredentialKeys":[]}Look for requiredCredentialKeys and optionalCredentialKeys.
If you are getting errors when adding credentials Frequent-Issues might contain a solution.
Please note: Added credentials are encrypted with AES 128/256.