Merge pull request #1 from solid-resourcepack/development

feat: generator + mappings for v1.21

Author: dayyeeet

README.md

@@ -1,8 +1,50 @@
-# solid-material ![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/solid-resourcepack/solid-material)
+# solid-material ![Maven Central Version](https://img.shields.io/maven-central/v/io.github.solid-resourcepack/solid-material-api?style=flat) ![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/solid-resourcepack/solid-material)
 A collection of auto generated enum classes for minecraft materials, holding important information for resource packs.
+This repository aims to provide a simple way to access material information for resource packs. It is generated from the official minecraft data files and provides a simple way to access the information.
+
+The API is designed to be used in combination with the [solid-api](https://github.com/solid-resourcepack/solid-api) project.
+
+You can however access resource pack information without the solid-api project, by using the generated enum classes [directly](#usage).
+
+## Dependency
+
+### Gradle Kotlin
+```kt
+implementation("io.github.solid-resourcepack:solid-material-api:VERSION")
+```
+### Gradle Groovy
+```groovy
+implementation 'io.github.solid-resourcepack:solid-material-api:VERSION'
+```
+
+### Maven
+```xml
+<dependency>
+    <groupId>io.github.solid-resourcepack</groupId>
+    <artifactId>solid-material-api</artifactId>
+    <version>VERSION</version>
+</dependency>
+```
+
+## Usage
+
+### Block Materials
+```kotlin
+val material = SolidBlockMaterial.STONE.toGeneric()
+```
+
+### Item Materials
+```kotlin
+val material = SolidBlockMaterial.STICK.toGeneric()
+```
+
+### Material properties
+```kotlin
+material.parent // The resourcepack parent key of the material (e.g. "minecraft:item/generated")
+material.key // The resourcepack key of the material (e.g. "minecraft:item/stick")
+material.textures // A list of all textures used by the material
+```
 
-> [!CAUTION]
-> This is very work in progress and experimental
 
 ## Contributing
 To contribute to this project

build.gradle.kts

@@ -0,0 +1,46 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
+plugins {
+    alias(libs.plugins.shadow)
+    alias(libs.plugins.kotlin)
+}
+
+
+allprojects {
+    group = "io.github.solid-resourcepack"
+    version = "1.21"
+
+    repositories {
+        mavenCentral()
+        google()
+    }
+
+}
+
+subprojects {
+    apply(plugin = "org.jetbrains.kotlin.jvm")
+    apply(plugin = "com.github.johnrengelman.shadow")
+
+    dependencies {
+        testImplementation(rootProject.libs.kotlinTest)
+        implementation(rootProject.libs.kotlinJvm)
+    }
+
+    kotlin {
+        jvmToolchain(21)
+        compilerOptions {
+            jvmTarget.set(JvmTarget.JVM_21)
+        }
+    }
+
+    tasks.named("shadowJar", ShadowJar::class) {
+        mergeServiceFiles()
+        archiveFileName.set("${project.name}.jar")
+    }
+
+    tasks.test {
+        useJUnitPlatform()
+    }
+}
+

gradle/libs.versions.toml

@@ -0,0 +1,29 @@
+[versions]
+kotlin = "1.9.20"
+kotlinCoroutines = "1.4.2"
+shadow = "8.1.1"
+kotlinPoet = "1.18.1"
+paper = "1.21-R0.1-SNAPSHOT"
+creative = "1.7.3"
+sonatypeCentralPortalPublisher = "1.2.3"
+
+[libraries]
+kotlinJvm = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
+kotlinTest = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
+kotlinCoroutines = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinCoroutines" }
+kotlinPoet = { module = "com.squareup:kotlinpoet", version.ref = "kotlinPoet" }
+paper = { module = "io.papermc.paper:paper-api", version.ref = "paper" }
+
+creativeApi = { module = "team.unnamed:creative-api", version.ref = "creative" }
+creativeSerializer = { module = "team.unnamed:creative-serializer-minecraft", version.ref = "creative" }
+
+[bundles]
+creative = [
+    "creativeApi",
+    "creativeSerializer"
+]
+
+[plugins]
+kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
+shadow = { id = "com.github.johnrengelman.shadow", version.ref = "shadow" }
+sonatypeCentralPortalPublisher = { id = "net.thebugmc.gradle.sonatype-central-portal-publisher", version.ref = "sonatypeCentralPortalPublisher" }

settings.gradle.kts

@@ -0,0 +1,20 @@
+enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS")
+
+pluginManagement {
+    repositories {
+        mavenCentral()
+        gradlePluginPortal()
+    }
+}
+
+plugins {
+    // Apply the foojay-resolver plugin to allow automatic download of JDKs
+    id("org.gradle.toolchains.foojay-resolver-convention") version "0.7.0"
+}
+
+rootProject.name = "solid-material"
+
+include(
+    "solid-material-gen",
+    "solid-material-api",
+)

solid-material-api/build.gradle.kts

@@ -0,0 +1,53 @@
+plugins {
+    `maven-publish`
+    alias(libs.plugins.sonatypeCentralPortalPublisher)
+}
+
+dependencies {
+    compileOnly(libs.bundles.creative)
+}
+
+publishing {
+    publications {
+        create<MavenPublication>("maven") {
+            from(components["java"])
+        }
+    }
+}
+
+
+centralPortal {
+    name = project.name
+
+    username = project.findProperty("sonatypeUsername") as? String
+    password = project.findProperty("sonatypePassword") as? String
+
+    pom {
+        name.set("Solid Material")
+        description.set("A collection of auto generated enum classes for minecraft materials, holding important information for resource packs")
+        url.set("https://github.com/solid-resourcepack/solid-material")
+
+        developers {
+            developer {
+                id.set("dayyeeet")
+                email.set("david@cappell.net")
+            }
+        }
+        licenses {
+            license {
+                name.set("Apache-2.0")
+                url.set("https://www.apache.org/licenses/LICENSE-2.0.txt")
+            }
+        }
+        scm {
+            url.set("https://github.com/solid-resourcepack/solid-material")
+            connection.set("git:git@github.com:solid-resourcepack/solid-material.git")
+        }
+    }
+}
+
+signing {
+    useGpgCmd()
+    sign(publishing.publications)
+}
+