Building

It is possible to build ChatPlugin from its source to run the latest version available, which contains the last known bugs' fixes and new features. The plugin uses Gradle to speed up the process of building.

Setup

Java

Even though the process will most likely work with newer Java versions, Java 8 is the only supported version for now. If you have multiple Java versions installed on your system, make sure you are running it by checking the following command's output:

java -version

...which, on Windows, should produce the following:

Just check for the "1.8.0" string, the build number (202, in my case) is irrelevant.

JAVA_HOME

You might configure the JAVA_HOME environment variable to point to your Java 8 installation to avoid inconveniences with some IDEs like Eclipse.

Git

Git is used to automate the repository's download process. Execute the following command inside of a directory to download the plugin's source.

git clone https://github.com/ChatPlugin/ChatPlugin.git

It is also possible to download the code using the "Download ZIP" option of the green "<> Code" button in the repository's main page:

Extract the zipped folder's contents to a new directory if you use this method.

Building artifacts

To build artifacts, simply run the following command inside of the main folder:

gradlew build

You will find the runnable JAR at ChatPlugin/free/build/libs/ChatPlugin-FREE-1.X.x.jar.

Editing source

Once you have cloned the repository, it is possible to import the project into an IDE to perform some changes before building it. The following guide shows how to do that using the Eclipse IDE.

1. Press "Help -> Eclipse Marketplace..." (Alt + H, M) to open the Eclipse Marketplace, then search for "Gradle" and download the "Buildship Gradle Integration X.x" if it not already installed:

2. Restart the IDE if you are asked to do it

3. Press "File -> Import..." (Alt + F, I) to open the import wizard, select "Existing Gradle Project" under "Gradle" and click "Next" (Alt + N):

4. Browse to the folder you have just downloaded and click "Finish" (Alt + F)

5. Apply your modifications

6. Build the project using one of the following tasks from the "Gradle Tasks" view (how to open it?):

7. Open the "Console" view to check the program's output

8. You can find your JAR at ChatPlugin/free/build/libs/ChatPlugin-FREE-1.X.x.jar

ChatPlugin - A complete yet lightweight plugin which handles just too many features!
© 2024  Remigio07

This wiki is currently updated to version 1.9.4.
Please report any errors, mistakes and misspellings as described at Home/Reporting issues.