1
0
Fork 0

Initial commit

This commit is contained in:
Moritz Ruth 2022-08-19 17:40:02 +02:00
commit 15e52332e5
14 changed files with 513 additions and 0 deletions

7
.editorconfig Normal file
View file

@ -0,0 +1,7 @@
root = true
[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
trim_trailing_whitespace = true

4
.gitignore vendored Normal file
View file

@ -0,0 +1,4 @@
/.idea/
/run/
/build/
/.gradle/

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2022 The horizr contributors
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
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 OR COPYRIGHT HOLDERS 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.

37
README.md Normal file
View file

@ -0,0 +1,37 @@
<p align="center">
<img src="./logo.png">
</p>
<p align="center">
<a href="https://modrinth.com/mod/one-time-overrides">
<img src="https://raw.githubusercontent.com/modrinth/art/main/Branding/Badge/badge-dark.svg">
</a>
</p>
<p align="center">
A Fabric mod allowing modpack authors to add non-overwriting override files.
</p>
# OneTimeOverrides
Some override files, such as `options.txt`, should only be copied the first time a player plays a modpack.
Otherwise, their changes would be lost every time the modpack is updated.
This mod allows modpack authors to place files in the `one-time-overrides` directory
that will only be copied to their intended destination if the target file does not exist.
Example:
```
.minecraft
├── config
│ └── first_mod.toml
└── one-time-overrides
│ └── config
│ └── first_mod.toml # already exists in .minecraft/config -> will not be copied
└── options.txt # does not exist in .minecraft -> will be copied
```
As it does not use any Minecraft-specific APIs, the mod should work with any version of the game.
`1.18.2` and `1.19.2` were tested.
The only dependency is [fabric-language-kotlin](https://github.com/FabricMC/fabric-language-kotlin).
[Fabric API](https://github.com/FabricMC/fabric) is not required.

58
build.gradle.kts Normal file
View file

@ -0,0 +1,58 @@
plugins {
val kotlinVersion: String by System.getProperties()
java
kotlin("jvm") version kotlinVersion
id("fabric-loom") version "0.12.+"
}
group = "xyz.horizr.onetimeoverrides"
version = "1.0.0"
repositories {
mavenCentral()
}
val kotlinVersion: String by System.getProperties()
val fabricLoaderVersion = "0.14.9"
val fabricLanguageKotlinVersion = "1.8.2+kotlin.$kotlinVersion"
dependencies {
minecraft("com.mojang:minecraft:1.18.2")
mappings("net.fabricmc:yarn:1.18.2+build.4:v2")
modImplementation("net.fabricmc:fabric-loader:$fabricLoaderVersion")
modImplementation("net.fabricmc:fabric-language-kotlin:$fabricLanguageKotlinVersion")
include("io.github.microutils:kotlin-logging-jvm:2.1.23")
implementation("io.github.microutils:kotlin-logging-jvm:2.1.23")
}
kotlin {
jvmToolchain {
languageVersion.set(JavaLanguageVersion.of(17))
}
}
tasks {
processResources {
inputs.property("version", project.version)
filesMatching("fabric.mod.json") {
expand(
mutableMapOf(
"version" to project.version,
"fabricLoaderVersion" to fabricLoaderVersion,
"fabricLanguageKotlinVersion" to fabricLanguageKotlinVersion
)
)
}
}
remapJar {
addNestedDependencies.set(true)
}
}
loom {
runtimeOnlyLog4j.set(true)
}

5
gradle.properties Normal file
View file

@ -0,0 +1,5 @@
org.gradle.jvmargs=-Xmx2G
kotlin.code.style=official
# has to be a system prop because it is accessed in the plugins block
systemProp.kotlinVersion=1.7.10

View file

@ -0,0 +1 @@
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip

185
gradlew vendored Normal file
View file

@ -0,0 +1,185 @@
#!/usr/bin/env sh
#
# Copyright 2015 the original author or 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 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='"-Xmx64m" "-Xms64m"'
# 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
;;
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" = "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 or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; 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=`expr $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"
exec "$JAVACMD" "$@"

89
gradlew.bat vendored Normal file
View file

@ -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

BIN
logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.8 KiB

9
settings.gradle.kts Normal file
View file

@ -0,0 +1,9 @@
pluginManagement {
repositories {
mavenCentral()
gradlePluginPortal()
maven("https://maven.fabricmc.net")
}
}
rootProject.name = "one-time-overrides"

View file

@ -0,0 +1,68 @@
package xyz.horizr.onetimeoverrides
import kotlinx.atomicfu.atomic
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.launch
import kotlinx.coroutines.runBlocking
import mu.KotlinLogging
import net.fabricmc.loader.api.FabricLoader
import java.nio.file.FileAlreadyExistsException
import java.nio.file.LinkOption
import java.nio.file.Path
import kotlin.io.path.*
val fabricLoader: FabricLoader = FabricLoader.getInstance()
fun Path.getPathsRecursively(relativeTo: Path = this): Set<Path> {
return buildSet {
for (path in listDirectoryEntries()) {
if (path.isRegularFile(LinkOption.NOFOLLOW_LINKS)) add(path.relativeTo(relativeTo))
else if (path.isDirectory(LinkOption.NOFOLLOW_LINKS)) addAll(path.getPathsRecursively(relativeTo))
}
}
}
const val OVERRIDES_DIRECTORY_NAME = "one-time-overrides"
@Suppress("unused")
fun init() {
val logger = KotlinLogging.logger("OneTimeOverrides")
val oneTimeOverridesDirectory = fabricLoader.gameDir.resolve(OVERRIDES_DIRECTORY_NAME)
if (!oneTimeOverridesDirectory.isDirectory()) {
logger.warn("$OVERRIDES_DIRECTORY_NAME directory does not exist.")
return
}
val allOverrides = oneTimeOverridesDirectory.getPathsRecursively()
if (allOverrides.isEmpty()) {
logger.warn("$OVERRIDES_DIRECTORY_NAME directory does not contain any overrides.")
return
}
fun copyOverrideFile(relativePath: Path): Boolean = try {
val outputPath = fabricLoader.gameDir.resolve(relativePath)
outputPath.parent.createDirectories()
oneTimeOverridesDirectory.resolve(relativePath).copyTo(outputPath, false)
true
} catch (e: FileAlreadyExistsException) {
false
}
var newCount by atomic(0)
runBlocking(Dispatchers.IO) {
for (relativePath in allOverrides) {
launch {
val wasNew = copyOverrideFile(relativePath)
if (wasNew) {
logger.debug("Copied new override: $relativePath")
newCount++
}
}
}
}
logger.info("Copied $newCount new override(s).")
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

View file

@ -0,0 +1,29 @@
{
"schemaVersion": 1,
"id": "one-time-overrides",
"version": "${version}",
"name": "OneTimeOverrides",
"description": "Allows modpack authors to add non-overwriting override files.",
"authors": [
"zziius"
],
"contact": {
"homepage": "https://github.com/horizr/one-time-overrides",
"issues": "https://github.com/horizr/one-time-overrides/issues",
"sources": "https://github.com/horizr/one-time-overrides"
},
"license": "MIT",
"icon": "assets/one-time-overrides/icon.png",
"entrypoints": {
"main": [
{
"adapter": "kotlin",
"value": "xyz.horizr.onetimeoverrides.OneTimeOverridesKt::init"
}
]
},
"depends": {
"fabricloader": "${fabricLoaderVersion}",
"fabric-language-kotlin": "${fabricLanguageKotlinVersion}"
}
}