Building-with-IntelliJ: re-add Lombok plugin information (#54)

runelite · Jan 31, 2024 · 308df4f · 308df4f
1 parent 4f53f0c
commit 308df4f
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/Building-with-IntelliJ-IDEA.md b/Building-with-IntelliJ-IDEA.md
@@ -3,6 +3,7 @@
 
 - [Getting started](#getting-started)
   - [Importing the project](#importing-the-project)
+  - [Installing Lombok](#installing-lombok)
   - [Building the project](#building-the-project)
   - [Running the project](#running-the-project)
   - [Conclusion](#conclusion)
@@ -43,6 +44,20 @@ If everything went well, you should be able to see something like this:
 
 ![after-clone-fresh-project](https://i.imgur.com/JOAFeMi.png)
 
+## Installing Lombok
+
+When first viewing the project in IntelliJ IDEA you may come across this error:
+
+![missing-lombok-errors](https://i.imgur.com/a1YDonV.png)
+
+This is because you do not have the [Lombok Plugin](https://plugins.jetbrains.com/plugin/6317-lombok-plugin) installed.
+
+Navigate to the **Plugins** tab under the **File > Settings** menu (**IntelliJ IDEA > Preferences** for Mac). Click the **Marketplace** button and search for **Lombok** to find it. Install the plugin and restart IntelliJ IDEA.
+
+![installing-lombok](img/building-with-intellij/installing_lombok.png)
+
+Success! You should no longer be getting ``Cannot resolve symbol`` or ``Cannot resolve method`` errors.
+
 ## Building the project
 
 RuneLite is using [Maven](https://maven.apache.org/) as build tool. It is used for dependency management, resource generation, running tests and any other tooling needed to properly build, run and deploy RuneLite.

diff --git a/img/building-with-intellij/installing_lombok.png b/img/building-with-intellij/installing_lombok.png