@@ -12,51 +12,32 @@ git checkout -b development --track origin/development
1212### Requirements
1313- ** IDE** (One of them)
1414 - [ IntelliJ IDEA] ( https://www.jetbrains.com/idea/ ) ** (Recommended)**
15+ - Our team uses IDEA. We may not be able to provide support for other IDEs.
1516 - [ Eclipse] ( https://www.eclipse.org/ )
1617- ** (Plugin) Lombok** to help with things such as not having to manually create Getters and Setters.
17- - [ IntelliJ IDEA] ( https://plugins.jetbrains.com/plugin/6317-lombok )
18- - ** After installing the plugin**
19- - Go to ` Preferences `
20- - Go to ` Build, Execution, Deployment `
21- - Go to ` Compiler `
22- - Go to ` Annotation Processors `
23- - Check ☑ ` Enable annotation processing ` .
18+ - IntelliJ IDEA (pre-installed)
2419 - [ Eclipse] ( https://projectlombok.org/setup/eclipse )
2520
2621### Getting started
2722** Note:** You can use ` gradle ` instead of using gradle wrapper ` ./gradlew ` .
2823
29241 . Clone the repository
30- 2 . Setup the development environment
25+ 2 . Wait for the gradle project to import.
26+ 3 . Setup the development environment
3127 ``` shell script
3228 ./gradlew setupDecompWorkspace
3329 ```
34- 3 . Integrate the development environment with your IDE
30+ 4 . Integrate the development environment with your IDE
3531 - IntelliJ IDEA
36- ` ` ` shell script
37- ./gradlew idea genIntellijRuns
38- ` ` `
32+ - Done automatically
3933 - Eclipse ** (doesn' t generate debug configuration)**
4034 ```shell script
4135 ./gradlew eclipse
4236 ```
43- - (Eclipse) Change **Text File Encoding** from `Default` to `UTF-8`
37+ - Change **Text File Encoding** from `Default` to `UTF-8`
4438 - Go to `Window` -> `Preferences` -> `General` -> `Workspace`
4539 - Change `Text File Encoding` from `Default` to `UTF-8`
46-
47- 4. Make sure to add the **VM** arguments to your debug configuration:
48- ```text
49- -Dfml.coreMods.load=codes.biscuit.skyblockaddons.tweaker.SkyblockAddonsLoadingPlugin
50- -Dlog4j.configurationFile=file:$ProjectFileDir$/log-config.xml
51- ```
52- 5. Include your **Minecraft** username and password as arguments in the **debug configuration**.
53- In order, to login into [Hypixel](https://hypixel.net) by your account.
54- ```text
55- --username "<username>" --password "<password>"
56- ```
57- > **Note:** Don' t share your password with ** anyone** .
58- > ** We aren' t going to ask you about your password!**
59- 6. **You are now ready to build the mod!**
40+ 5. **You are now ready to build the mod!**
6041
6142### How to build
62431. Build the mod
@@ -75,9 +56,14 @@ git checkout -b development --track origin/development
7556 > so the access transformers are applied to the source code!
7657 >
77582. (Optional) Run the **Minecraft Forge** client
78- - Using an IDE
79- - Run the debug configuration you created in "Getting Started."
59+ - Using IntelliJ IDEA
60+ - Add the environment variable `FETCH_DATA_ONLINE=true` if you want to use data files from the CDN.
61+ - Run the "Minecraft Client" debug configuration.
62+ - Click the link in the console to log in with [DevAuth](https://github.com/DJtheRedstoner/DevAuth).
8063 - Using the command line
8164 ```shell script
8265 ./gradlew runClient --args="--username <username> --password <password>"
83- ```
66+ ```
67+
68+ ### Questions?
69+ Visit our [Discord Server](https://discord.gg/zWyr3f5GXz) for support.
0 commit comments