aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorILikePlayingGames <22475143+ILikePlayingGames@users.noreply.github.com>2024-07-31 06:55:08 -0400
committerGitHub <noreply@github.com>2024-07-31 11:55:08 +0100
commitd68bf1c7b51e0d6335f9439818e6effd5f9ae501 (patch)
treebb2823ef29c1745a5c800897849545947810fadb /README.md
parent3a60715b57d9af5ad63d20465504214979a7c85d (diff)
downloadHyPixelForgeModAPI-d68bf1c7b51e0d6335f9439818e6effd5f9ae501.tar.gz
HyPixelForgeModAPI-d68bf1c7b51e0d6335f9439818e6effd5f9ae501.tar.bz2
HyPixelForgeModAPI-d68bf1c7b51e0d6335f9439818e6effd5f9ae501.zip
Various build script improvements (#6)
- Add DevAuth for logging into online mode servers (disabled by default) - Fill in mod version during build in ForgeModAPI.java - Fix gradle running out of memory during `gradlew setupDecompWorkspace` - Add some development tips to README.md - Change logging to log4j in ForgeModAPI.java
Diffstat (limited to 'README.md')
-rw-r--r--README.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/README.md b/README.md
index b309cd8..bf922d2 100644
--- a/README.md
+++ b/README.md
@@ -5,4 +5,13 @@ This repository contains the implementation of the Hypixel Mod API for the Froge
## Contributing
-If you wish to contribute to this implementation of the Mod API to offer improvements or fixes, you can do so by forking the repository and creating a pull request. \ No newline at end of file
+If you wish to contribute to this implementation of the Mod API to offer improvements or fixes, you can do so by forking the repository and creating a pull request.
+
+> [!IMPORTANT]
+> Run `gradlew setupDecompWorkspace` after importing the project to generate the files required to build it
+
+If IntelliJ still shows unknown symbol errors after running the command, you may need to [clear the filesystem cache](https://www.jetbrains.com/help/idea/invalidate-caches.html).
+
+### Testing Your Changes
+
+You can enable DevAuth to log in to the Hypixel server with your Minecraft account. Please see the [DevAuth docs](https://github.com/DJtheRedstoner/DevAuth) for more details. \ No newline at end of file