-
Notifications
You must be signed in to change notification settings - Fork 2
Setting up your workspace
Wingman uses minimum Java 8 to operate. Having a JDK (Java Development Kit) installation is therefore a must to be able to build the client and Java based plugins into Java class files.
How you install the JDK depends on your system, but Oracle's version of it is available here. It is recommended to download the latest version of the JDK to keep up with the latest security fixes and feature additions.
Please do however keep in mind the current decision that the client should be able to run on minimum Java 8. The minimum version will however definitely be increased in the future, as more and more users migrate to use newer versions of Java.
Since Wingman is hosted on GitHub, the way of getting your hands on the source code and then potentially contributing is done by using Git, in conjunction with a GitHub account.
If you're not fully familiar with the usage of Git or GitHub, try this excellent tutorial.
Using an IDE (Integrated Development Environment) for Java will help you a lot while developing plugins or modifying the client.
IntelliJ IDEA is the IDE that the Wingman team can help you the most with. The wiki is mostly centered around this IDE as it features native Gradle support, great debugging tools and advanced code completion that play a major role in the plugin programming process. If you choose to use IDEA, please consider setting the project language level to Java 8 in the project settings to comply with the project's version minimum.
Wingman and all of its side repositories use Gradle for handling dependencies. IntelliJ IDEA should handle this automatically, downloading all libraries for use in the client code.
Please join our Slack if you notice anything wrong or would like to contribute to the wiki.
- General
- Installing a plugin
- The plugin loading process
- Development
- Setting up your workspace
- Creating a Gradle project
- Plugin Development
- Creating your first plugin
- Using event listeners