diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7c42dd6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,40 @@ +# Ignore everything... + +/* + +# Except... + +# Repo files +!.github/ +!.gitattributes +!.gitignore +!.gitmodules + +# Project files +!src/ +!docs/ +!LICENCE/ +!LICENCE* +!LICENSE/ +!LICENSE* +!README* + +# Third-party libraries +!lib/ + +# Gradle +!gradle/ +!gradlew +!gradlew.bat +!?*.gradle +!*.properties +!gradle.* +!build.* + +# Integrations +!codeformat/ +!.travis.yml + +# Other +!publish/ +publish/releases/*changelog* diff --git a/LICENSE b/LICENCE similarity index 100% rename from LICENSE rename to LICENCE diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..b056fda --- /dev/null +++ b/build.gradle @@ -0,0 +1,60 @@ +buildscript { + repositories { + jcenter() + maven { + name = "forge" + url = "https://files.minecraftforge.net/maven" + } + } + dependencies { + classpath "net.minecraftforge.gradle:ForgeGradle:2.3-SNAPSHOT" + } +} +plugins { + id "org.ajoberstar.reckon" version "0.9.0" +} +apply plugin: "net.minecraftforge.gradle.forge" +apply plugin: "checkstyle" +if (file("../.etc/srscode-MC.gradle").exists()) {apply from: "../.etc/srscode-MC.gradle"} + +sourceCompatibility = targetCompatibility = JavaVersion.VERSION_1_8 +group = "de.srsco" +archivesBaseName = project.name + +reckon { + scopeFromProp() + stageFromProp("dev", "final") +} + +checkstyle { + setConfig resources.text.fromUri("https://srscode.github.io/checkstyle/srsCode-MC-checkstyle.xml") + setReportsDir file("${project.buildDir}/reports/checkstyle") + setToolVersion "8.16" +} +tasks.withType(Checkstyle) { + reports.xml.enabled = false + reports.html.enabled = true +} + +minecraft { + setVersion "${project.mc_version}-${project.forge_version}" + setMappings "${project.mapping_channel}_${project.mapping_version}" + setRunDir "run" + replace "@VERSION@", project.version as String + replaceIn "ReOpenAL.java" + setMakeObfSourceJar false +} + +processResources { + inputs.property "version", project.version as String + from(sourceSets.main.resources.srcDirs) { + include "mcmod.info" + expand "version": project.version + } + from(sourceSets.main.resources.srcDirs) {exclude "mcmod.info"} +} + +jar.manifest.attributes([ + "FMLAT" : "reopenal_at.cfg", + "Maven-Artifact": "${project.group}:${archivesBaseName}:${project.version}" +]) diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..b2ccf96 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,4 @@ +mc_version=1.12.2 +forge_version=14.23.5.2823 +mapping_channel=stable +mapping_version=39 diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..29953ea 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..fb7ef98 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-bin.zip diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..cccdd3d --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$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="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# 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 + ;; + 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" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..f955316 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@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 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= + +@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 init + +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 init + +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 + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +: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 %CMD_LINE_ARGS% + +: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 b/settings.gradle new file mode 100644 index 0000000..2b8dd67 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = "ReOpenAL" diff --git a/src/main/java/srscode/reopenal/ReOpenAL.java b/src/main/java/srscode/reopenal/ReOpenAL.java new file mode 100644 index 0000000..8a1ba31 --- /dev/null +++ b/src/main/java/srscode/reopenal/ReOpenAL.java @@ -0,0 +1,131 @@ +/* + * Project : ReOpenAL + * File : ReOpenAL.java + * Last Modified: 20190323-10:48:22-0400 + * + * This is free and unencumbered software released into the public domain. + * + * Anyone is free to copy, modify, publish, use, compile, sell, or + * distribute this software, either in source code form or as a compiled + * binary, for any purpose, commercial or non-commercial, and by any + * means. + * + * In jurisdictions that recognize copyright laws, the author or authors + * of this software dedicate any and all copyright interest in the + * software to the public domain. We make this dedication for the benefit + * of the public at large and to the detriment of our heirs and + * successors. We intend this dedication to be an overt act of + * relinquishment in perpetuity of all present and future rights to this + * software under copyright law. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, + * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF + * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. + * IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR + * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, + * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR + * OTHER DEALINGS IN THE SOFTWARE. + * + * For more information, please refer to + * + */ + +package srscode.reopenal; + +import java.lang.reflect.Field; + +import org.apache.logging.log4j.LogManager; +import org.apache.logging.log4j.Logger; +import paulscode.sound.Library; +import paulscode.sound.SoundSystem; +import paulscode.sound.SoundSystemConfig; +import paulscode.sound.SoundSystemException; +import paulscode.sound.libraries.LibraryLWJGLOpenAL; + +import net.minecraft.client.Minecraft; +import net.minecraft.client.gui.GuiScreenOptionsSounds; + +import net.minecraftforge.client.event.GuiOpenEvent; +import net.minecraftforge.common.MinecraftForge; +import net.minecraftforge.fml.common.Mod; +import net.minecraftforge.fml.common.event.FMLPreInitializationEvent; +import net.minecraftforge.fml.common.eventhandler.SubscribeEvent; + +@Mod(modid = "reopenal", name = "ReOpenAL", version = "@VERSION@", acceptedMinecraftVersions = "[1.9, 1.13)", clientSideOnly = true) +public final class ReOpenAL +{ + private static final Logger LOGGER = LogManager.getLogger("ReOpenAL"); + + @Mod.EventHandler + public final void init(final FMLPreInitializationEvent event) + { + boolean failed = false; + try { + soundLibraryField = SoundSystem.class.getDeclaredField("soundLibrary"); + soundLibraryField.setAccessible(true); + } catch (NoSuchFieldException e) { + failed = true; + LOGGER.error("Error getting private field 'soundLibrary' in SoundSystem."); + e.printStackTrace(); + } catch (SecurityException e) { + failed = true; + LOGGER.error("Error changing access of private field 'soundLibrary' in SoundSystem."); + e.printStackTrace(); + } finally { + if (failed) { + LOGGER.error("Initialization failed."); + } else { + LOGGER.debug("Registering ReOpenAL event handler."); + MinecraftForge.EVENT_BUS.register(this); + } + } + } + + @SubscribeEvent + public final void onGuiOpen(final GuiOpenEvent event) + { + if (event.getGui() instanceof GuiScreenOptionsSounds) { + LOGGER.debug("Checking SoundSystem Library..."); + maybeRestartSoundSystem(); + } + } + + private Field soundLibraryField = null; + + private void maybeRestartSoundSystem() + { + if (soundLibraryField != null) { + final SoundSystem sndSystem = Minecraft.getMinecraft().getSoundHandler().sndManager.sndSystem; + if (sndSystem != null) { + try { + final Library lib = (Library) soundLibraryField.get(sndSystem); + if (lib instanceof LibraryLWJGLOpenAL) { + LOGGER.debug("SoundSystem is using LibraryLWJGLOpenAL."); + } else { + LOGGER.warn("SoundSystem is not currently using LibraryLWJGLOpenAL. (Probably running in silent mode); Resetting..."); + restartSoundSystem(); + } + } catch (IllegalAccessException | IllegalArgumentException e) { + LOGGER.error("Exception during reflective access of SoundSystem. Could not check library."); + e.printStackTrace(); + } + } else { + LOGGER.error("Sound system doesn't exist. Trying to restart it..."); + restartSoundSystem(); + } + } + } + + private void restartSoundSystem() + { + try { + Minecraft.getMinecraft().getSoundHandler().sndManager.unloadSoundSystem(); + // ensure LibraryLWJGLOpenAL is added before restarting + SoundSystemConfig.addLibrary(LibraryLWJGLOpenAL.class); + Minecraft.getMinecraft().getSoundHandler().sndManager.reloadSoundSystem(); + } catch (SoundSystemException e) { + LOGGER.error("Failed to add sound library: LibraryLWJGLOpenAL"); + e.printStackTrace(); + } + } +} diff --git a/src/main/resources/META-INF/reopenal_at.cfg b/src/main/resources/META-INF/reopenal_at.cfg new file mode 100644 index 0000000..29b96af --- /dev/null +++ b/src/main/resources/META-INF/reopenal_at.cfg @@ -0,0 +1,2 @@ +public net.minecraft.client.audio.SoundHandler field_147694_f #sndManager +public net.minecraft.client.audio.SoundManager field_148620_e #sndSystem diff --git a/src/main/resources/mcmod.info b/src/main/resources/mcmod.info new file mode 100644 index 0000000..6058bd6 --- /dev/null +++ b/src/main/resources/mcmod.info @@ -0,0 +1,9 @@ +[{ + "modid" : "reopenal", + "name" : "ReOpenAL", + "description": "\u00a7aReOpenAL\u00a7r is a client-side mod that adds a means to restart the Minecraft sound system without having to reload all mod resource packs.\\n\\nThis is useful if the Minecraft sound system fails to start with OpenAL during startup leaving the game running in 'silent mode'. Simply enter the sound options GUI \u00a73[\u00a76Options\u00a7r \u00a7b-> \u00a76Music and Sounds\u00a73]\u00a7r and ReOpenAL will attempt to restart the sound system with OpenAL.\\n\\nReOpenAL is compatible with Minecraft versions from \u00a761.9\u00a7r to \u00a761.12\u00a7r", + "version" : "${version}", + "url" : "https://github.com/srsCode/ReOpenAL", + "authorList" : ["srsCode"], + "logoFile" : "reopenal-logo.png" +}] diff --git a/src/main/resources/reopenal-logo.png b/src/main/resources/reopenal-logo.png new file mode 100644 index 0000000..f6fd878 Binary files /dev/null and b/src/main/resources/reopenal-logo.png differ