!Banner

Important!
Geode is a library mod. It won't do anything on it's own, only add it if other mods require it.

🤔 What is Geode?

Geode is a powerful library enhancing many aspects of Minecraft modding, including:

• 🛠️ Powerful Builder Based Registration
  A new way of registering your items, blocks, entities and more using builders, all in one centralized Geode instance.
• 📐 Extensive Math API
  A large collection of common Math functions, as well as niche ones such as the inverse square root.
• 📖 Plenty Helpers
  Many many helper classes to aid with every aspect of minecraft development, from raymarching to getting an identifier from registries.

💻 Importing Geode

You may import Geode in your repositories using the Modrinth API:

In your gradle.properties file:

# Geode Version.
geode_version = U4o9vfpy # Add the version here

In your build.gradle file:

repositories {
    // Add the modrinth maven
    maven { url = "https://api.modrinth.com/maven" }
}

dependencies { // Adding a Geode dependency for Fabric. modImplementation "maven.modrinth:geode:${project.geode_version}" }

## ❓ How to get the version
On Modrinth,
1. Go to the category named **Versions**.
2. Choose the version you want and click on **More Options**.
3. Click **Copy ID**.
   
<details>
<summary>Visual Guide</summary>

!Instructions

</details>

## ❓ How to get Documentation in JetBrains IDEA?
Because the mod is uploaded on Modrinth's Maven, I sadly cannot upload the source in a way where you can easily get the documentation. However, attached with every build of Geode is the sources for that version. Here are the steps to set up documentation:
1. Download the sources from the desired Geode version.
2. In IDEA, open any Geode class. For example, press `Ctrl+N` to open the file browser, and search for "Draw". Press Enter.
3. On the top of the class should be a blue banner, with two buttons on the right: "Download Sources" and "Choose File".
4. Click `Choose File`, and select the file you downloaded.

#### 
**Geode will not be ported to Forge/NeoForge/Quilt**. It will also **not be backported** and **only be maintained in the newest available version**.

<hr/>
<sub>@ 2026 The Collective. All Rights Reserved.</sub><br/>
<sub>Geode is licensed under Apache-2.0.</sub>
&nbsp;

<br />
<br />