commit 9d57839ac89c889c5d693ce8b6f6bae28d1ebb35 Author: connorhartley Date: Sun Feb 12 11:48:36 2023 +1300 initial project diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..aa7ccd4 --- /dev/null +++ b/.gitignore @@ -0,0 +1,290 @@ +# Ignore Gradle project-specific cache directory +.gradle + +# Ignore Gradle build output directory +build +### Java template +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +### JetBrains template +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# User-specific stuff +.idea/**/workspace.xml +.idea/**/tasks.xml +.idea/**/usage.statistics.xml +.idea/**/dictionaries +.idea/**/shelf + +# Generated files +.idea/**/contentModel.xml + +# Sensitive or high-churn files +.idea/**/dataSources/ +.idea/**/dataSources.ids +.idea/**/dataSources.local.xml +.idea/**/sqlDataSources.xml +.idea/**/dynamic.xml +.idea/**/uiDesigner.xml +.idea/**/dbnavigator.xml + +# Gradle +.idea/**/gradle.xml +.idea/**/libraries + +# Gradle and Maven with auto-import +# When using Gradle or Maven with auto-import, you should exclude module files, +# since they will be recreated, and may cause churn. Uncomment if using +# auto-import. +.idea/artifacts +.idea/compiler.xml +.idea/jarRepositories.xml +.idea/modules.xml +.idea/*.iml +.idea/modules +*.iml +*.ipr + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Cursive Clojure plugin +.idea/replstate.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Editor-based Rest Client +.idea/httpRequests + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### Kotlin template +# Compiled class file +*.class + +# Log file +*.log + +# BlueJ files +*.ctxt + +# Mobile Tools for Java (J2ME) +.mtj.tmp/ + +# Package Files # +*.jar +*.war +*.nar +*.ear +*.zip +*.tar.gz +*.rar + +# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml +hs_err_pid* + +### Linux template +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* + +### Windows template +# Windows thumbnail cache files +Thumbs.db +Thumbs.db:encryptable +ehthumbs.db +ehthumbs_vista.db + +# Dump file +*.stackdump + +# Folder config file +[Dd]esktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msix +*.msm +*.msp + +# Windows shortcuts +*.lnk + +### Gradle template +.gradle +/build/ + +# Ignore Gradle GUI config +gradle-app.setting + +# Avoid ignoring Gradle wrapper jar file (.jar files are usually ignored) +!gradle-wrapper.jar + +# Cache of project +.gradletasknamecache + +# # Work around https://youtrack.jetbrains.com/issue/IDEA-116898 +# gradle/wrapper/gradle-wrapper.properties + +### NetBeans template +**/nbproject/private/ +**/nbproject/Makefile-*.mk +**/nbproject/Package-*.bash +build/ +nbbuild/ +dist/ +nbdist/ +.nb-gradle/ + +### Eclipse template +.metadata +bin/ +tmp/ +*.tmp +*.bak +*.swp +*~.nib +local.properties +.settings/ +.loadpath +.recommenders + +# External tool builders +.externalToolBuilders/ + +# Locally stored "Eclipse launch configurations" +*.launch + +# PyDev specific (Python IDE for Eclipse) +*.pydevproject + +# CDT-specific (C/C++ Development Tooling) +.cproject + +# CDT- autotools +.autotools + +# Java annotation processor (APT) +.factorypath + +# PDT-specific (PHP Development Tools) +.buildpath + +# sbteclipse plugin +.target + +# Tern plugin +.tern-project + +# TeXlipse plugin +.texlipse + +# STS (Spring Tool Suite) +.springBeans + +# Code Recommenders +.recommenders/ + +# Annotation Processing +.apt_generated/ +.apt_generated_test/ + +# Scala IDE specific (Scala & Java development for Eclipse) +.cache-main +.scala_dependencies +.worksheet + +# Uncomment this line if you wish to ignore the project description file. +# Typically, this file would be tracked if it contains build/dependency configurations: +#.project + +### macOS template +# General +.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### Ignite Mod Template ### +.idea/ +run/ +target/ +cache/ \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..c6486a4 --- /dev/null +++ b/README.md @@ -0,0 +1,5 @@ +Ignite Mod Template +=================== + +A template for creating an [Ignite](https://github.com/vectrix-space/ignite) +mod for [Paper](https://papermc.io/) 1.19.3. diff --git a/build-logic/build.gradle.kts b/build-logic/build.gradle.kts new file mode 100644 index 0000000..4f82e8d --- /dev/null +++ b/build-logic/build.gradle.kts @@ -0,0 +1,17 @@ +plugins { + `kotlin-dsl` +} + +repositories { + gradlePluginPortal() + maven { + url = uri("https://repo.papermc.io/repository/maven-public/") + } +} + +dependencies { + val indraVersion = "3.0.1" + implementation("net.kyori", "indra-common", indraVersion) + implementation("gradle.plugin.com.github.johnrengelman", "shadow", "7.1.2") + implementation("io.papermc.paperweight.userdev", "io.papermc.paperweight.userdev.gradle.plugin", "1.5.0") +} diff --git a/build-logic/src/main/kotlin/mod.base-conventions.gradle.kts b/build-logic/src/main/kotlin/mod.base-conventions.gradle.kts new file mode 100644 index 0000000..510ba7f --- /dev/null +++ b/build-logic/src/main/kotlin/mod.base-conventions.gradle.kts @@ -0,0 +1,58 @@ +import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar + +plugins { + id("net.kyori.indra") + id("net.kyori.indra.publishing") + + id("com.github.johnrengelman.shadow") + id("io.papermc.paperweight.userdev") +} + +configurations { + val shadeApi = create("shadeApi") + val shadeImplementation = create("shadeImplementation") + + api { extendsFrom(shadeApi) } + implementation { extendsFrom(shadeImplementation) } +} + +repositories { + mavenCentral() + maven { + url = uri("https://oss.sonatype.org/content/groups/public/") + } + maven { + url = uri("https://repo.papermc.io/repository/maven-public/") + } + maven { + url = uri("https://repo.spongepowered.org/maven/") + } +} + +indra { + javaVersions { + target(17) + } +} + +val jar = tasks.named("jar") + +val shadowJar = tasks.named("shadowJar") { + configurations = listOf(project.configurations.named("shadeApi").get(), project.configurations.named("shadeImplementation").get()) + + from(jar) +} + +tasks { + build { + dependsOn(reobfJar) + } + + reobfJar { + remapperArgs.add("--mixin") + } +} + +artifacts { + archives(shadowJar) +} diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..2f58dee --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,13 @@ +plugins { + id("mod.base-conventions") +} + +group = "com.example" +version = "1.0.0-SNAPSHOT" + +dependencies { + implementation(libs.ignite) + implementation(libs.mixin) + + paperweight.paperDevBundle("1.19.3-R0.1-SNAPSHOT") +} diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml new file mode 100644 index 0000000..7ea1f80 --- /dev/null +++ b/gradle/libs.versions.toml @@ -0,0 +1,13 @@ +metadata.format.version = "1.1" + +[versions] + +ignite = "0.8.0" +mixin = "0.8.5" + +[libraries] + +ignite = { group = "space.vectrix.ignite", name = "ignite-api", version.ref = "ignite" } +mixin = { group = "org.spongepowered", name = "mixin", version.ref = "mixin" } + + diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..41d9927 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..070cb70 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-7.6-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/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. +# + +############################################################################## +# +# 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/master/subprojects/plugins/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 + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# 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"' + +# 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=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# 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 + which java >/dev/null 2>&1 || 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 + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + 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 + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# 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" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@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 + +@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=. +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%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..13fd2fc --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1,13 @@ +enableFeaturePreview("TYPESAFE_PROJECT_ACCESSORS") +enableFeaturePreview("VERSION_CATALOGS") + +pluginManagement { + repositories { + gradlePluginPortal() + maven("https://repo.papermc.io/repository/maven-public/") + } +} + +rootProject.name = "ignite-mod-template" + +includeBuild("build-logic") diff --git a/src/main/java/com/example/ExampleConfig.java b/src/main/java/com/example/ExampleConfig.java new file mode 100644 index 0000000..7081777 --- /dev/null +++ b/src/main/java/com/example/ExampleConfig.java @@ -0,0 +1,35 @@ +package com.example; + +import org.spongepowered.configurate.objectmapping.ConfigSerializable; +import org.spongepowered.configurate.objectmapping.meta.Comment; +import org.spongepowered.configurate.objectmapping.meta.Setting; + +@ConfigSerializable +public final class ExampleConfig { + @Setting(value = "test") + @Comment(value = "Test configuration property.") + private boolean test; + + @Setting(value = "container") + @Comment(value = "A test container.") + private TestContainer container; + + public boolean test() { + return this.test; + } + + public TestContainer container() { + return this.container; + } + + @ConfigSerializable + public static class TestContainer { + @Setting(value = "foo") + @Comment(value = "A test boolean in a container.") + private boolean foo; + + public boolean foo() { + return this.foo; + } + } +} diff --git a/src/main/java/com/example/ExampleInfo.java b/src/main/java/com/example/ExampleInfo.java new file mode 100644 index 0000000..9993980 --- /dev/null +++ b/src/main/java/com/example/ExampleInfo.java @@ -0,0 +1,31 @@ +package com.example; + +import org.checkerframework.checker.nullness.qual.MonotonicNonNull; +import org.checkerframework.checker.nullness.qual.NonNull; +import space.vectrix.ignite.api.Blackboard; +import space.vectrix.ignite.api.config.Configuration; + +import java.nio.file.Path; + +public final class ExampleInfo { + private static final @MonotonicNonNull Path CONFIGS_PATH = Blackboard.getProperty(Blackboard.CONFIG_DIRECTORY_PATH); + + private static @MonotonicNonNull Path EXAMPLE_PATH; + private static Configuration.@MonotonicNonNull Key EXAMPLE_CONFIG; + + public static @MonotonicNonNull Path getExamplePath() { + if (ExampleInfo.EXAMPLE_PATH != null) return ExampleInfo.EXAMPLE_PATH; + if (ExampleInfo.CONFIGS_PATH == null) return null; + + return ExampleInfo.EXAMPLE_PATH = ExampleInfo.CONFIGS_PATH.resolve("example"); + } + + public static Configuration.@NonNull Key getExampleConfig() { + if (ExampleInfo.EXAMPLE_CONFIG != null) return ExampleInfo.EXAMPLE_CONFIG; + + final Path examplePath = ExampleInfo.getExamplePath(); + if (examplePath == null) throw new IllegalStateException("Unable to locate example path."); + + return ExampleInfo.EXAMPLE_CONFIG = Configuration.key(ExampleConfig.class, examplePath.resolve("example.conf")); + } +} diff --git a/src/main/java/com/example/ExampleMod.java b/src/main/java/com/example/ExampleMod.java new file mode 100644 index 0000000..0212497 --- /dev/null +++ b/src/main/java/com/example/ExampleMod.java @@ -0,0 +1,34 @@ +package com.example; + +import com.google.inject.Inject; +import org.apache.logging.log4j.Logger; +import org.checkerframework.checker.nullness.qual.NonNull; +import org.spongepowered.configurate.CommentedConfigurationNode; +import space.vectrix.ignite.api.Platform; +import space.vectrix.ignite.api.config.Configuration; +import space.vectrix.ignite.api.config.Configurations; +import space.vectrix.ignite.api.event.Subscribe; +import space.vectrix.ignite.api.event.platform.PlatformInitializeEvent; + +public final class ExampleMod { + private final Logger logger; + private final Platform platform; + + @Inject + public ExampleMod(final Logger logger, + final Platform platform) { + this.logger = logger; + this.platform = platform; + } + + @Subscribe + public void onInitialize(final @NonNull PlatformInitializeEvent event) { + this.logger.info("Hello Example!"); + + final Configuration configWrapper = Configurations.getOrCreate(Configurations.HOCON_LOADER, ExampleInfo.getExampleConfig()); + final ExampleConfig config = configWrapper.instance(); + if (config != null) { + this.logger.info("Foo is set to: " + (config.container().foo() ? "Enabled" : "Disabled")); + } + } +} diff --git a/src/main/java/com/example/command/HelloCommand.java b/src/main/java/com/example/command/HelloCommand.java new file mode 100644 index 0000000..97a437b --- /dev/null +++ b/src/main/java/com/example/command/HelloCommand.java @@ -0,0 +1,24 @@ +package com.example.command; + +import org.bukkit.command.CommandSender; +import org.bukkit.command.defaults.BukkitCommand; +import org.checkerframework.checker.nullness.qual.NonNull; + +public final class HelloCommand extends BukkitCommand { + public HelloCommand(final @NonNull String name) { + super(name); + + this.setPermission("example.hello"); + } + + @Override + public boolean execute(final @NonNull CommandSender commandSender, final @NonNull String currentAlias, final @NonNull String[] args) { + if (!this.testPermission(commandSender)) { + return true; + } else { + commandSender.sendMessage("Hello " + commandSender.getName()); + } + + return false; + } +} diff --git a/src/main/java/com/example/mixin/core/MixinCraftServer.java b/src/main/java/com/example/mixin/core/MixinCraftServer.java new file mode 100644 index 0000000..90991bb --- /dev/null +++ b/src/main/java/com/example/mixin/core/MixinCraftServer.java @@ -0,0 +1,20 @@ +package com.example.mixin.core; + +import org.bukkit.craftbukkit.v1_19_R2.CraftServer; +import org.spongepowered.asm.mixin.Mixin; +import org.spongepowered.asm.mixin.Shadow; +import org.spongepowered.asm.mixin.injection.At; +import org.spongepowered.asm.mixin.injection.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; + +import java.util.logging.Logger; + +@Mixin(value = CraftServer.class) +public abstract class MixinCraftServer { + @Shadow public abstract Logger getLogger(); + + @Inject(method = "", at = @At("RETURN")) + private void onConstruction(CallbackInfo callback) { + this.getLogger().info("Hello World!"); + } +} diff --git a/src/main/java/com/example/mixin/core/MixinSimpleCommandMap.java b/src/main/java/com/example/mixin/core/MixinSimpleCommandMap.java new file mode 100644 index 0000000..77be279 --- /dev/null +++ b/src/main/java/com/example/mixin/core/MixinSimpleCommandMap.java @@ -0,0 +1,20 @@ +package com.example.mixin.core; + +import com.example.command.HelloCommand; +import org.bukkit.command.Command; +import org.bukkit.command.SimpleCommandMap; +import org.spongepowered.asm.mixin.Mixin; +import org.spongepowered.asm.mixin.Shadow; +import org.spongepowered.asm.mixin.injection.At; +import org.spongepowered.asm.mixin.injection.Inject; +import org.spongepowered.asm.mixin.injection.callback.CallbackInfo; + +@Mixin(value = SimpleCommandMap.class) +public abstract class MixinSimpleCommandMap { + @Shadow public abstract boolean register(String fallbackPrefix, Command command); + + @Inject(method = "setDefaultCommands()V", at = @At("TAIL"), remap = false) + public void registerOwnCommands(CallbackInfo callback) { + this.register("example", new HelloCommand("hello")); + } +} diff --git a/src/main/java/com/example/mixin/plugins/CorePlugin.java b/src/main/java/com/example/mixin/plugins/CorePlugin.java new file mode 100644 index 0000000..a60732f --- /dev/null +++ b/src/main/java/com/example/mixin/plugins/CorePlugin.java @@ -0,0 +1,54 @@ +package com.example.mixin.plugins; + +import com.example.ExampleConfig; +import com.example.ExampleInfo; +import org.checkerframework.checker.nullness.qual.NonNull; +import org.checkerframework.checker.nullness.qual.Nullable; +import org.objectweb.asm.tree.ClassNode; +import org.spongepowered.asm.mixin.extensibility.IMixinConfigPlugin; +import org.spongepowered.asm.mixin.extensibility.IMixinInfo; +import org.spongepowered.configurate.CommentedConfigurationNode; +import space.vectrix.ignite.api.config.Configuration; +import space.vectrix.ignite.api.config.Configurations; + +import java.util.List; +import java.util.Set; + +public final class CorePlugin implements IMixinConfigPlugin { + @Override + public void onLoad(final @NonNull String mixinPackage) { + } + + @Override + public @Nullable String getRefMapperConfig() { + return null; + } + + @Override + public boolean shouldApplyMixin(final @NonNull String targetClassName, final @NonNull String mixinClassName) { + final Configuration configWrapper = Configurations.getOrCreate(Configurations.HOCON_LOADER, ExampleInfo.getExampleConfig()); + final ExampleConfig config = configWrapper.instance(); + if (config != null) { + return config.test(); + } + + return false; + } + + @Override + public void acceptTargets(final @NonNull Set myTargets, final @NonNull Set otherTargets) { + } + + @Override + public @Nullable List getMixins() { + return null; + } + + @Override + public void preApply(final @NonNull String targetClassName, final @NonNull ClassNode targetClass, final @NonNull String mixinClassName, final @NonNull IMixinInfo mixinInfo) { + } + + @Override + public void postApply(final @NonNull String targetClassName, final @NonNull ClassNode targetClass, final @NonNull String mixinClassName, final @NonNull IMixinInfo mixinInfo) { + } +} diff --git a/src/main/resources/ignite.mod.json b/src/main/resources/ignite.mod.json new file mode 100644 index 0000000..3cbc9f5 --- /dev/null +++ b/src/main/resources/ignite.mod.json @@ -0,0 +1,11 @@ +{ + "id": "example", + "version": "1.0.0", + "entry": "com.example.ExampleMod", + "dependencies": [ + "ignite" + ], + "mixins": [ + "mixins.example.core.json" + ] +} \ No newline at end of file diff --git a/src/main/resources/mixins.example.core.json b/src/main/resources/mixins.example.core.json new file mode 100644 index 0000000..344591a --- /dev/null +++ b/src/main/resources/mixins.example.core.json @@ -0,0 +1,12 @@ +{ + "required": true, + "minVersion": "0.8.5", + "package": "com.example.mixin.core", + "plugin": "com.example.mixin.plugins.CorePlugin", + "target": "@env(DEFAULT)", + "compatibilityLevel": "JAVA_8", + "server": [ + "MixinCraftServer", + "MixinSimpleCommandMap" + ] +} \ No newline at end of file