├── settings.gradle ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── .gitignore ├── gradle.properties ├── src └── main │ └── java │ └── me │ └── fallenbreath │ └── yamlang │ ├── utils │ ├── IOUtils.java │ └── StringUtils.java │ ├── YamlangExtension.java │ ├── YamlangPlugin.java │ ├── YamlangConvertResourcesTask.java │ └── Yamlang2JsonlangTransformer.java ├── .github └── workflows │ ├── website.yml │ └── gradle.yml ├── gradlew.bat ├── website └── index.html ├── README.md ├── gradlew └── LICENSE /settings.gradle: -------------------------------------------------------------------------------- 1 | rootProject.name = 'yamlang' 2 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Fallen-Breath/yamlang/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # gradle 2 | 3 | .gradle/ 4 | build/ 5 | out/ 6 | classes/ 7 | logs/ 8 | 9 | # idea 10 | 11 | .idea/ 12 | *.iml 13 | *.ipr 14 | *.iws 15 | 16 | # vscode 17 | 18 | .settings/ 19 | .vscode/ 20 | bin/ 21 | .classpath 22 | .project 23 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.12-all.zip 4 | networkTimeout=10000 5 | zipStoreBase=GRADLE_USER_HOME 6 | zipStorePath=wrapper/dists 7 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project properties 2 | plugin_version = 1.5.0 3 | maven_group = me.fallenbreath 4 | archives_base_name = yamlang 5 | 6 | # Dependencies 7 | # https://mvnrepository.com/artifact/org.yaml/snakeyaml 8 | snakeyaml_version = 2.2 9 | 10 | # https://mvnrepository.com/artifact/com.google.code.gson/gson 11 | gson_version = 2.10.1 12 | -------------------------------------------------------------------------------- /src/main/java/me/fallenbreath/yamlang/utils/IOUtils.java: -------------------------------------------------------------------------------- 1 | package me.fallenbreath.yamlang.utils; 2 | 3 | import java.io.IOException; 4 | import java.io.Reader; 5 | 6 | public class IOUtils 7 | { 8 | public static String readerToString(Reader reader) throws IOException 9 | { 10 | StringBuilder builder = new StringBuilder(); 11 | char[] buf = new char[4096]; 12 | int n; 13 | while ((n = reader.read(buf)) != -1) 14 | { 15 | builder.append(buf, 0, n); 16 | } 17 | return builder.toString(); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /.github/workflows/website.yml: -------------------------------------------------------------------------------- 1 | name: Website 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | paths: 8 | - 'website/**' 9 | 10 | jobs: 11 | update: 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - uses: actions/checkout@v4 16 | 17 | - name: Deploy 18 | uses: s0/git-publish-subdir-action@develop 19 | env: 20 | REPO: self 21 | BRANCH: website 22 | FOLDER: website 23 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 24 | SQUASH_HISTORY: true 25 | SKIP_EMPTY_COMMITS: true 26 | -------------------------------------------------------------------------------- /src/main/java/me/fallenbreath/yamlang/utils/StringUtils.java: -------------------------------------------------------------------------------- 1 | package me.fallenbreath.yamlang.utils; 2 | 3 | public class StringUtils 4 | { 5 | /** 6 | * No need to handle those codepoint things, 7 | * cuz this method is only used to capitalize a gradle source set name 8 | */ 9 | public static String capitalize(final String str) 10 | { 11 | if (str == null || str.isEmpty()) 12 | { 13 | return str; 14 | } 15 | 16 | char firstChar = str.charAt(0); 17 | if (firstChar > 0x7F /* unicode? */ || Character.isUpperCase(firstChar)) 18 | { 19 | return str; 20 | } 21 | else 22 | { 23 | return Character.toUpperCase(firstChar) + str.substring(1); 24 | } 25 | } 26 | } 27 | -------------------------------------------------------------------------------- /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | name: Dev Builds 2 | 3 | on: 4 | push: 5 | paths: 6 | - "*.gradle" 7 | - "gradle.properties" 8 | - "src/**" 9 | - ".github/**" 10 | pull_request: 11 | 12 | 13 | jobs: 14 | build: 15 | runs-on: ubuntu-latest 16 | 17 | steps: 18 | - uses: actions/checkout@v4 19 | - name: Set up JDK 17 20 | uses: actions/setup-java@v4 21 | with: 22 | distribution: 'temurin' 23 | java-version: 17 24 | 25 | - name: Cache gradle files 26 | uses: actions/cache@v4 27 | with: 28 | path: | 29 | ~/.gradle/caches 30 | ~/.gradle/wrapper 31 | ./.gradle/loom-cache 32 | key: ${{ runner.os }}-gradle-${{ hashFiles('*.gradle', 'gradle.properties', '**/*.accesswidener') }} 33 | restore-keys: | 34 | ${{ runner.os }}-gradle- 35 | 36 | - name: Build with Gradle 37 | run: | 38 | chmod +x gradlew 39 | ./gradlew build 40 | 41 | - uses: actions/upload-artifact@v4 42 | with: 43 | name: build-artifacts 44 | path: build/libs/ 45 | 46 | - name: Publish gradle plugin 47 | if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v') 48 | run: | 49 | ./gradlew publishPlugins -Pgradle.publish.key=${{ secrets.GRADLE_PUBLISH_KEY }} -Pgradle.publish.secret=${{ secrets.GRADLE_PUBLISH_SECRET }} 50 | -------------------------------------------------------------------------------- /src/main/java/me/fallenbreath/yamlang/YamlangExtension.java: -------------------------------------------------------------------------------- 1 | package me.fallenbreath.yamlang; 2 | 3 | import org.gradle.api.provider.Property; 4 | import org.gradle.api.tasks.SourceSet; 5 | 6 | import java.util.Collection; 7 | 8 | public interface YamlangExtension 9 | { 10 | /** 11 | * The source set to hook up the yamlang file convertor 12 | */ 13 | Property> getTargetSourceSets(); 14 | 15 | /** 16 | * The path to the input directory containing the language files in yaml 17 | *

18 | * The path a related path of the output resources directory of the given source set 19 | */ 20 | Property getInputDir(); 21 | 22 | /** 23 | * The path to the output directory containing the language files in yaml 24 | *

25 | * The path a related path of the output resources directory of the given source set 26 | *

27 | * When not set, it will use {@link #getInputDir} as the fallback value 28 | */ 29 | Property getOutputDir(); 30 | 31 | /** 32 | * The file name pattern of the language files in yaml 33 | *

34 | * Default value: *.yml 35 | */ 36 | Property getTargetFilePattern(); 37 | 38 | /** 39 | * Should the original yaml language files be preserved after the conversion 40 | *

41 | * Given that Minecraft uses UTF-8 to load language files, it's generally advised to just keep the default value 42 | *

43 | * Default value: false, which means those yaml language files will be deleted after the conversion 44 | */ 45 | Property getPreserveYaml(); 46 | 47 | /** 48 | * The charset of the yaml files 49 | *

50 | * Default value: "UTF-8" 51 | */ 52 | Property getCharset(); 53 | 54 | /** 55 | * Enables OWO-LIB Rich Translations in the yaml translation files 56 | *

57 | * This option preserves lists added to the language file 58 | *

59 | * Default value: false, which means lists are not allowed 60 | */ 61 | Property getOwolibRichTranslations(); 62 | } -------------------------------------------------------------------------------- /src/main/java/me/fallenbreath/yamlang/YamlangPlugin.java: -------------------------------------------------------------------------------- 1 | package me.fallenbreath.yamlang; 2 | 3 | import java.util.Collections; 4 | import me.fallenbreath.yamlang.utils.StringUtils; 5 | import org.gradle.api.Plugin; 6 | import org.gradle.api.Project; 7 | import org.gradle.api.file.Directory; 8 | import org.gradle.api.file.DirectoryProperty; 9 | import org.gradle.api.provider.Provider; 10 | import org.gradle.api.tasks.SourceSet; 11 | import org.gradle.api.tasks.TaskProvider; 12 | 13 | public class YamlangPlugin implements Plugin 14 | { 15 | @Override 16 | public void apply(Project project) 17 | { 18 | YamlangExtension extension = project.getExtensions().create("yamlang", YamlangExtension.class); 19 | project.afterEvaluate(p -> { 20 | for (SourceSet sourceSet : extension.getTargetSourceSets().getOrElse(Collections.emptyList())) 21 | { 22 | String taskName = String.format("yamlangConvert%sResources", StringUtils.capitalize(sourceSet.getName())); 23 | project.getLogger().info("Hooking sourceset {}", sourceSet); 24 | 25 | TaskProvider provider = project.getTasks().register(taskName, YamlangConvertResourcesTask.class, task -> { 26 | task.dependsOn(sourceSet.getProcessResourcesTaskName()); 27 | task.getOutputs().upToDateWhen(t -> false); 28 | 29 | DirectoryProperty destination = project.getObjects().directoryProperty().fileValue(sourceSet.getOutput().getResourcesDir()); 30 | Provider inputDir = destination.dir(extension.getInputDir().orElse("")); 31 | Provider outputDir = destination.dir(extension.getOutputDir().orElse(extension.getInputDir().orElse(""))); 32 | 33 | task.getInputDirectory().set(inputDir); 34 | task.getOutputDirectory().set(outputDir); 35 | task.getTargetFilePattern().set(extension.getTargetFilePattern()); 36 | task.getPreserveYaml().set(extension.getPreserveYaml()); 37 | task.getCharset().set(extension.getCharset()); 38 | task.getOwolibRichTranslations().set(extension.getOwolibRichTranslations()); 39 | }); 40 | project.getTasks().getByName(sourceSet.getProcessResourcesTaskName(), task -> task.finalizedBy(provider)); 41 | project.getTasks().getByName(sourceSet.getClassesTaskName(), task -> task.dependsOn(provider)); 42 | } 43 | }); 44 | } 45 | } -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | @rem This is normally unused 30 | set APP_BASE_NAME=%~n0 31 | set APP_HOME=%DIRNAME% 32 | 33 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 34 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 35 | 36 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 37 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 38 | 39 | @rem Find java.exe 40 | if defined JAVA_HOME goto findJavaFromJavaHome 41 | 42 | set JAVA_EXE=java.exe 43 | %JAVA_EXE% -version >NUL 2>&1 44 | if %ERRORLEVEL% equ 0 goto execute 45 | 46 | echo. 47 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 48 | echo. 49 | echo Please set the JAVA_HOME variable in your environment to match the 50 | echo location of your Java installation. 51 | 52 | goto fail 53 | 54 | :findJavaFromJavaHome 55 | set JAVA_HOME=%JAVA_HOME:"=% 56 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 57 | 58 | if exist "%JAVA_EXE%" goto execute 59 | 60 | echo. 61 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 62 | echo. 63 | echo Please set the JAVA_HOME variable in your environment to match the 64 | echo location of your Java installation. 65 | 66 | goto fail 67 | 68 | :execute 69 | @rem Setup the command line 70 | 71 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 72 | 73 | 74 | @rem Execute Gradle 75 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 76 | 77 | :end 78 | @rem End local scope for the variables with windows NT shell 79 | if %ERRORLEVEL% equ 0 goto mainEnd 80 | 81 | :fail 82 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 83 | rem the _cmd.exe /c_ return code! 84 | set EXIT_CODE=%ERRORLEVEL% 85 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 86 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 87 | exit /b %EXIT_CODE% 88 | 89 | :mainEnd 90 | if "%OS%"=="Windows_NT" endlocal 91 | 92 | :omega 93 | -------------------------------------------------------------------------------- /src/main/java/me/fallenbreath/yamlang/YamlangConvertResourcesTask.java: -------------------------------------------------------------------------------- 1 | package me.fallenbreath.yamlang; 2 | 3 | import java.util.HashMap; 4 | import java.util.Map; 5 | import javax.inject.Inject; 6 | import org.gradle.api.DefaultTask; 7 | import org.gradle.api.file.DirectoryProperty; 8 | import org.gradle.api.file.FileSystemOperations; 9 | import org.gradle.api.file.FileTree; 10 | import org.gradle.api.provider.Property; 11 | import org.gradle.api.tasks.IgnoreEmptyDirectories; 12 | import org.gradle.api.tasks.Input; 13 | import org.gradle.api.tasks.InputDirectory; 14 | import org.gradle.api.tasks.Optional; 15 | import org.gradle.api.tasks.OutputDirectory; 16 | import org.gradle.api.tasks.PathSensitive; 17 | import org.gradle.api.tasks.PathSensitivity; 18 | import org.gradle.api.tasks.SkipWhenEmpty; 19 | import org.gradle.api.tasks.TaskAction; 20 | 21 | public abstract class YamlangConvertResourcesTask extends DefaultTask 22 | { 23 | private static final String YAML_PREFIX = ".yml"; 24 | private static final String JSON_PREFIX = ".json"; 25 | 26 | @Inject 27 | protected abstract FileSystemOperations getFileSystemOperations(); 28 | 29 | @InputDirectory @PathSensitive(PathSensitivity.NAME_ONLY) @SkipWhenEmpty @IgnoreEmptyDirectories 30 | public abstract DirectoryProperty getInputDirectory(); 31 | 32 | @OutputDirectory 33 | public abstract DirectoryProperty getOutputDirectory(); 34 | 35 | @Input @Optional 36 | public abstract Property getTargetFilePattern(); 37 | 38 | @Input @Optional 39 | public abstract Property getPreserveYaml(); 40 | 41 | @Input @Optional 42 | public abstract Property getCharset(); 43 | 44 | @Input @Optional 45 | public abstract Property getOwolibRichTranslations(); 46 | 47 | @TaskAction 48 | public void doConversion() 49 | { 50 | try 51 | { 52 | this.doConversionImpl(); 53 | } 54 | catch (Exception e) 55 | { 56 | this.getLogger().error("Failed to execute yaml-to-json conversion", e); 57 | throw e; 58 | } 59 | } 60 | 61 | private FileTree getYamlFileTree() { 62 | return this.getInputDirectory().getAsFileTree().matching(pattern -> pattern.include( 63 | this.getTargetFilePattern().getOrElse("*" + YAML_PREFIX) 64 | )); 65 | } 66 | 67 | private void doConversionImpl() 68 | { 69 | FileTree yamlFileTree = getYamlFileTree(); 70 | DirectoryProperty outputDir = this.getOutputDirectory(); 71 | 72 | boolean preserveYaml = this.getPreserveYaml().getOrElse(false); 73 | String charset = this.getCharset().getOrElse("UTF-8"); 74 | boolean owolibRichTranslations = this.getOwolibRichTranslations().getOrElse(false); 75 | 76 | this.getFileSystemOperations().copy(copySpec -> { 77 | Map properties = new HashMap<>(); 78 | properties.put("args", new Yamlang2JsonlangTransformer.Args(this.getLogger(), owolibRichTranslations)); 79 | 80 | copySpec.setFilteringCharset(charset); 81 | copySpec.from(yamlFileTree); 82 | copySpec.filter(properties, Yamlang2JsonlangTransformer.class); 83 | copySpec.rename(YamlangConvertResourcesTask::renameYaml2Json); 84 | copySpec.into(outputDir); 85 | }); 86 | if (!preserveYaml) 87 | { 88 | this.getFileSystemOperations().delete(deleteSpec -> deleteSpec.delete(yamlFileTree)); 89 | } 90 | } 91 | 92 | private static String renameYaml2Json(String fileName) 93 | { 94 | String baseName = fileName.substring(0, fileName.length() - YAML_PREFIX.length()); 95 | return baseName + JSON_PREFIX; 96 | } 97 | } 98 | -------------------------------------------------------------------------------- /src/main/java/me/fallenbreath/yamlang/Yamlang2JsonlangTransformer.java: -------------------------------------------------------------------------------- 1 | package me.fallenbreath.yamlang; 2 | 3 | import com.google.gson.Gson; 4 | import com.google.gson.GsonBuilder; 5 | import java.io.FilterReader; 6 | import java.io.Reader; 7 | import java.io.StringReader; 8 | import java.util.LinkedHashMap; 9 | import java.util.List; 10 | import java.util.Map; 11 | import java.util.Objects; 12 | import me.fallenbreath.yamlang.utils.IOUtils; 13 | import org.gradle.api.logging.Logger; 14 | import org.yaml.snakeyaml.Yaml; 15 | 16 | public class Yamlang2JsonlangTransformer extends FilterReader 17 | { 18 | public static class Args 19 | { 20 | public final Logger logger; 21 | public final boolean enableOwolibRichTranslations; 22 | 23 | public Args(Logger logger, boolean enableOwolibRichTranslations) 24 | { 25 | this.logger = logger; 26 | this.enableOwolibRichTranslations = enableOwolibRichTranslations; 27 | } 28 | } 29 | 30 | private final Reader originalReader; 31 | private Args args = null; 32 | 33 | public Yamlang2JsonlangTransformer(Reader reader) 34 | { 35 | super(reader); 36 | this.originalReader = reader; 37 | } 38 | 39 | // will be invoked in org.gradle.api.internal.file.copy.FilterChain#add 40 | @SuppressWarnings("unused") 41 | public void setArgs(Args args) 42 | { 43 | this.args = args; 44 | this.performTransformation(); 45 | } 46 | 47 | private void performTransformation() 48 | { 49 | if (this.in != this.originalReader) 50 | { 51 | return; // already transformed 52 | } 53 | Objects.requireNonNull(this.args); 54 | 55 | try 56 | { 57 | String input = IOUtils.readerToString(this.in); 58 | String transformed = this.yamlang2Jsonlang(input); 59 | this.in = new StringReader(transformed); 60 | } 61 | catch (Exception e) 62 | { 63 | this.args.logger.error("Transformation from yamlang to json failed"); 64 | throw new RuntimeException(e); 65 | } 66 | } 67 | 68 | private String yamlang2Jsonlang(String yamlString) 69 | { 70 | Map yamlMap = new Yaml().load(yamlString); 71 | Map result = new LinkedHashMap<>(); 72 | this.parseMap(result, yamlMap, ""); 73 | Gson gson = new GsonBuilder().setPrettyPrinting().disableHtmlEscaping().create(); 74 | return gson.toJson(result); 75 | } 76 | 77 | @SuppressWarnings("unchecked") 78 | private void parseMap(Map result, Map yamlMap, String prefix) 79 | { 80 | yamlMap.forEach((keyObj, value) -> { 81 | if (value == null) 82 | { 83 | return; 84 | } 85 | if (!(keyObj instanceof String)) 86 | { 87 | throw new IllegalArgumentException(String.format("Unexpected key type '%s' for key '%s' at path '%s'", keyObj.getClass(), keyObj, prefix)); 88 | } 89 | 90 | String key = (String)keyObj; 91 | String fullKey = prefix.isEmpty() ? key : (!key.equals(".") ? prefix + "." + key : prefix); 92 | if (value instanceof String) 93 | { 94 | // translation entry 95 | result.put(fullKey, value); 96 | } 97 | else if (value instanceof Map) 98 | { 99 | // nested translation map 100 | this.parseMap(result, (Map)value, fullKey); 101 | } 102 | else if (this.args.enableOwolibRichTranslations && value instanceof List) 103 | { 104 | // owo-lib rich translation, keep the list intact 105 | result.put(fullKey, value); 106 | } 107 | else 108 | { 109 | // unknown type 110 | throw new IllegalArgumentException(String.format("Unexpected value type '%s' for value '%s' on key '%s'", value.getClass(), value, fullKey)); 111 | } 112 | }); 113 | } 114 | } 115 | -------------------------------------------------------------------------------- /website/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Json - Yamlang Converter 7 | 8 | 9 | 10 | 11 | 65 | 66 | 67 |

68 | 69 | 70 | 71 |

Json - Yamlang Converter

72 |
73 |
74 |

Json Input

75 |
76 | 77 |
78 |
79 | 80 |
81 |
82 |
83 |

Yaml Input

84 |
85 | 86 |
87 |
88 | 89 |
90 |
91 |
92 |
93 |
94 | 95 | 96 | 97 | 98 | 99 | 100 | 218 | 219 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## yamlang 2 | 3 | [![JitPack](https://jitpack.io/v/Fallen-Breath/yamlang.svg)](https://jitpack.io/#Fallen-Breath/yamlang) 4 | [![Gradle Plugin Portal](https://img.shields.io/gradle-plugin-portal/v/me.fallenbreath.yamlang)](https://plugins.gradle.org/plugin/me.fallenbreath.yamlang) 5 | 6 | A gradle plugin to convert nestable yaml language file into plain json language file for Minecraft mods 7 | 8 | Here's an online tool website to convert your plain json language file to / from a nestable yaml language file: https://fallen-breath.github.io/yamlang/ 9 | 10 | ### What's nestable yaml format 11 | 12 | Here's a regular Minecraft language file in json format: 13 | 14 | ```json5 15 | // regular json language file (comment via json5 for showcase) 16 | { 17 | "mymod.message.foo": "Foo", 18 | "mymod.message.bar": "Bar", 19 | "mymod.baz": "Baz", 20 | "mymod.baz.oof": "OOF" 21 | } 22 | ``` 23 | 24 | Convert that into yaml directly and we get: 25 | 26 | ```yaml 27 | # yaml language file with plain structure like the regular json one 28 | mymod.message.foo: Foo 29 | mymod.message.bar: Bar 30 | mymod.baz: Baz 31 | mymod.baz.oof: OOF 32 | ``` 33 | 34 | Extract the common segments in the keys, and we have the nestable yaml format: 35 | 36 | ```yaml 37 | # nestable yaml language file 1 38 | mymod: 39 | message: 40 | foo: Foo 41 | bar: Bar 42 | baz: 43 | .: Baz 44 | oof: OOF 45 | ``` 46 | 47 | Since the format is nest-able, not must-nest, the following content is also accepted and equivalent: 48 | 49 | ```yaml 50 | # nestable yaml language file 2 51 | mymod: 52 | message.foo: Foo 53 | message: 54 | bar: Bar 55 | baz: Baz 56 | baz.oof: OOF 57 | ``` 58 | 59 | The equivalent key of the value in a nestable yaml language file is, all keys in the path from the root to the current value joining with `.`. 60 | The tailing `.` will be trimmed, so we can have a single `.` as the key 61 | 62 | Advantages of language file in nestable yaml format: 63 | 64 | - Yaml features: 65 | - More intuitive 66 | - Comment support 67 | - Multi-line string support 68 | - Nestable structures: 69 | - Shorter line in the translation file 70 | - Foldable in modern editors 71 | - Object reference equals to the actual translation key 72 | 73 | ### Yamlang plugin 74 | 75 | Sadly Minecraft only support loading language files written in json format, so we cannot simply throw a yaml file into our resources folder and make it work 76 | 77 | Of course, you can mod Minecraft hard enough and make it support yaml format and even nestable yaml format, but that requires lots of work, 78 | and you even need to bundle a yaml parsing library into your mod since Minecraft doesn't support yaml by default 79 | 80 | Now, it's time for the yamlang plugin to save the day! 81 | 82 | What the plugin does is very simple: it automatically converts your nestable yaml language files inside the resources folder into regular json language files on compilation, 83 | so you can write your language files in nestable yaml format and run your mod with language files in regular json format at the same time 84 | 85 | Since it does everything during the compilation, no extra burden is needed at runtime 86 | 87 | ### Usages 88 | 89 | #### 1. Apply 90 | 91 | Since version `1.3.0`, yamlang is available in the [gradle plugin portal](https://plugins.gradle.org/plugin/me.fallenbreath.yamlang), which means you can simply apply yamlang to your project in `build.gradle`: 92 | 93 | ```groovy 94 | // build.gradle 95 | plugins { 96 | id 'me.fallenbreath.yamlang' version '1.5.0' 97 | } 98 | ``` 99 | 100 | #### 2. Configure 101 | 102 | Basic configuration: 103 | 104 | ```groovy 105 | // build.gradle 106 | yamlang { 107 | targetSourceSets = [sourceSets.main] 108 | inputDir = 'assets/mymod/lang' 109 | } 110 | ``` 111 | 112 | Full configuration with all possible entries: 113 | 114 | ```groovy 115 | // build.gradle 116 | yamlang { 117 | // A list storing source sets where resources with your language files are 118 | // Usually the language files are inside your main source set 119 | targetSourceSets = [sourceSets.main] 120 | 121 | // The dir path related to the resources dir 122 | // There should be multiple "*.yml" language files inside 123 | inputDir = 'assets/mymod/lang' 124 | 125 | // The output path of converted json language file, related to the resources dir 126 | // When not set, it will use inputDir as the fallback value 127 | outputDir = 'assets/mymod/jsonlang' 128 | 129 | // The file name pattern of the language files in yaml 130 | // You can use it, if e.g. the yaml language files ends with ".yaml" instead of ".yml", 131 | // Default value: "*.yml" 132 | targetFilePattern = '*.yaml' 133 | 134 | // Should the original yaml language files be preserved after the conversion 135 | // Default value: false, which means those yaml language files will be deleted after the conversion 136 | preserveYaml = true 137 | 138 | // The file encoding of the language files 139 | // Given that Minecraft uses UTF-8 to load language files, it's generally advised to just keep the default value 140 | // Default value: "UTF-8" 141 | charset = 'UTF-8' 142 | 143 | // Enables OWO-LIB Rich Translations (https://docs.wispforest.io/owo/rich-translations) in the yaml translation files 144 | // This option preserves lists added to the language file 145 | // Default value: false, which means lists are not allowed 146 | owolibRichTranslations = false 147 | } 148 | ``` 149 | 150 | See also: class [me.fallenbreath.yamlang.YamlangExtension](src/main/java/me/fallenbreath/yamlang/YamlangExtension.java) 151 | 152 | #### 3. Done 153 | 154 | That's it, everything is done 155 | 156 | You can now write your language files in nestable yaml format freely, and the plugin will handle the rest 157 | 158 | #### Apply yamlang from JitPack 159 | 160 | > [!NOTE] 161 | > Debugging / Testing only 162 | 163 | If you need to apply yamlang from JitPack for purposes such as debugging, you need to first teach Gradle how to locate yamlang in JitPack: 164 | 165 | ```groovy 166 | // settings.gradle 167 | pluginManagement { 168 | repositories { 169 | maven { url 'https://jitpack.io' } 170 | } 171 | resolutionStrategy { 172 | eachPlugin { 173 | switch (requested.id.id) { 174 | case "me.fallenbreath.yamlang": { 175 | useModule("com.github.Fallen-Breath:yamlang:${requested.version}") 176 | break 177 | } 178 | } 179 | } 180 | } 181 | } 182 | ``` 183 | 184 | Now, you can apply the yamlang plugin to your project using the steps provided above 185 | 186 | ## What does the plugin do 187 | 188 | It creates tasks named `yamlangConvertResources` and append them to the end of the process resource tasks of the given source sets. In this task, it will: 189 | 190 | 1. Read yaml files in the given path, e.g. `en_us.yml` 191 | 2. Flatten the content into plain map without nesting structures (e.g. `Map` in java) 192 | 3. Write them into the json file, e.g. `en_us.json` 193 | 4. Delete the yaml files in the given path. They are useless now 194 | 195 | Basically, it converts the yaml language file into the Minecraft friendly json format language file when gradle compiles your mod, 196 | so the subsequent processes are impervious to the original format of the language files 197 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | # This is normally unused 84 | # shellcheck disable=SC2034 85 | APP_BASE_NAME=${0##*/} 86 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. 147 | # shellcheck disable=SC3045 148 | MAX_FD=$( ulimit -H -n ) || 149 | warn "Could not query maximum file descriptor limit" 150 | esac 151 | case $MAX_FD in #( 152 | '' | soft) :;; #( 153 | *) 154 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. 155 | # shellcheck disable=SC3045 156 | ulimit -n "$MAX_FD" || 157 | warn "Could not set maximum file descriptor limit to $MAX_FD" 158 | esac 159 | fi 160 | 161 | # Collect all arguments for the java command, stacking in reverse order: 162 | # * args from the command line 163 | # * the main class name 164 | # * -classpath 165 | # * -D...appname settings 166 | # * --module-path (only if needed) 167 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 168 | 169 | # For Cygwin or MSYS, switch paths to Windows format before running java 170 | if "$cygwin" || "$msys" ; then 171 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 172 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 173 | 174 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 175 | 176 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 177 | for arg do 178 | if 179 | case $arg in #( 180 | -*) false ;; # don't mess with options #( 181 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 182 | [ -e "$t" ] ;; #( 183 | *) false ;; 184 | esac 185 | then 186 | arg=$( cygpath --path --ignore --mixed "$arg" ) 187 | fi 188 | # Roll the args list around exactly as many times as the number of 189 | # args, so each arg winds up back in the position where it started, but 190 | # possibly modified. 191 | # 192 | # NB: a `for` loop captures its iteration list before it begins, so 193 | # changing the positional parameters here affects neither the number of 194 | # iterations, nor the values presented in `arg`. 195 | shift # remove old arg 196 | set -- "$@" "$arg" # push replacement arg 197 | done 198 | fi 199 | 200 | # Collect all arguments for the java command; 201 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 202 | # shell script including quotes and variable substitutions, so put them in 203 | # double quotes to make sure that they get re-expanded; and 204 | # * put everything else in single quotes, so that it's not re-expanded. 205 | 206 | set -- \ 207 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 208 | -classpath "$CLASSPATH" \ 209 | org.gradle.wrapper.GradleWrapperMain \ 210 | "$@" 211 | 212 | # Stop when "xargs" is not available. 213 | if ! command -v xargs >/dev/null 2>&1 214 | then 215 | die "xargs is not available" 216 | fi 217 | 218 | # Use "xargs" to parse quoted args. 219 | # 220 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 221 | # 222 | # In Bash we could simply go: 223 | # 224 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 225 | # set -- "${ARGS[@]}" "$@" 226 | # 227 | # but POSIX shell has neither arrays nor command substitution, so instead we 228 | # post-process each arg (as a line of input to sed) to backslash-escape any 229 | # character that might be a shell metacharacter, then use eval to reverse 230 | # that process (while maintaining the separation between arguments), and wrap 231 | # the whole thing up as a single "set" statement. 232 | # 233 | # This will of course break if any of these variables contains a newline or 234 | # an unmatched quote. 235 | # 236 | 237 | eval "set -- $( 238 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 239 | xargs -n1 | 240 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 241 | tr '\n' ' ' 242 | )" '"$@"' 243 | 244 | exec "$JAVACMD" "$@" 245 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------