update readme, build, and add licenses

.build/deploy.sh

@@ -3,7 +3,7 @@ IFS=$'\n\t'
 
 function cleanup {
 	    echo "🧹 Cleanup..."
-	        rm -f gradle.properties eliorona-sign.asc
+	        rm -f ~/.gradle/gradle.properties eliorona-sign.asc
 	}
 
 trap cleanup SIGINT SIGTERM ERR EXIT
@@ -15,13 +15,16 @@ echo "🔑 Decrypting files..."
 gpg --quiet --batch --yes --decrypt --passphrase="${GPG_SECRET}" \
 	    --output eliorona-sign.asc .build/eliorona-sign.asc.gpg
 
+mkdir ~/.gradle
+
 gpg --quiet --batch --yes --decrypt --passphrase="${GPG_SECRET}" \
-	    --output gradle.properties .build/gradle.properties.gpg
+	    --output ~/.gradle/gradle.properties .build/usrgradle.properties.gpg
 
 gpg --fast-import --no-tty --batch --yes eliorona-sign.asc
 
 echo "📦 Publishing..."
 
-./gradlew uploadArchives -Psign=true
+./gradlew build
+./gradlew uploadArchives -Psign
 
 echo "✅ Done!"

.github/workflows/publish.yml

@@ -1,8 +1,6 @@
-name: Publish to Bintray
+name: Publish to Maven Central
 
 on:
-  release:
-    types: [published]
   workflow_dispatch:
 
 jobs:

LICENSE

@@ -1,121 +1,21 @@
-Creative Commons Legal Code
-
-CC0 1.0 Universal
-
-    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
-    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
-    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
-    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
-    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
-    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
-    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
-    HEREUNDER.
-
-Statement of Purpose
-
-The laws of most jurisdictions throughout the world automatically confer
-exclusive Copyright and Related Rights (defined below) upon the creator
-and subsequent owner(s) (each and all, an "owner") of an original work of
-authorship and/or a database (each, a "Work").
-
-Certain owners wish to permanently relinquish those rights to a Work for
-the purpose of contributing to a commons of creative, cultural and
-scientific works ("Commons") that the public can reliably and without fear
-of later claims of infringement build upon, modify, incorporate in other
-works, reuse and redistribute as freely as possible in any form whatsoever
-and for any purposes, including without limitation commercial purposes.
-These owners may contribute to the Commons to promote the ideal of a free
-culture and the further production of creative, cultural and scientific
-works, or to gain reputation or greater distribution for their Work in
-part through the use and efforts of others.
-
-For these and/or other purposes and motivations, and without any
-expectation of additional consideration or compensation, the person
-associating CC0 with a Work (the "Affirmer"), to the extent that he or she
-is an owner of Copyright and Related Rights in the Work, voluntarily
-elects to apply CC0 to the Work and publicly distribute the Work under its
-terms, with knowledge of his or her Copyright and Related Rights in the
-Work and the meaning and intended legal effect of CC0 on those rights.
-
-1. Copyright and Related Rights. A Work made available under CC0 may be
-protected by copyright and related or neighboring rights ("Copyright and
-Related Rights"). Copyright and Related Rights include, but are not
-limited to, the following:
-
-  i. the right to reproduce, adapt, distribute, perform, display,
-     communicate, and translate a Work;
- ii. moral rights retained by the original author(s) and/or performer(s);
-iii. publicity and privacy rights pertaining to a person's image or
-     likeness depicted in a Work;
- iv. rights protecting against unfair competition in regards to a Work,
-     subject to the limitations in paragraph 4(a), below;
-  v. rights protecting the extraction, dissemination, use and reuse of data
-     in a Work;
- vi. database rights (such as those arising under Directive 96/9/EC of the
-     European Parliament and of the Council of 11 March 1996 on the legal
-     protection of databases, and under any national implementation
-     thereof, including any amended or successor version of such
-     directive); and
-vii. other similar, equivalent or corresponding rights throughout the
-     world based on applicable law or treaty, and any national
-     implementations thereof.
-
-2. Waiver. To the greatest extent permitted by, but not in contravention
-of, applicable law, Affirmer hereby overtly, fully, permanently,
-irrevocably and unconditionally waives, abandons, and surrenders all of
-Affirmer's Copyright and Related Rights and associated claims and causes
-of action, whether now known or unknown (including existing as well as
-future claims and causes of action), in the Work (i) in all territories
-worldwide, (ii) for the maximum duration provided by applicable law or
-treaty (including future time extensions), (iii) in any current or future
-medium and for any number of copies, and (iv) for any purpose whatsoever,
-including without limitation commercial, advertising or promotional
-purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
-member of the public at large and to the detriment of Affirmer's heirs and
-successors, fully intending that such Waiver shall not be subject to
-revocation, rescission, cancellation, termination, or any other legal or
-equitable action to disrupt the quiet enjoyment of the Work by the public
-as contemplated by Affirmer's express Statement of Purpose.
-
-3. Public License Fallback. Should any part of the Waiver for any reason
-be judged legally invalid or ineffective under applicable law, then the
-Waiver shall be preserved to the maximum extent permitted taking into
-account Affirmer's express Statement of Purpose. In addition, to the
-extent the Waiver is so judged Affirmer hereby grants to each affected
-person a royalty-free, non transferable, non sublicensable, non exclusive,
-irrevocable and unconditional license to exercise Affirmer's Copyright and
-Related Rights in the Work (i) in all territories worldwide, (ii) for the
-maximum duration provided by applicable law or treaty (including future
-time extensions), (iii) in any current or future medium and for any number
-of copies, and (iv) for any purpose whatsoever, including without
-limitation commercial, advertising or promotional purposes (the
-"License"). The License shall be deemed effective as of the date CC0 was
-applied by Affirmer to the Work. Should any part of the License for any
-reason be judged legally invalid or ineffective under applicable law, such
-partial invalidity or ineffectiveness shall not invalidate the remainder
-of the License, and in such case Affirmer hereby affirms that he or she
-will not (i) exercise any of his or her remaining Copyright and Related
-Rights in the Work or (ii) assert any associated claims and causes of
-action with respect to the Work, in either case contrary to Affirmer's
-express Statement of Purpose.
-
-4. Limitations and Disclaimers.
-
- a. No trademark or patent rights held by Affirmer are waived, abandoned,
-    surrendered, licensed or otherwise affected by this document.
- b. Affirmer offers the Work as-is and makes no representations or
-    warranties of any kind concerning the Work, express, implied,
-    statutory or otherwise, including without limitation warranties of
-    title, merchantability, fitness for a particular purpose, non
-    infringement, or the absence of latent or other defects, accuracy, or
-    the present or absence of errors, whether or not discoverable, all to
-    the greatest extent permissible under applicable law.
- c. Affirmer disclaims responsibility for clearing rights of other persons
-    that may apply to the Work or any use thereof, including without
-    limitation any person's Copyright and Related Rights in the Work.
-    Further, Affirmer disclaims responsibility for obtaining any necessary
-    consents, permissions or other rights required for any use of the
-    Work.
- d. Affirmer understands and acknowledges that Creative Commons is not a
-    party to this document and has no duty or obligation with respect to
-    this CC0 or use of the Work.
+MIT License
+
+Copyright (c) 2021 OroArmor (Eli Orona)
+
+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.

README.md

@@ -9,22 +9,45 @@ My goal in creating this library was to make an light-weight config library that
 ## How to include
 Include my library in your mod by adding it to your `build.gradle` file.
 
-Make sure my bintray repo is included in your repositiories section:
+Make sure maven central is included in your repositiories section:
 ```
 repositories {
-  maven {
-    url = "https://dl.bintray.com/oroarmor/oroarmor"
-  }
+  mavenCentral()
 }
 ```
-Then in your dependencies section add my library to the classpath and jar-in-jar it so that users dont have to download an extra file:
 
 The current version is: ![](https://img.shields.io/github/v/tag/oroarmor/oro-config.svg)
 
+### Fabric
+
+Then in your dependencies section add my library to the classpath and jar-in-jar it so that users don't have to download an extra file:
+
+```
+dependencies {	
+  modImplementation 'com.oroarmor:oro-config-fabric:${version}'
+  include 'com.oroarmor:oro-config-fabric:${version}'
+}
+```
+
+### Forge
+
+Then in your dependencies section add my library to the classpath and shadow it so that users don't have to download an extra file:
+
 ```
 dependencies {	
-  modImplementation 'com.oroarmor:oro-config:${version}'
-  include 'com.oroarmor:oro-config:${version}'
+  modImplementation 'com.oroarmor:oro-config-forge:${version}'
+  shadow 'com.oroarmor:oro-config-forge:${version}'
+}
+```
+
+### Outside of minecraft
+
+Then in your dependencies section add my library to the classpath and shadow it so that users don't have to download an extra file:
+
+```
+dependencies {	
+  modImplementation 'com.oroarmor:oro-config-common:${version}'
+  shadow 'com.oroarmor:oro-config-common:${version}'
 }
 ```
 
@@ -48,6 +71,8 @@ The details are a string representing a language key that can be used in your la
 
 The second constructor has an `onChange` parameter, which is a Consumer that is run every time this config is changed, which can be used to send data to clients on servers or trigger other events.
 
+You can get the value from a `ConfigItem` with the `get` method.
+
 ### Config Item Groups
 `ConfigItemGroup`s are a way to store multiple `ConfigItem`s into one group. `ConfigItemGroup`s can be nested in each other for sub groups. There is one constructor:
 ```java
@@ -68,11 +93,16 @@ Id is for the ID of the config which is used in commands and modmenu.
 ### Command
 `ConfigCommand` is a simple class that ust requires a `Config` in its constructor. It does not handle its own registering, and must be registered through Fabric API
 
+The command is currently broken for forge
+
 ### Cloth Config
 `ModMenuConfigScreen` is an abstract class that requires you to extend it, passing in your config into a super constructor. Because this is used as an entry point, your constructor ***must*** have no parameters.
 
+### Forge Config Screen
+Currently broken
+
 ### Example:
-These are pulled from the testmod, and are part of this repositiory. [Test Mod](https://github.com/OroArmor/oro-config/tree/master/src/testmod)
+These are pulled from the testmod, and are part of this repositiory. [Test Mod](https://github.com/OroArmor/oro-config/tree/master/fabric-testmod/src/main)
 
 Config Class:
 ```java
@@ -127,7 +157,7 @@ This then creates a config file called `oroarmor_config_testmod.json` in the `/c
 }
 ```
 
-Command Registration:
+Fabric Command Registration:
 ```java
 CommandRegistrationCallback.EVENT.register(new ConfigCommand(YOUR_CONFIG)::register);
 ```

build.gradle

@@ -2,6 +2,7 @@ plugins {
     id "java"
     id "architectury-plugin" version "3.0.93"
     id "forgified-fabric-loom" version "0.6.72" apply false
+    id 'org.cadixdev.licenser' version '0.5.0' apply false
 }
 
 architectury {
@@ -12,6 +13,7 @@ subprojects {
     apply plugin: "forgified-fabric-loom"
     apply plugin: "signing"
     apply plugin: "maven"
+    apply plugin: 'org.cadixdev.licenser'
 
     loom {
         useFabricMixin = true
@@ -22,6 +24,10 @@ subprojects {
         mappings "net.fabricmc:yarn:1.16.5+build.4"
     }
 
+    license {
+        header = rootProject.file("LICENSE")
+    }
+
     task sourceJar(type: Jar) {
         classifier "sources"
         from sourceSets.main.allSource
@@ -78,8 +84,8 @@ subprojects {
 
                     licenses {
                         license {
-                            name 'CC0 1.0'
-                            url 'https://creativecommons.org/publicdomain/zero/1.0/legalcode'
+                            name 'MIT'
+                            url 'https://mit-license.org/'
                         }
                     }
 

common/src/main/java/com/oroarmor/config/Config.java

@@ -1,3 +1,27 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2021 OroArmor (Eli Orona)
+ *
+ * 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.
+ */
+
 package com.oroarmor.config;
 
 import java.io.File;

common/src/main/java/com/oroarmor/config/ConfigItem.java

@@ -1,3 +1,27 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2021 OroArmor (Eli Orona)
+ *
+ * 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.
+ */
+
 package com.oroarmor.config;
 
 import java.util.Arrays;

common/src/main/java/com/oroarmor/config/ConfigItemGroup.java

@@ -1,3 +1,27 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2021 OroArmor (Eli Orona)
+ *
+ * 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.
+ */
+
 package com.oroarmor.config;
 
 import java.util.ArrayList;