feat(core): document shading cloud and some notes about versions

Incendo · Aug 12, 2024 · 305e3f3 · 305e3f3
1 parent 54fb2b1
commit 305e3f3
Show file tree

Hide file tree

Showing 2 changed files with 77 additions and 0 deletions.
diff --git a/docs/core/index.md b/docs/core/index.md
@@ -750,3 +750,10 @@ contains an opinionated implementation of the help system for Minecraft.
 You can find examples on GitHub for either
 [Builders](https://github.com/Incendo/cloud-minecraft/blob/master/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/builder/feature/HelpExample.java) or
 [Annotations](https://github.com/Incendo/cloud-minecraft/blob/master/examples/example-bukkit/src/main/java/cloud/commandframework/examples/bukkit/annotations/feature/HelpExample.java).
+
+### Build System
+
+Cloud will have differing versions between core and the other groups of modules, Cloud Minecraft for example will be updated seperately. If core has a bug fix or feature that is not yet available 
+inside of the current Cloud Minecraft release you can define cloud-core as it's own dependency force it's use that way.You should also shade Cloud inside of your project, here's an example of doing so:
+
+{{ shade_dependency() }}
diff --git a/main.py b/main.py
@@ -31,6 +31,76 @@ def dependency_listing(name: str, version: str = None) -> str:
     ```
     """.format(name=name, version=env.variables.version[version])
 
+    @env.macro
+    def shade_dependency() -> str:
+        return """
+=== "Maven"
+    
+    ```xml
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-shade-plugin</artifactId>
+                <version>3.6.0</version>
+                <executions>
+                    <execution>
+                        <phase>package</phase>
+                        <goals>
+                        <goal>shade</goal>
+                        </goals>
+                        <configuration>
+                        <relocations>
+                            <relocation>
+                                <pattern>org.incendo.cloud</pattern>
+                                <shadedPattern>com.yourpackage.libs.cloud</shadedPattern>
+                            </relocation>
+                        </relocations>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+    ```
+
+=== "Gradle (Kotlin)"
+
+    ```kotlin
+    plugins {
+        id("com.gradleup.shadow") version "8.3.0"
+    }
+
+    tasks {
+        assemble {
+            dependsOn(shadowJar)
+        }
+
+        shadowJar {
+            relocate("org.incendo.cloud", "com.yourpackage.libs.cloud")
+        }
+    }
+    ```
+
+=== "Gradle (Groovy)"
+
+    ```groovy
+    plugins {
+        id 'com.gradleup.shadow' version '8.3.0'
+    }
+
+    tasks {
+        assemble {
+            dependsOn shadowJar
+        }
+
+        shadowJar {
+            relocate 'org.incendo.cloud', 'com.yourpackage.libs.cloud'
+        }
+    }
+    ```
+"""
+
     @env.macro
     def javadoc(link: str, title: str = None) -> str:
         if title is None: