Base functions and first module (#1)

This is a working baseline

Reviewed-on: #1

LICENSE

@@ -1,121 +1,3 @@
-Creative Commons Legal Code
+MIT License
 
-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.
+# TODO: Add license

README.md

@@ -1,4 +1,6 @@
-# Fabric Example Mod
+# c0de's mod
+
+A collection of mods for minecraft
 
 ## Setup
 
@@ -6,4 +8,4 @@ For setup instructions please see the [fabric wiki page](https://fabricmc.net/wi
 
 ## License
 
-This template is available under the CC0 license. Feel free to learn from it and incorporate it in your own projects.
+This mod is released under the MIT license.

gradle.properties

@@ -9,9 +9,9 @@ org.gradle.parallel=true
 	loader_version=0.14.17
 
 # Mod Properties
-	mod_version = 1.0.0
-	maven_group = com.example
-	archives_base_name = fabric-example-mod
+	mod_version = 0.0.1
+	maven_group = dev.c0de
+	archives_base_name = minecraft-mod
 
 # Dependencies
 	fabric_version=0.75.3+1.19.4

src/main/java/dev/c0de/minecraft/client/KeybindManager.java

@@ -1,53 +0,0 @@
-package dev.c0de.minecraft.client;
-
-import net.minecraft.client.MinecraftClient;
-
-import java.util.HashMap;
-import java.util.List;
-import java.util.Optional;
-import java.util.TreeMap;
-
-public class KeybindManager {
-    private final HashMap<String, Boolean> states = new HashMap<>();
-    private final List<Module> modules;
-
-    public KeybindManager(List<Module> modules) {
-        this.modules = modules;
-    }
-
-    public void tick(MinecraftClient client) {
-        // Execute the onTick function of each module
-        modules.forEach(module -> module.onTick(this, client));
-
-        // Toggle the module state with keybind
-        modules.stream().filter(module -> module.getKey() != null).forEach(module -> {
-            if (module.getKey().wasPressed()) {
-                final String name = module.getClass().getName();
-                final boolean newState = states.get(name);
-
-                c0deFoxModClient.LOGGER.info(name);
-
-                states.put(name, !states.getOrDefault(name, false));
-    
-                module.setState(newState);
-                module.onToggle(this, client);
-            }
-        });
-    }
-
-    public boolean getState(Class<?> cls) {
-        return states.getOrDefault(cls.getName(), false);
-    }
-
-    public TreeMap<String, Boolean> getSortedStates() {
-        final TreeMap<String, Boolean> keyStates = new TreeMap<>();
-
-        states.forEach((key, value) -> {
-            final Optional<Module> foundModule = modules.stream().filter(module -> module.getClass().getName().equals(key)).findFirst();
-
-            foundModule.ifPresent(module -> keyStates.put(module.getKey().getTranslationKey(), value));
-        });
-
-        return keyStates;
-    }
-}

src/main/java/dev/c0de/minecraft/client/Module.java

@@ -2,18 +2,28 @@ package dev.c0de.minecraft.client;
 
 import net.minecraft.client.MinecraftClient;
 import net.minecraft.client.option.KeyBinding;
+import net.minecraft.client.util.InputUtil;
+
+import net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper;
 
 public abstract class Module {
 
     protected KeyBinding key;
     protected boolean state;
 
-    public void onTick(KeybindManager manager, MinecraftClient client) {
-
+    public void onTick(MinecraftClient client) {
     }
 
-    public void onToggle(KeybindManager manager, MinecraftClient client) {
+    public void onToggle(MinecraftClient client) {
+    }
 
+    public void registerKey(String translationKey, int glfw_key, String category) {
+        this.key = KeyBindingHelper.registerKeyBinding(new KeyBinding(
+            translationKey,
+            InputUtil.Type.KEYSYM,
+            glfw_key,
+            category
+        ));
     }
 
     public void setState(boolean state) {
@@ -21,10 +31,18 @@ public abstract class Module {
     }
 
     public KeyBinding getKey() {
-        return key;
+        return this.key;
+    }
+
+    public void toggleKey() {
+        if (this.key != null) {
+            if (this.key.wasPressed()) {
+                this.setState(!this.isState());
+            }
+        }
     }
 
     public boolean isState() {
-        return state;
+        return this.state;
     }
 }

src/main/java/dev/c0de/minecraft/client/c0deFoxModClient.java

@@ -12,17 +12,13 @@ import org.slf4j.LoggerFactory;
 
 import dev.c0de.minecraft.client.modules.Fullbright;
 
-import java.util.List;
-
 @Environment(EnvType.CLIENT)
 public class c0deFoxModClient implements ClientModInitializer {
     public static final Logger LOGGER = LoggerFactory.getLogger("c0defox");
 
     private static c0deFoxModClient self;
-    private static KeybindManager keybindManager;
 
-    // Load in modules as independent parts of the mod
-    private static List<Module> modules;
+    private static Module fullbright;
 
     @Override
     public void onInitializeClient() {
@@ -30,12 +26,7 @@ public class c0deFoxModClient implements ClientModInitializer {
 
         self = this;
 
-        // Add new modules here
-        modules = List.of(
-            new Fullbright()
-        );
-
-        keybindManager = new KeybindManager(modules);
+        fullbright = new Fullbright();
 
         LOGGER.info("Ready");
     }
@@ -44,13 +35,9 @@ public class c0deFoxModClient implements ClientModInitializer {
         return self;
     }
 
-    public static KeybindManager getKeybindManager() {
-        return keybindManager;
-    }
-
     // Called on every game tick
     public void tick(MinecraftClient client) {
-        keybindManager.tick(client);
+        fullbright.onTick(client);
     }
 
 }

src/main/java/dev/c0de/minecraft/client/modules/Fullbright.java

@@ -2,13 +2,7 @@ package dev.c0de.minecraft.client.modules;
 
 import dev.c0de.minecraft.c0deFoxMod;
 import dev.c0de.minecraft.client.Module;
-import dev.c0de.minecraft.client.c0deFoxModClient;
-import dev.c0de.minecraft.client.KeybindManager;
-
-import net.fabricmc.fabric.api.client.keybinding.v1.KeyBindingHelper;
 import net.minecraft.client.MinecraftClient;
-import net.minecraft.client.option.KeyBinding;
-import net.minecraft.client.util.InputUtil;
 import net.minecraft.text.Text;
 
 import org.lwjgl.glfw.GLFW;
@@ -16,30 +10,26 @@ import org.lwjgl.glfw.GLFW;
 public class Fullbright extends Module {
     double DEFAULT = 1.0;
 
-    public void FullBright() {
-        this.key = KeyBindingHelper.registerKeyBinding(new KeyBinding(
-                "key.c0defox.fullbright",
-                InputUtil.Type.KEYSYM,
-                GLFW.GLFW_KEY_B,
-                "category.c0defox.default"
-        ));
+    public Fullbright() {
+        this.registerKey("key.c0defox.fullbright", GLFW.GLFW_KEY_B, "key.categories.c0defox");
     }
 
     @Override
-    public void onTick(KeybindManager manager, MinecraftClient client) {
-        update(client, DEFAULT);
+    public void onTick(MinecraftClient client) {
+        this.toggleKey();
+
         if (this.isState()) {
-            c0deFoxModClient.LOGGER.warn("Active State");
-            update(client, c0deFoxMod.config.getConfig().FULLBRIGHT_GAMMA);
+            this.update(client, c0deFoxMod.config.getConfig().FULLBRIGHT_GAMMA);
+            return;
         }
+
+        this.update(client, DEFAULT);
     }
 
     private void update(MinecraftClient client, double value) {
         if (client == null) return;
         if (client.options.getGamma().getValue() == value) return;
 
-        c0deFoxModClient.LOGGER.warn("changing gamma");
-
         client.options.getGamma().setValue(value);
 
         if (client.player != null) client.player.sendMessage(Text.of(String.valueOf(value)), true);

src/main/resources/assets/c0defox/lang/en_us.json

@@ -1,4 +1,4 @@
 {
-    "category.c0defox.default": "c0de's mods",
+    "key.categories.c0defox": "c0de's mods",
     "key.c0defox.fullbright": "Fullbright"
 }

src/main/resources/fabric.mod.json

@@ -32,7 +32,7 @@
   "depends": {
     "fabricloader": ">=0.14.17",
     "fabric-api": "*",
-    "minecraft": "~1.19.4",
+    "minecraft": ">=1.19.4",
     "java": ">=17"
   },
   "suggests": {