Update docs to 6.x

lukebemishprojects · Apr 25, 2024 · a234f58 · a234f58
1 parent a3c8888
commit a234f58
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 10 deletions.
diff --git a/docs/java/category.mdx b/docs/java/category.mdx
@@ -3,47 +3,82 @@
 :::note
 
 While these docs will contain examples and explanations, the javadocs for DynAssetGen are also a good source for information on the java API; while they are not complete, I am continually working to expand how much of
-the API surface is well documented in this way. Additionally, javadocs are published for each major DynAssetGen version after 4. Javadocs are located at [https://javadoc.lukebemish.dev/dev/lukebemish/dynamicassetgenerator/5/](https://javadoc.lukebemish.dev/dev/lukebemish/dynamicassetgenerator/5/).
+the API surface is well documented in this way. Additionally, javadocs are published for each major DynAssetGen version after 4. Javadocs are located at [https://javadoc.lukebemish.dev/dev/lukebemish/dynamicassetgenerator/6/](https://javadoc.lukebemish.dev/dev/lukebemish/dynamicassetgenerator/6/).
 
 :::
 
 ## Getting Started
 
-The first step to get started with the Java API is to add DynAssetGen to your development environment. All artifacts for DynAssetGen are published at `https://maven.lukebemish.dev/releases/`:
+The first step to get started with the Java API is to add DynAssetGen to your development environment. All artifacts for DynAssetGen are available on maven central:
 
 ```gradle
 repositories {
-    maven {
-        url "https://maven.lukebemish.dev/releases/"
-    }
+    mavenCentral()
 }
 ```
 
 For each version of DynAssetGen, three types of artifacts are published:
 * `common` jars, which are in official "Mojmaps" mappings and contain no loader-specific code
-* `fabriquilt` jars which run on Quilt and Fabric
+* `fabric` jars which run on Quilt and Fabric
 * `neoforge` jars which run on NeoForge
 
-The artifact coordinates take the format `dev.lukebemish.dynamicassetgenerator:dynamicassetgenerator-<type>-<minecraft version>:<version>`
+The artifact coordinates take the format `dev.lukebemish:dynamicassetgenerator:<version>`, and loader-specific jars are requested by capability:
 
 ```gradle title="Adding artifact on NeoForge"
 dependencies {
-    implementation 'dev.lukebemish.dynamicassetgenerator:dynamicassetgenerator-neoforge-<minecraft version>:<version>'
+    implementation('dev.lukebemish:dynamicassetgenerator:<version>') {
+        capabilities {
+            requireCapability('dev.lukebemish:dynamicassetgenerator-neoforge')
+        }
+    }
 }
 ```
 
 ```gradle title="Adding artifact on Quilt or Fabric"
 dependencies {
-    modImplementation 'dev.lukebemish.dynamicassetgenerator:dynamicassetgenerator-fabriquilt-<minecraft version>:<version>'
+    modImplementation('dev.lukebemish:dynamicassetgenerator:<version>') {
+        capabilities {
+            requireCapability('dev.lukebemish:dynamicassetgenerator-fabric')
+        }
+    }
 }
 ```
 
 ## Available Versions
 
 | Minecraft Version | Latest |
 | :---------------- | :----- |
+| 1.20.5            | [![Latest 1.20.5 Version](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Fdev%2Flukebemish%2Fdynamicassetgenerator%2Fmaven-metadata.xml&query=%2Fmetadata%2Fversioning%2Fversions%2Fversion%5B(starts-with(text()%2C'6.'))%5D%5Blast()%5D&prefix=v&style=for-the-badge&label=%20&color=e3116c)](https://central.sonatype.com/artifact/dev.lukebemish/dynamicassetgenerator/versions) |
 | 1.20.4            | [![Latest 1.20.4 Version](https://img.shields.io/badge/dynamic/xml?style=for-the-badge&color=e3116c&label=&prefix=v&query=metadata%2F%2Flatest&url=https%3A%2F%2Fmaven.lukebemish.dev%2Freleases%2Fdev%2Flukebemish%2Fdynamicassetgenerator%2Fdynamicassetgenerator-common-1.20.4%2Fmaven-metadata.xml)](https://maven.lukebemish.dev/releases/dev/lukebemish/dynamicassetgenerator/dynamicassetgenerator-common-1.20.4/) |
 | 1.20.2            | [![Latest 1.20.2 Version](https://img.shields.io/badge/dynamic/xml?style=for-the-badge&color=e3116c&label=&prefix=v&query=metadata%2F%2Flatest&url=https%3A%2F%2Fmaven.lukebemish.dev%2Freleases%2Fdev%2Flukebemish%2Fdynamicassetgenerator%2Fdynamicassetgenerator-common-1.20.2%2Fmaven-metadata.xml)](https://maven.lukebemish.dev/releases/dev/lukebemish/dynamicassetgenerator/dynamicassetgenerator-common-1.20.2/) |
 | 1.20.1            | [![Latest 1.20.1 Version](https://img.shields.io/badge/dynamic/xml?style=for-the-badge&color=e3116c&label=&prefix=v&query=metadata%2F%2Flatest&url=https%3A%2F%2Fmaven.lukebemish.dev%2Freleases%2Fdev%2Flukebemish%2Fdynamicassetgenerator%2Fdynamicassetgenerator-common-1.20.1%2Fmaven-metadata.xml)](https://maven.lukebemish.dev/releases/dev/lukebemish/dynamicassetgenerator/dynamicassetgenerator-common-1.20.1/) |
 | 1.19.4            | [![Latest 1.19.3 Version](https://img.shields.io/badge/dynamic/xml?style=for-the-badge&color=e3116c&label=&prefix=v&query=metadata%2F%2Flatest&url=https%3A%2F%2Fmaven.lukebemish.dev%2Freleases%2Fdev%2Flukebemish%2Fdynamicassetgenerator%2Fdynamicassetgenerator-common-1.19.4%2Fmaven-metadata.xml)](https://maven.lukebemish.dev/releases/dev/lukebemish/dynamicassetgenerator/dynamicassetgenerator-common-1.19.4/) |
 | 1.19.3            | [![Latest 1.19.3 Version](https://img.shields.io/badge/dynamic/xml?style=for-the-badge&color=e3116c&label=&prefix=v&query=metadata%2F%2Flatest&url=https%3A%2F%2Fmaven.lukebemish.dev%2Freleases%2Fdev%2Flukebemish%2Fdynamicassetgenerator%2Fdynamicassetgenerator-common-1.19.3%2Fmaven-metadata.xml)](https://maven.lukebemish.dev/releases/dev/lukebemish/dynamicassetgenerator/dynamicassetgenerator-common-1.19.3/) |
+
+:::note
+
+For versions before 6.0.0 (for Minecraft versions before 1.20.5), the mod was not on maven central but at `https://maven.lukebemish.dev/releases/`:
+
+```gradle
+repositories {
+    maven {
+        url "https://maven.lukebemish.dev/releases/"
+    }
+}
+```
+
+Additionally, the artifact coordinates took the format `dev.lukebemish.dynamicassetgenerator:dynamicassetgenerator-<type>-<minecraft version>:<version>`
+
+```gradle title="Adding artifact on NeoForge"
+dependencies {
+    implementation 'dev.lukebemish.dynamicassetgenerator:dynamicassetgenerator-neoforge-<minecraft version>:<version>'
+}
+```
+
+```gradle title="Adding artifact on Quilt or Fabric"
+dependencies {
+    modImplementation 'dev.lukebemish.dynamicassetgenerator:dynamicassetgenerator-fabriquilt-<minecraft version>:<version>'
+}
+```
+
+:::
diff --git a/docs/java/textures.mdx b/docs/java/textures.mdx
@@ -33,7 +33,7 @@ elements of the texture source, such as the logger, which can be retrieved with
 making your source's output depend on other data in this element requires implementing the caching API, and that if your
 source reads existing resources, it should implement the cache key API.
 
-`codec` returns a codec that can be used to serialize or deserialize the texture source. This codec must be registered with
+`codec` returns a map codec that can be used to serialize or deserialize the texture source. This codec must be registered with
 `TexSource.register`, and is used when caching texture sources; a texture source's generated texture must be fully 
 describable by the information encoded by its codec, unless the experimental caching API is implemented for that texture 
 source.