Decocraft pack template master

.gitignore

@@ -0,0 +1,12 @@
+.claude/
+nul
+build/
+.gradle/
+.idea/
+*.iml
+*.ipr
+*.iws
+out/
+run/
+logs/
+repo/

README.md

@@ -0,0 +1,143 @@
+# Decocraft Pack Template
+
+Universal addon pack for Decocraft. No Java code needed.
+Single jar works on both NeoForge and Fabric.
+
+## Quick Start
+
+1. Clone this repo
+2. Edit `gradle.properties` - change `mod_id`, `mod_name`, `mod_description`, `mod_authors`
+3. Edit `settings.gradle` - change `rootProject.name`
+4. Rename `src/main/resources/assets/decocraft/mypack.json` to your pack name
+5. Update `decocraft.json` to point to your renamed file and `groups.json`
+6. Edit `groups.json` to define your creative tabs
+7. Add your content (see below)
+8. `./gradlew build` - jar goes to `build/libs/`
+
+The output jar contains both `fabric.mod.json` and `META-INF/neoforge.mods.toml`,
+so it loads on either mod loader without separate builds.
+
+## File Structure
+
+```
+assets/decocraft/
+    decocraft.json                    - manifest: lists groups.json + your content files
+    groups.json                       - creative tab definitions
+    mypack.json                       - block/item definitions
+    models/bbmodel/{model}.bbmodel    - BlockBench 3D models
+    textures/block/{material}.png     - block textures
+    textures/item/{material}.png      - item/inventory textures
+    lang/en_us.json                   - display names + tab labels
+```
+
+All assets go under the `decocraft` namespace.
+
+Blockstates, block models, item models, item definitions, and loot tables
+are all generated dynamically at runtime by the main Decocraft mod.
+You do NOT need to create these files.
+
+## Per Block Checklist
+
+For each block you add, you need:
+
+| File | Purpose |
+|------|---------|
+| `mypack.json` | Entry in the `models` array |
+| `models/bbmodel/{model}.bbmodel` | BlockBench 3D model |
+| `textures/block/{material}.png` | Block texture |
+| `textures/item/{material}.png` | Item texture |
+| `lang/en_us.json` | `"block.decocraft.{decoref}": "Display Name"` |
+
+That is it. Everything else is handled automatically.
+
+## Manifest (decocraft.json)
+
+Simple array listing files to load. Include `groups.json` first:
+
+```json
+[
+    "groups.json",
+    "mypack.json"
+]
+```
+
+Decocraft merges manifests from all jars, so your pack's files are loaded
+alongside the base decocraft files.
+
+## Creative Tabs (groups.json)
+
+Declare tabs with a translation key and icon block:
+
+```json
+{
+    "my_tab": { "label": "itemGroup.decocraft.my_tab", "icon": "some_block_id" }
+}
+```
+
+Then add the display name in `lang/en_us.json`:
+
+```json
+"itemGroup.decocraft.my_tab": "Decocraft - My Tab"
+```
+
+The `icon` must match a block's `decoref` from your content JSON. Tabs from
+all packs are merged. If the base decocraft already defines a tab key, your
+blocks will appear in that existing tab.
+
+## Content JSON Entry
+
+```json
+{
+    "name": "Display Name",
+    "model": "bbmodel_filename_without_extension",
+    "material": "texture_name",
+    "scale": 1.0,
+    "tabs": "your_tab_name",
+    "crafting_color": [50.0, 50.0, 50.0],
+    "decoref": "unique_block_id"
+}
+```
+
+### Common Types
+
+| type | behavior |
+|------|----------|
+| (empty/omitted) | Basic decoration block (default) |
+| `"underlayer"` | Wall/floor mounted virtual overlay (paintings, carpets) |
+| `"animated"` | Block with keyframe animations |
+| `"rotatable"` | Block that places at 45 degree increments |
+| `"bed"` | Sleepable bed |
+| `"seat"` | Sittable block |
+| `"chain"` | Chain/rope connector |
+
+### Optional Fields
+
+- `"hidden": true` - registered but not in creative tabs
+- `"transparency": true` - translucent rendering
+- `"passable": true` - no collision
+- `"loot": "other_decoref"` - override what drops when broken
+- `"flipbook": {"frametime": 4, "images": 6}` - animated texture
+- `"script"` - tool_modelswitch, on_use, sounds, particles, etc.
+
+### Model Switching (cycle variants with decobrush)
+
+```json
+"script": {
+    "tool_modelswitch": {
+        "link": "next_variant_id"
+    }
+}
+```
+
+Chain the last variant back to the first to create a cycle.
+
+## Full Documentation
+
+See `json_documentation.md` in the main Decocraft mod for the complete
+field reference with examples of every block type.
+
+## Version Compatibility
+
+Version ranges are open ended, so the pack works with any Decocraft 4.0+
+on Minecraft 26.1+. Bump `decocraft_version` in `gradle.properties` if you
+use features from a newer decocraft release.

build.gradle

@@ -0,0 +1,65 @@
+plugins {
+    id 'java-library'
+    id 'idea'
+}
+
+tasks.named('wrapper', Wrapper).configure {
+    distributionType = Wrapper.DistributionType.BIN
+}
+
+version = mod_version
+group = mod_group_id
+
+base {
+    archivesName = mod_id
+}
+
+java.toolchain.languageVersion = JavaLanguageVersion.of(25)
+
+var generateModMetadata = tasks.register("generateModMetadata", ProcessResources) {
+    var replaceProperties = [
+            minecraft_version      : minecraft_version,
+            minecraft_version_range: minecraft_version_range,
+            neoforge_loader_range  : neoforge_loader_range,
+            fabric_loader_version  : fabric_loader_version,
+            mod_id                 : mod_id,
+            mod_name               : mod_name,
+            mod_license            : mod_license,
+            mod_version            : mod_version,
+            mod_authors            : mod_authors,
+            mod_description        : mod_description,
+            decocraft_version      : decocraft_version
+    ]
+    inputs.properties replaceProperties
+    expand replaceProperties
+    from "src/main/templates"
+    into "build/generated/sources/modMetadata"
+}
+
+sourceSets.main.resources.srcDir generateModMetadata
+
+processResources {
+    exclude '**/models_backup/**'
+    exclude '**/*.zip'
+}
+
+jar {
+    from(sourceSets.main.resources) {
+        include '**/*'
+    }
+    from("build/generated/sources/modMetadata") {
+        include '**/*'
+    }
+    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
+}
+
+tasks.named('jar').configure {
+    dependsOn generateModMetadata
+}
+
+idea {
+    module {
+        downloadSources = true
+        downloadJavadoc = true
+    }
+}

gradle.properties

@@ -0,0 +1,24 @@
+org.gradle.jvmargs=-Xmx5G
+org.gradle.daemon=true
+org.gradle.parallel=false
+org.gradle.caching=true
+org.gradle.configuration-cache=true
+org.gradle.java.home=C:/Users/Gclif/.jdks/openjdk-25.0.1
+
+# Minecraft / loader versions (minimum supported)
+minecraft_version=26.1
+minecraft_version_range=[26.1,)
+neoforge_loader_range=[4,)
+fabric_loader_version=0.18.2
+
+## Mod Properties - CHANGE THESE for your pack
+mod_id=decocraft_mypack
+mod_name=Decocraft My Pack
+mod_license=All Rights Reserved
+mod_version=1.0.0
+mod_group_id=com.razz.decocraft.mypack
+mod_authors=YourName
+mod_description=Adds new decorations to Decocraft
+
+# Decocraft minimum version
+decocraft_version=3.0.7

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists

gradlew

@@ -0,0 +1,251 @@
+#!/bin/sh
+
+#
+# Copyright © 2015-2021 the original authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# SPDX-License-Identifier: Apache-2.0
+#
+
+##############################################################################
+#
+#   Gradle start up script for POSIX generated by Gradle.
+#
+#   Important for running:
+#
+#   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
+#       noncompliant, but you have some other compliant shell such as ksh or
+#       bash, then to run this script, type that shell name before the whole
+#       command line, like:
+#
+#           ksh Gradle
+#
+#       Busybox and similar reduced shells will NOT work, because this script
+#       requires all of these POSIX shell features:
+#         * functions;
+#         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
+#           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
+#         * compound commands having a testable exit status, especially «case»;
+#         * various built-in commands including «command», «set», and «ulimit».
+#
+#   Important for patching:
+#
+#   (2) This script targets any POSIX shell, so it avoids extensions provided
+#       by Bash, Ksh, etc; in particular arrays are avoided.
+#
+#       The "traditional" practice of packing multiple parameters into a
+#       space-separated string is a well documented source of bugs and security
+#       problems, so this is (mostly) avoided, by progressively accumulating
+#       options in "$@", and eventually passing that to Java.
+#
+#       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
+#       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
+#       see the in-line comments for details.
+#
+#       There are tweaks for specific operating systems such as AIX, CygWin,
+#       Darwin, MinGW, and NonStop.
+#
+#   (3) This script is generated from the Groovy template
+#       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
+#       within the Gradle project.
+#
+#       You can find Gradle at https://github.com/gradle/gradle/.
+#
+##############################################################################
+
+# Attempt to set APP_HOME
+
+# Resolve links: $0 may be a link
+app_path=$0
+
+# Need this for daisy-chained symlinks.
+while
+    APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
+    [ -h "$app_path" ]
+do
+    ls=$( ls -ld "$app_path" )
+    link=${ls#*' -> '}
+    case $link in             #(
+      /*)   app_path=$link ;; #(
+      *)    app_path=$APP_HOME$link ;;
+    esac
+done
+
+# This is normally unused
+# shellcheck disable=SC2034
+APP_BASE_NAME=${0##*/}
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
+
+# Use the maximum available, or set MAX_FD != -1 to use that value.
+MAX_FD=maximum
+
+warn () {
+    echo "$*"
+} >&2
+
+die () {
+    echo
+    echo "$*"
+    echo
+    exit 1
+} >&2
+
+# OS specific support (must be 'true' or 'false').
+cygwin=false
+msys=false
+darwin=false
+nonstop=false
+case "$( uname )" in                #(
+  CYGWIN* )         cygwin=true  ;; #(
+  Darwin* )         darwin=true  ;; #(
+  MSYS* | MINGW* )  msys=true    ;; #(
+  NONSTOP* )        nonstop=true ;;
+esac
+
+CLASSPATH="\\\"\\\""
+
+
+# Determine the Java command to use to start the JVM.
+if [ -n "$JAVA_HOME" ] ; then
+    if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
+        # IBM's JDK on AIX uses strange locations for the executables
+        JAVACMD=$JAVA_HOME/jre/sh/java
+    else
+        JAVACMD=$JAVA_HOME/bin/java
+    fi
+    if [ ! -x "$JAVACMD" ] ; then
+        die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+else
+    JAVACMD=java
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+
+Please set the JAVA_HOME variable in your environment to match the
+location of your Java installation."
+    fi
+fi
+
+# Increase the maximum file descriptors if we can.
+if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
+    case $MAX_FD in #(
+      max*)
+        # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
+        MAX_FD=$( ulimit -H -n ) ||
+            warn "Could not query maximum file descriptor limit"
+    esac
+    case $MAX_FD in  #(
+      '' | soft) :;; #(
+      *)
+        # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
+        # shellcheck disable=SC2039,SC3045
+        ulimit -n "$MAX_FD" ||
+            warn "Could not set maximum file descriptor limit to $MAX_FD"
+    esac
+fi
+
+# Collect all arguments for the java command, stacking in reverse order:
+#   * args from the command line
+#   * the main class name
+#   * -classpath
+#   * -D...appname settings
+#   * --module-path (only if needed)
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
+
+# For Cygwin or MSYS, switch paths to Windows format before running java
+if "$cygwin" || "$msys" ; then
+    APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
+    CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
+
+    JAVACMD=$( cygpath --unix "$JAVACMD" )
+
+    # Now convert the arguments - kludge to limit ourselves to /bin/sh
+    for arg do
+        if
+            case $arg in                                #(
+              -*)   false ;;                            # don't mess with options #(
+              /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
+                    [ -e "$t" ] ;;                      #(
+              *)    false ;;
+            esac
+        then
+            arg=$( cygpath --path --ignore --mixed "$arg" )
+        fi
+        # Roll the args list around exactly as many times as the number of
+        # args, so each arg winds up back in the position where it started, but
+        # possibly modified.
+        #
+        # NB: a `for` loop captures its iteration list before it begins, so
+        # changing the positional parameters here affects neither the number of
+        # iterations, nor the values presented in `arg`.
+        shift                   # remove old arg
+        set -- "$@" "$arg"      # push replacement arg
+    done
+fi
+
+
+# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
+
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
+
+set -- \
+        "-Dorg.gradle.appname=$APP_BASE_NAME" \
+        -classpath "$CLASSPATH" \
+        -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
+        "$@"
+
+# Stop when "xargs" is not available.
+if ! command -v xargs >/dev/null 2>&1
+then
+    die "xargs is not available"
+fi
+
+# Use "xargs" to parse quoted args.
+#
+# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
+#
+# In Bash we could simply go:
+#
+#   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
+#   set -- "${ARGS[@]}" "$@"
+#
+# but POSIX shell has neither arrays nor command substitution, so instead we
+# post-process each arg (as a line of input to sed) to backslash-escape any
+# character that might be a shell metacharacter, then use eval to reverse
+# that process (while maintaining the separation between arguments), and wrap
+# the whole thing up as a single "set" statement.
+#
+# This will of course break if any of these variables contains a newline or
+# an unmatched quote.
+#
+
+eval "set -- $(
+        printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
+        xargs -n1 |
+        sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
+        tr '\n' ' '
+    )" '"$@"'
+
+exec "$JAVACMD" "$@"

gradlew.bat

@@ -0,0 +1,94 @@
+@rem
+@rem Copyright 2015 the original author or authors.
+@rem
+@rem Licensed under the Apache License, Version 2.0 (the "License");
+@rem you may not use this file except in compliance with the License.
+@rem You may obtain a copy of the License at
+@rem
+@rem      https://www.apache.org/licenses/LICENSE-2.0
+@rem
+@rem Unless required by applicable law or agreed to in writing, software
+@rem distributed under the License is distributed on an "AS IS" BASIS,
+@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@rem See the License for the specific language governing permissions and
+@rem limitations under the License.
+@rem
+@rem SPDX-License-Identifier: Apache-2.0
+@rem
+
+@if "%DEBUG%"=="" @echo off
+@rem ##########################################################################
+@rem
+@rem  Gradle startup script for Windows
+@rem
+@rem ##########################################################################
+
+@rem Set local scope for the variables with windows NT shell
+if "%OS%"=="Windows_NT" setlocal
+
+set DIRNAME=%~dp0
+if "%DIRNAME%"=="" set DIRNAME=.
+@rem This is normally unused
+set APP_BASE_NAME=%~n0
+set APP_HOME=%DIRNAME%
+
+@rem Resolve any "." and ".." in APP_HOME to make it shorter.
+for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
+
+@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
+set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
+
+@rem Find java.exe
+if defined JAVA_HOME goto findJavaFromJavaHome
+
+set JAVA_EXE=java.exe
+%JAVA_EXE% -version >NUL 2>&1
+if %ERRORLEVEL% equ 0 goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

settings.gradle

@@ -0,0 +1,11 @@
+pluginManagement {
+    repositories {
+        gradlePluginPortal()
+    }
+}
+
+plugins {
+    id 'org.gradle.toolchains.foojay-resolver-convention' version '0.9.0'
+}
+
+rootProject.name = 'decocraft-mypack'

src/main/resources/assets/decocraft/decocraft.json

@@ -0,0 +1,4 @@
+[
+  "groups.json",
+  "mypack.json"
+]

src/main/resources/assets/decocraft/groups.json

@@ -0,0 +1,3 @@
+{
+  "mypack": { "label": "itemGroup.decocraft.mypack", "icon": "example_block" }
+}

src/main/resources/assets/decocraft/lang/en_us.json

@@ -0,0 +1,5 @@
+{
+  "itemGroup.decocraft.mypack": "Decocraft - My Pack",
+  "block.decocraft.example_block": "Example Block",
+  "item.decocraft.example_block": "Example Block"
+}

src/main/resources/assets/decocraft/mypack.json

@@ -0,0 +1,13 @@
+{
+  "models": [
+    {
+      "name": "Example Block",
+      "model": "example_block",
+      "material": "example_block",
+      "scale": 1.0,
+      "tabs": "mypack",
+      "crafting_color": [50.0, 50.0, 50.0],
+      "decoref": "example_block"
+    }
+  ]
+}

src/main/templates/META-INF/neoforge.mods.toml

@@ -0,0 +1,29 @@
+license="${mod_license}"
+
+[[mods]]
+modId="${mod_id}"
+version="${mod_version}"
+displayName="${mod_name}"
+authors="${mod_authors}"
+description='''${mod_description}'''
+
+[[dependencies.${mod_id}]]
+    modId="neoforge"
+    type="required"
+    versionRange="[21.0,)"
+    ordering="NONE"
+    side="BOTH"
+
+[[dependencies.${mod_id}]]
+    modId="minecraft"
+    type="required"
+    versionRange="[1.21,)"
+    ordering="NONE"
+    side="BOTH"
+
+[[dependencies.${mod_id}]]
+    modId="decocraft"
+    type="required"
+    versionRange="[${decocraft_version},)"
+    ordering="AFTER"
+    side="BOTH"

src/main/templates/fabric.mod.json

@@ -0,0 +1,16 @@
+{
+  "schemaVersion": 1,
+  "id": "${mod_id}",
+  "version": "${mod_version}",
+  "name": "${mod_name}",
+  "description": "${mod_description}",
+  "authors": ["${mod_authors}"],
+  "license": "${mod_license}",
+  "environment": "*",
+  "depends": {
+    "fabricloader": ">=${fabric_loader_version}",
+    "minecraft": ">=1.21",
+    "java": ">=25",
+    "decocraft": ">=${decocraft_version}"
+  }
+}