From b17bc90239296cbf35edfbdfbfaeaad255556bf3 Mon Sep 17 00:00:00 2001 From: Richy-Z <64844585+Richy-Z@users.noreply.github.com> Date: Wed, 15 May 2024 18:56:22 +0100 Subject: [PATCH] Add mod installation instructions --- README-modrinth.md | 6 ++++++ README.md | 6 ++++++ releasetemplate.md | 18 ++++++++++++++++++ 3 files changed, 30 insertions(+) create mode 100644 releasetemplate.md diff --git a/README-modrinth.md b/README-modrinth.md index e4ec0bf..6787a43 100644 --- a/README-modrinth.md +++ b/README-modrinth.md @@ -16,6 +16,12 @@ For a more detailed description of what this does, please visit the [GitHub repo ## ⚙️ How does it work? ThreatenGL works its magic by tinkering with Minecraft's internals. By injecting some code into the game's graphics setup process, it convinces Minecraft to opt for OpenGL 4.6 instead of the old 3.2. This simple tweak has the *potential* to make a difference in how the game performs. +## 📥 Installing the Mod (Please read if you're using Quilt or Forge) +- If you are using Quilt, you will have to [install the Quilted Fabric API (QFAPI)](https://modrinth.com/mod/qsl). +- If you are using Forge, you will have to [install the Architectury API for Forge](https://modrinth.com/mod/architectury-api). + +Fabric and NeoForge work without any additional dependencies! + ## ❗Notes ThreatenGL has been thoroughly tested to ensure it doesn't explore your device. However, please keep in mind that this is still an experiment and the efficacy of this mod is being actively researched and discussed. While many users have seen positive results, **your** results may vary depending on your setup. diff --git a/README.md b/README.md index 1fa4afa..51755fe 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,12 @@ This injected code intercepts the `glfwWindowHint` method of the GLFW library us When the `glfwWindowHint` method is called by Minecraft, this mod checks whether the OpenGL version is being set. If so, then we manually override this version to be set to 4.6. +## 📥 Installing the Mod (Please read if you're using Quilt or Forge) +- If you are using Quilt, you will have to [install the Quilted Fabric API (QFAPI)](https://modrinth.com/mod/qsl). +- If you are using Forge, you will have to [install the Architectury API for Forge](https://modrinth.com/mod/architectury-api). + +Fabric and NeoForge work without any additional dependencies! + ## ❗Notes This mod has undergone extensive testing to ensure that it is stable and won't explode your device. There are no issues so far, however, it is important to note that this is an experiment, as we are threatening Minecraft to use an OpenGL version that it is clearly not meant to run. ~~Mojang has their reasons for still using OpenGL 3.2, even in Minecraft 1.21 in 2024, but I don't really agree with them (mainly because I'm unaffected by the lack of backwards compatibility with newer OpenGL versions)~~ diff --git a/releasetemplate.md b/releasetemplate.md new file mode 100644 index 0000000..d4d4b47 --- /dev/null +++ b/releasetemplate.md @@ -0,0 +1,18 @@ +# 📜 ThreatenGL x.y.z (Beta w) +- Fixed a small issue where a dependency version higher than the maximum supported version was being requested on some mod loaders. ( https://github.com/Numelon-Softworks/ThreatenGL/issues/4 ) +![image](https://github.com/Numelon-Softworks/ThreatenGL/assets/64844585/db63625d-5ccf-4d8b-ad3b-3e133b3f5823) + +- The mod is now properly working on Minecraft 1.17.1 and up. + +Thanks to those who reported these issues on GitHub and Discord. + +---------- + +## 📥 Installing the Mod (Please read if you're using Quilt or Forge) +- If you are using Quilt, you will have to [install the Quilted Fabric API (QFAPI)](https://modrinth.com/mod/qsl). +- If you are using Forge, you will have to [install the Architectury API for Forge](https://modrinth.com/mod/architectury-api). + +Fabric and NeoForge work without any additional dependencies! + +#### 🤫 psst.. something new might be coming soon +New features for ThreatenGL are being actively worked on. [Join the Discord](https://discord.gg/3eWzyjWWJc) to receive sneak peeks and interact with the vibrant community! 😊 \ No newline at end of file