You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Aug 18, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: development/Deploy-ChatOverflow.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -3,4 +3,4 @@ To deploy Chat Overflow and create runnable jar files, follow these steps:
3
3
1. Execute the IntelliJ run configuration `[Deploy] Generate Bootstrap Launcher and deploy` or run the make target with `make bootstrap_deploy`. This updates the `dependencies.xml`-file in the bootstrap-project with the current dependencies, bundles everything and copies it along with start scripts, the license and a readme to the `deploy`-folder. Magic.
4
4
2. Navigate to the `deploy`-folder and run the bootstrap launcher with `java -jar ChatOverflow.jar`. After downloading all libraries, a standalone version of Chat Overflow should be started.
5
5
6
-
A release of Chat Overflow is simply a zip archive of the deploy folder, without configs or libraries. Don't forget to update Chat Overflow framework and API version numbers before a public release.
6
+
A release of Chat Overflow is simply a zip archive of the deploy folder, without configs or libraries. Don't forget to update the Chat Overflow framework and API version numbers before a public release.
Copy file name to clipboardExpand all lines: development/Writing-a-plugin.md
+8-8Lines changed: 8 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -8,15 +8,15 @@ There are 3 important steps when you want to create and implement a new chat ove
8
8
9
9
## Create a new plugin project
10
10
11
-
Use the *Create Plugin* run configuration or start the custom task `sbt create` directly. Enter the basic plugin information in the command promt. This includes the name, version and base plugin folder (e.g. `plugins-public`). The command creates the folder structure of the new plugin and adds a basic build file. Here you can also add custom dependencies.
11
+
Use the *Create Plugin* run configuration or start the custom task `sbt create` directly. Enter the basic plugin information in the command prompt. This includes the name, version and base plugin folder (e.g. `plugins-public`). The command creates the folder structure of the new plugin and adds a basic build file. Here you can also add custom dependencies.
12
12
13
-
Next, run the custom task `sbt fetch` to let the framework look for new plugins and update the plugin reference file `plugins.sbt`. If you're using IntelliJ, you can now reload the framework by hand to register the plugin as new as well as a custom project. You should also run `sbt reload` (Yes, both actions have different effects although they shouldn't).
13
+
Next, run the custom task `sbt fetch` to let the framework look for new plugins and update the plugin reference file `plugins.sbt`. If you're using IntelliJ, you can now reload the framework manually to register the plugin as a new custom project. You should also run `sbt reload` (Yes, both actions have different effects although they shouldn't).
14
14
15
15
## Implement the pluggable
16
16
17
17
Next, add your first class to the source folder of the new plugin. Supported languages are *Scala* and *Java*, but this guide will only show the scala way - development of java plugins is very similar.
18
18
19
-
The first class should extend the Pluggable-Interface from `org.codeoverflow.chatoverflow.api.plugin.Pluggable`. When the framework starts up, your plugin will be looked through for a class implementing this interface to get an entry point to your work. A raw version might look like this:
19
+
The first class should extend the PluggableInterface from `org.codeoverflow.chatoverflow.api.plugin.Pluggable`. When the framework starts up, it will search for a class implementing this interface in your plugin to get an entry point. A raw version might look like this:
20
20
21
21
```
22
22
class MySuperCoolPlug extends Pluggable {
@@ -36,11 +36,11 @@ class MySuperCoolPlug extends Pluggable {
36
36
37
37
```
38
38
39
-
**A short explanation**: The first 3 Methods`getName`, `getAuthor` and `getDescription` are simple: They are just returning a String representing the meta information of your plugin. This includes its name (please make sure to not name two plugins develeoped by yourself the same), your name or pseudonym and a brief topic of the plugins purpose.
39
+
**A short explanation**: The first 3 methods`getName`, `getAuthor` and `getDescription` are simple: They just return a String representing the metadata of your plugin. This includes its name (please make sure to not name two plugins identically), your name or pseudonym and a brief summary of the plugins purpose.
40
40
41
-
The next two methods return the number of the API-Version you've developed the plugin with. These are evaluated in the loading process to ensure that your plugin works with the framework version from the user. You can get these numbers from `org.codeoverflow.chatoverflow.api.APIVersion`.
41
+
The next two methods return the number of the API-Version you've developed the plugin with. These are evaluated in the loading process to ensure that your plugin works with the user's framework version. You can get these numbers from `org.codeoverflow.chatoverflow.api.APIVersion`.
42
42
43
-
The last method `createNewPluginInstance` is the most interesting one: After the framework checked your meta and version information, it will eventually load your plugin completely. In this method (**and only in this method**), you may return an object that extends the plugin interface. This class will contain your plugin logic.
43
+
The last method `createNewPluginInstance` is the most interesting one: After the framework checked your metadata, it will eventually load your plugin completely. In this method (**and only in this method**), you may return an object that extends the plugin interface. This class will contain your plugin logic.
44
44
45
45
## Implement the Plugin
46
46
@@ -64,7 +64,7 @@ private val twitchChatInput = require.input.twitchChat("reqTwitch", "A twitch ch
64
64
private val nameToSayHelloTo = require.parameter.string("reqHello", "Your name", false)
65
65
```
66
66
67
-
This code requires read-access to a twitch livestream chat and a parameter ("*a name to say hello to"*). Note: You can obviously not specify which channel the user might choose - but you can be sure that you will get a working input. The framework takes care of that. Please note that the requirements element already exists if you extend `PluginImpl`.
67
+
This code requires readaccess to a twitch livestream chat and a parameter ("*a name to say hello to"*). Note: You can obviously not specify which channel the user might choose - but you can be sure that you will get a working input. The framework takes care of that. Please note that the requirements element already exists if you extend `PluginImpl`.
68
68
69
69
After this, the last step is the `start` method. And it is as easy as you might think: Just add your own logic now, using the required parameters of your Requirement object. Here is a short example: This code will simply print out all messages from a twitch chat to the console. To access the chat, your required variable is used with the `getValue` method.
Of course, you can also add own classes and infrastrucutre by now - the important steps are done, happy coding!
76
76
77
-
*One last note: If you'r testing your plugin the first time, a full reload might be needed. Use the custom task `[Advanced] Full Reload and run ChatOverlfow` to do so. Afters this, you can configure the framework to start your plugin using the [CLI](usage/Using-the-CLI.md)!*
77
+
*One last note: If you are testing your plugin for the first time, a full reload might be needed. Use the custom task `[Advanced] Full Reload and run ChatOverflow` to do so. Afters this, you can configure the framework to start your plugin using the [CLI](usage/Using-the-CLI.md)!*
Due to IntelliJ version differences as well as differences on platforms (e.g. Windows vs. Mac OS) the run configurations could show problems. If this error occurs, change the `classpath or module` setting under`Edit configurations...`back to the Chat Overflow root module. Now everything should be working fine again.
2
+
Because of the differences in IntelliJ versions the run configurations could be broken. If they are broken, change the `classpath or module` setting in`Edit configurations...` to ChatOverflow root module. Now everything should be working fine again.
3
3
4
4
## Credentials value encrypted with wrong auth key
5
5

6
6
```
7
-
ERROR configuration.CryptoUtil$ - Your environment does not work with AES256.Please update your java runtime version to at least: 1.8.0_161
7
+
ERROR configuration.CryptoUtil$ - Your environment does not work with AES256.Please update your Java runtime version to at least: 1.8.0_161
8
8
```
9
-
If you see this image or error message you are probably running on an old java version that doesn't work with AES 256 bit encryption.
10
-
To fix this error you have to update java to at least `1.8.0_161`.
9
+
If you see this image or error message you are probably running on an old Java version that doesn't work with AES 256 bit encryption.
10
+
To fix this error you have to update Java to version `1.8.0_161` or later.
11
11
More information about this issue can be found [on stackoverflow.com](https://stackoverflow.com/questions/3862800/invalidkeyexception-illegal-key-size).
Copy file name to clipboardExpand all lines: usage/Using-the-GUI.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -16,11 +16,11 @@ If the login was successful the gui will display the authentication key for this
16
16
## Creating a plugin instance
17
17
Before running a plugin you have to create a plugin instance.
18
18
All available plugins are listed under `Plugin types`.
19
-
Add more plugins by putting the plugin `.jar` files into the plugins folder. If you are adding new plugins to the folder when the framework is running, you need to restart the framework in order to load the newly added plugins.
19
+
Add more plugins by putting the plugin `.jar` files into the plugins folder. If you are adding new plugins to the folder while the framework is still running, you need to restart the framework in order for it to load the newly added plugins.
20
20
21
21

22
22
23
-
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`:
23
+
Enter the plugin and author name of the plugin and give the instance a name (whatever you like), then click on `CREATE`:
24
24
25
25

26
26
@@ -29,7 +29,7 @@ The plugin instance should now be listed under `Plugin instances`:
29
29

30
30
31
31
You can use the pen to copy the name of an instance.
32
-
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).
32
+
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).
33
33
34
34
## Setting plugin requirements
35
35
Before you can start a plugin you need to set its requirements.
0 commit comments