This repository has been archived by the owner on Nov 2, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 216
Dev environment setup
Pierre-Yves B edited this page Sep 24, 2020
·
5 revisions
Fork the repository by clicking on the Fork icon on the top right of the page or simply clone it by running git clone https://github.com/PyvesB/advanced-achievements.git
in a terminal. Once you've completed the repository check out, you'll probably want to import the project in an IDE, below are the instructions for two of the most popular ones.
- In Eclipse, go to File -> Import... -> Maven -> Existing Maven Projects.
- In the Root Directory field, select the location where you downloaded the Advanced Achievements repository.
- Tick the
pom.xml
box that appears in the Projects field and click Finish. - To compile the plugin, in the Package Explorer window, right click on the imported project, then Run As -> Maven Install.
- The plugin will be generated in the target folder of the project.
- In IntelliJ IDEA go to Open.. and open the repository root folder (Your download location)
- IDEA will run Sync on the maven project - if not click the Configure maven project pop-up that appears
- If not yet installed, install Maven Helper-plugin to run maven goals inside IDEA (For next steps)
- To compile the plugin, in Project right click AdvancedAchievements > ⚙️ Run Maven > install, this will run
mvn install:install
- The plugin will be generated in the target folder of the project.
For easy PRs:
- Use tabs: Settings > Editor > Code Style > Java > Tabs and indents > Use tab character
- You can run
mvn formatter:format
with ⚙️ Run Maven > Plugins > maven-formatter-plugin > formatter:format