From 98872aa94089ca02b285836d406362cf5fbe46dd Mon Sep 17 00:00:00 2001 From: swaggio <87071118+swaggio7@users.noreply.github.com> Date: Sat, 4 Feb 2023 12:10:20 +0300 Subject: [PATCH 1/8] YetAnotherREADMEUpdate I'm officially declaring myself a README enthusiast. Quick question, do I add the mod authors' names in the next README update? -Made SideQuest's Recommended text bold because it's the best way to install QuestCraft -Added Debugify and Memory Leak Fix -Added 2 ways to configure mods -Fixed some grammar --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 1cdf01c..f4eeb62 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ First off, you most likely want to install QuestCraft. If you would like to get **NOTE: In order to install QuestCraft, you must have an internet connection in order for the inital setup to succeed. Furthermore, you MUST own a legal, valid copy of Minecraft: Java Edition to play!** -First, you need to install the QuestCraft APK to your VR Headset using [SideQuest](https://sidequestvr.com) (Recommended, available on Windows, macOS, Linux, and Android) or with [QuestToolbox](https://github.com/mitchv2020/QuestToolbox) (Available on Windows, Auto Installer coming to QuestToolbox soon). +First, you need to install the QuestCraft APK to your VR Headset using [SideQuest](https://sidequestvr.com) (**Recommended**, available on Windows, macOS, Linux, and Android) or with [QuestToolbox](https://github.com/mitchv2020/QuestToolbox) (Available on Windows, Auto Installer coming to QuestToolbox soon). Next, open the QuestCraft launcher on your headset. Be sure to grant it all requested permissions. Once complete, follow the on-screen prompts to enter your Minecraft login details and wait for QuestCraft to download any remaining files. @@ -54,24 +54,32 @@ And boom! You have successfully installed QuestCraft on your VR headset! To play [Simple Voice Chat](https://modrinth.com/plugin/simple-voice-chat) (Adds proximity voice chat) -## Recommended mods +## Recommended Mods -QuestCraft is fairly slow by itself because minecraft is a very badly optimized game. QuestCraft already includes a couple of mods to enhance the performance, but here is a (not comprehensive) list of some more recommended mods: +QuestCraft is mildly slow by itself because minecraft is a very badly optimized game. QuestCraft already includes a couple of mods to enhance the performance, but here is a (not comprehensive) list of some more recommended mods to enhance the experience: -- [More Culling](https://modrinth.com/mod/moreculling) (Culls not just leaves, but loads of other things to improve performance. Getting [More Culling Extra](https://modrinth.com/mod/morecullingextra) will also add more culling features!) -- [Architectury API](https://modrinth.com/mod/architectury-api) (makes lots of mods available) +- [Architectury API](https://modrinth.com/mod/architectury-api) (Library for plenty of mods) +- [Debugify](https://modrinth.com/mod/debugify) (Fixes many Minecraft bugs) +- [Exordium](https://modrinth.com/mod/exordium) (Decrease GUI framerate to speed up world rendering) - [Indium](https://modrinth.com/mod/indium) (Uses the Fabric Rendering API to allow many mods to work with Sodium) (**NOTE: You must have the latest [Sodium](https://modrinth.com/mod/sodium) version in order for the mod to work, otherwise the game WILL crash.**) -- [Mod Menu](https://modrinth.com/mod/modmenu) (Adds a mod menu to see what mods and libraries are present, and if [YetAnotherConfigLib](https://modrinth.com/mod/yacl) is present, can customize mod settings) - [LambDynamicLights](https://modrinth.com/mod/lambdynamiclights) (Adds dynamic lights to light emitting blocks, making the lighting more realistic and better overall.) -- [Exordium](https://modrinth.com/mod/exordium) (Decrease GUI framerate to speed up world rendering) +- [Memory Leak Fix](https://modrinth.com/mod/memoryleakfix) (Fixes random memory leaks to reduce RAM usage) +- [More Culling](https://modrinth.com/mod/moreculling) (Culls not just leaves, but loads of other things to improve performance. Installing [More Culling Extra](https://modrinth.com/mod/morecullingextra) will also add more culling features!) **NOTE: When installing (supported) mods on your Quest, you may need to update a dependancy that's bundled in with QCXR (e.g. Fabric API, Sodium). However, this may lead to issues, ranging from unexpected behavior to crashes! If you experience any, please [file an issue](https://github.com/QuestCraftPlusPlus/QuestCraft/issues/new/choose).** At the moment, Iris and Canvas do not work. Distant Horizons support is planned, but may take a while. -## Some recommended Settings and Tips +## How to Configure Mods +1. You can use [Mod Menu](https://modrinth.com/mod/modmenu) and [YetAnotherConfigLib](https://modrinth.com/mod/yacl) +**or** +2. You can use [Configured](https://www.curseforge.com/minecraft/mc-mods/configured-fabric) and [Forge Config API Port](https://www.curseforge.com/minecraft/mc-mods/forge-config-api-port-fabric) (yes, that is not a mistype) + +Choose which one suits your install more. + +## Some Recommended Settings and Tips 1. In the options menu, go to VR Settings/Stereo Rendering and set the resolution (NOT CAMERA RES) to 80%. This will decrease the general quality, but will give an extra performance boost. 2. The game's render distance is best at 4. 5 works, but you may encounter lag spikes when using it. 6 and above, you are on your own. -3. Oceans contain LOTS of kelp that decrease framerate. Don't mine any of it all at once, as your game may CRASH if lots of entites (in this case, kelp waiting to be picked up) is exist at once. +3. Oceans contain LOTS of kelp that decrease framerate. Don't mine any of it all at once, as your game may CRASH if lots of entites (in this case, kelp waiting to be picked up) exist at once. 4. If any leave culling mod (e.g. [Cull Leaves](https://modrinth.com/mod/cull-leaves), [More Culling](https://modrinth.com/mod/moreculling)) is present, you can set the leaves quality to Fancy! 5. You are able to max out Biome Blend if you have QCXR 3.1 or later! 6. If [More Culling](https://modrinth.com/mod/moreculling) is present, go to the video settings and go to the More Culling tab. Set the leave culling type to Depth and enjoy a performance boost! From 48960805a731f94f04e0ff42c874ced9d095eec7 Mon Sep 17 00:00:00 2001 From: swaggio Date: Sat, 4 Feb 2023 18:37:46 +0300 Subject: [PATCH 2/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f4eeb62..3cd0b9c 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ At the moment, Iris and Canvas do not work. Distant Horizons support is planned, **or** 2. You can use [Configured](https://www.curseforge.com/minecraft/mc-mods/configured-fabric) and [Forge Config API Port](https://www.curseforge.com/minecraft/mc-mods/forge-config-api-port-fabric) (yes, that is not a mistype) -Choose which one suits your install more. +Choose which one suits your type more. ## Some Recommended Settings and Tips 1. In the options menu, go to VR Settings/Stereo Rendering and set the resolution (NOT CAMERA RES) to 80%. This will decrease the general quality, but will give an extra performance boost. From 1a059e069082f65887c4cd4914c4dab909c1647d Mon Sep 17 00:00:00 2001 From: swaggio Date: Sat, 4 Feb 2023 18:46:03 +0300 Subject: [PATCH 3/8] README Update No.19333786974 Made an oopsie because I realized that Configured is a dev tool, not a mod menu. --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 3cd0b9c..237ad8d 100644 --- a/README.md +++ b/README.md @@ -63,18 +63,13 @@ QuestCraft is mildly slow by itself because minecraft is a very badly optimized - [Exordium](https://modrinth.com/mod/exordium) (Decrease GUI framerate to speed up world rendering) - [Indium](https://modrinth.com/mod/indium) (Uses the Fabric Rendering API to allow many mods to work with Sodium) (**NOTE: You must have the latest [Sodium](https://modrinth.com/mod/sodium) version in order for the mod to work, otherwise the game WILL crash.**) - [LambDynamicLights](https://modrinth.com/mod/lambdynamiclights) (Adds dynamic lights to light emitting blocks, making the lighting more realistic and better overall.) +- [Mod Menu](https://modrinth.com/mod/modmenu) and [YetAnotherConfigLib](https://modrinth.com/mod/yacl) (Allows you to see and (with UACL) configure installed mods.) - [Memory Leak Fix](https://modrinth.com/mod/memoryleakfix) (Fixes random memory leaks to reduce RAM usage) - [More Culling](https://modrinth.com/mod/moreculling) (Culls not just leaves, but loads of other things to improve performance. Installing [More Culling Extra](https://modrinth.com/mod/morecullingextra) will also add more culling features!) **NOTE: When installing (supported) mods on your Quest, you may need to update a dependancy that's bundled in with QCXR (e.g. Fabric API, Sodium). However, this may lead to issues, ranging from unexpected behavior to crashes! If you experience any, please [file an issue](https://github.com/QuestCraftPlusPlus/QuestCraft/issues/new/choose).** -At the moment, Iris and Canvas do not work. Distant Horizons support is planned, but may take a while. - -## How to Configure Mods -1. You can use [Mod Menu](https://modrinth.com/mod/modmenu) and [YetAnotherConfigLib](https://modrinth.com/mod/yacl) -**or** -2. You can use [Configured](https://www.curseforge.com/minecraft/mc-mods/configured-fabric) and [Forge Config API Port](https://www.curseforge.com/minecraft/mc-mods/forge-config-api-port-fabric) (yes, that is not a mistype) - -Choose which one suits your type more. +At the moment, Iris and Canvas do not work. Distant Horizons support is planned, but may take a while. +*You can use [Mod Menu](https://modrinth.com/mod/modmenu) and [YetAnotherConfigLib](https://modrinth.com/mod/yacl) to see and configure what mods you have.* ## Some Recommended Settings and Tips 1. In the options menu, go to VR Settings/Stereo Rendering and set the resolution (NOT CAMERA RES) to 80%. This will decrease the general quality, but will give an extra performance boost. From 0fe82b68575cf4679a924d4c26d523ccb4f3bb2a Mon Sep 17 00:00:00 2001 From: swaggio Date: Sun, 5 Feb 2023 01:02:11 +0300 Subject: [PATCH 4/8] Final README Update (for now) Until 3.2 or some other massive major update rolls out, this will be the final commit I'll be making for a while. Changes list, top to bottom; -Removed QuestToolbox mention -Removed tips relying on external mods, as I feel like they belong to a starter guide rather than the README. -Capitalized some mentions of QuestCraft --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 237ad8d..7d00b7a 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ First off, you most likely want to install QuestCraft. If you would like to get **NOTE: In order to install QuestCraft, you must have an internet connection in order for the inital setup to succeed. Furthermore, you MUST own a legal, valid copy of Minecraft: Java Edition to play!** -First, you need to install the QuestCraft APK to your VR Headset using [SideQuest](https://sidequestvr.com) (**Recommended**, available on Windows, macOS, Linux, and Android) or with [QuestToolbox](https://github.com/mitchv2020/QuestToolbox) (Available on Windows, Auto Installer coming to QuestToolbox soon). +First, you need to install the QuestCraft APK to your VR Headset using [SideQuest](https://sidequestvr.com) and follow the necessary dteps to connect your Quest. Next, open the QuestCraft launcher on your headset. Be sure to grant it all requested permissions. Once complete, follow the on-screen prompts to enter your Minecraft login details and wait for QuestCraft to download any remaining files. @@ -75,16 +75,15 @@ At the moment, Iris and Canvas do not work. Distant Horizons support is planned, 1. In the options menu, go to VR Settings/Stereo Rendering and set the resolution (NOT CAMERA RES) to 80%. This will decrease the general quality, but will give an extra performance boost. 2. The game's render distance is best at 4. 5 works, but you may encounter lag spikes when using it. 6 and above, you are on your own. 3. Oceans contain LOTS of kelp that decrease framerate. Don't mine any of it all at once, as your game may CRASH if lots of entites (in this case, kelp waiting to be picked up) exist at once. -4. If any leave culling mod (e.g. [Cull Leaves](https://modrinth.com/mod/cull-leaves), [More Culling](https://modrinth.com/mod/moreculling)) is present, you can set the leaves quality to Fancy! -5. You are able to max out Biome Blend if you have QCXR 3.1 or later! -6. If [More Culling](https://modrinth.com/mod/moreculling) is present, go to the video settings and go to the More Culling tab. Set the leave culling type to Depth and enjoy a performance boost! +4. Skyblock and Oneblock worlds perform the best, as they require less hardware usage. +4. You are able to max out Biome Blend if you have QCXR 3.1 or later! # Notes - We do not exist on TikTok. No one from the dev team makes TikTok videos. - QuestCraft (QCXR) is developed and maintained by the QCXR team, we also contribute upstream to the open source tools that we used to make this a reality, make sure to check out [MCXR](https://github.com/mcxr-org/MCXR), the previous VR mod, now replaced with [VivecraftMod](https://github.com/ferriarnus/VivecraftMod) and [PojavLauncher](https://github.com/PojavLauncherTeam/PojavLauncher) (for Pojlib)! - All support questions should be asked inside of the QuestCraft Discord (discord.gg/questcraft) for the best experience. -- **questcraft.net is not maintained or owned by anyone on the questcraft team**, they could put malware on it at any time. Please do not download anything from or visit questcraft.net. **Our new website is located here at [QuestCraft](https://questcraft.org/). +- **questcraft.net is not maintained or owned by anyone on the QuestCraft team**, they could put malware on it at any time. Please do not download anything from or visit questcraft.net. **Our new website is located here at [QuestCraft](https://questcraft.org/)**. - Pico support isn't planned for time being. Until then, use Vivecraft PCVR. ## Controls From a052bc2ef423e7032fd833d1da750b0f7d9a73db Mon Sep 17 00:00:00 2001 From: swaggio Date: Sun, 5 Feb 2023 01:04:51 +0300 Subject: [PATCH 5/8] Final Final Update for README (for now) -Removed the unnecessary 2nd mention of Mod Menu and YACL --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 7d00b7a..1310a34 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,6 @@ QuestCraft is mildly slow by itself because minecraft is a very badly optimized **NOTE: When installing (supported) mods on your Quest, you may need to update a dependancy that's bundled in with QCXR (e.g. Fabric API, Sodium). However, this may lead to issues, ranging from unexpected behavior to crashes! If you experience any, please [file an issue](https://github.com/QuestCraftPlusPlus/QuestCraft/issues/new/choose).** At the moment, Iris and Canvas do not work. Distant Horizons support is planned, but may take a while. -*You can use [Mod Menu](https://modrinth.com/mod/modmenu) and [YetAnotherConfigLib](https://modrinth.com/mod/yacl) to see and configure what mods you have.* ## Some Recommended Settings and Tips 1. In the options menu, go to VR Settings/Stereo Rendering and set the resolution (NOT CAMERA RES) to 80%. This will decrease the general quality, but will give an extra performance boost. From e641e5dd2b1e2fd5832fd3da6d2b7c8f4cc38a5c Mon Sep 17 00:00:00 2001 From: swaggio Date: Sun, 5 Feb 2023 15:33:54 +0300 Subject: [PATCH 6/8] =?UTF-8?q?README=20Update=20No.=E2=88=9E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Just fixed the lists by reordering stuff because it wasn't in alphabetical order. --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1310a34..8365fb2 100644 --- a/README.md +++ b/README.md @@ -20,18 +20,18 @@ And boom! You have successfully installed QuestCraft on your VR headset! To play [Better Biome Blend](https://modrinth.com/mod/better-biome-blend) (Fixes and adds features to the Biome Blend setting) -[Concurrent Chunk Management Engine (C2ME)](https://modrinth.com/mod/c2me-fabric) (Improves chunk loading) - [Cloth Config](https://modrinth.com/mod/cloth-config) (Libary for config screens, e.g. Video Settings) + +[Concurrent Chunk Management Engine (C2ME)](https://modrinth.com/mod/c2me-fabric) (Improves chunk loading) [Entity Culling](https://modrinth.com/mod/entityculling) (Renders only visible blocks and entities, improving overall performance) [Fabric API](https://modrinth.com/mod/fabric-api) (API for Fabric. Essential to basically get any mod running.) -[Fastload](https://modrinth.com/mod/fastload) (Improves world load and prevents potential crashes) - [Ferrite Core](https://modrinth.com/mod/ferrite-core) (Decreases memory usage by doing technical stuff) +[Fastload](https://modrinth.com/mod/fastload) (Improves world load and prevents potential crashes) + [Immediately Fast](https://modrinth.com/mod/immediatelyfast) (Optimizes lots of things, making rendering more GPU efficient) [Krypton](https://modrinth.com/mod/krypton) (Slightly reduces memory usage on servers, lowers server CPU usage and server ticks) From 861d68cf23e951e12e256cc94a5b1fed318a2e13 Mon Sep 17 00:00:00 2001 From: swaggio Date: Sun, 5 Feb 2023 15:43:11 +0300 Subject: [PATCH 7/8] =?UTF-8?q?README=20Update=20No.=CE=A9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Why the hell can't I just edit changes in already existing commits? Why does it have to be separate? -Updated some mod descriptions -Fixed some spelling -Moved the NOTE to above the mod list --- README.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 8365fb2..43976d2 100644 --- a/README.md +++ b/README.md @@ -34,13 +34,13 @@ And boom! You have successfully installed QuestCraft on your VR headset! To play [Immediately Fast](https://modrinth.com/mod/immediatelyfast) (Optimizes lots of things, making rendering more GPU efficient) -[Krypton](https://modrinth.com/mod/krypton) (Slightly reduces memory usage on servers, lowers server CPU usage and server ticks) +[Krypton](https://modrinth.com/mod/krypton) (Slightly reduces memory usage on servers, decreases server CPU usage and server ticks) [LazyDFU](https://modrinth.com/mod/lazydfu) (Improves game boot time, by making DataFixerUpper do less stuff) [Lithium](https://modrinth.com/mod/lithium) (General purpose performance mod) -[MaLiLib](https://www.curseforge.com/minecraft/mc-mods/malilib) (Libary to make more mods work) +[MaLiLib](https://www.curseforge.com/minecraft/mc-mods/malilib) (Libary for some mods) [Smooth Boot](https://modrinth.com/mod/smoothboot-fabric) (Makes Minecraft loading smoother) @@ -56,18 +56,19 @@ And boom! You have successfully installed QuestCraft on your VR headset! To play ## Recommended Mods -QuestCraft is mildly slow by itself because minecraft is a very badly optimized game. QuestCraft already includes a couple of mods to enhance the performance, but here is a (not comprehensive) list of some more recommended mods to enhance the experience: +QuestCraft is mildly slow by itself because minecraft is a very badly optimized game. QuestCraft already includes a couple of mods to enhance the performance, but here is a (not comprehensive) list of some more recommended mods to enhance the experience: + +**NOTE: When installing (supported) mods on your Quest, you may need to update a dependancy that's bundled in with QCXR (Fabric API, Sodium, etc.). However, this may lead to issues, ranging from unexpected behavior to crashes! If you experience any, please [file an issue](https://github.com/QuestCraftPlusPlus/QuestCraft/issues/new/choose)!** - [Architectury API](https://modrinth.com/mod/architectury-api) (Library for plenty of mods) - [Debugify](https://modrinth.com/mod/debugify) (Fixes many Minecraft bugs) - [Exordium](https://modrinth.com/mod/exordium) (Decrease GUI framerate to speed up world rendering) - [Indium](https://modrinth.com/mod/indium) (Uses the Fabric Rendering API to allow many mods to work with Sodium) (**NOTE: You must have the latest [Sodium](https://modrinth.com/mod/sodium) version in order for the mod to work, otherwise the game WILL crash.**) -- [LambDynamicLights](https://modrinth.com/mod/lambdynamiclights) (Adds dynamic lights to light emitting blocks, making the lighting more realistic and better overall.) -- [Mod Menu](https://modrinth.com/mod/modmenu) and [YetAnotherConfigLib](https://modrinth.com/mod/yacl) (Allows you to see and (with UACL) configure installed mods.) +- [LambDynamicLights](https://modrinth.com/mod/lambdynamiclights) (Adds dynamic lights to light emitting blocks. Example, when holding a torch on your hand.) +- [Mod Menu](https://modrinth.com/mod/modmenu) and [YetAnotherConfigLib](https://modrinth.com/mod/yacl) (Allows you to see and (with YACL) configure installed mods.) - [Memory Leak Fix](https://modrinth.com/mod/memoryleakfix) (Fixes random memory leaks to reduce RAM usage) - [More Culling](https://modrinth.com/mod/moreculling) (Culls not just leaves, but loads of other things to improve performance. Installing [More Culling Extra](https://modrinth.com/mod/morecullingextra) will also add more culling features!) -**NOTE: When installing (supported) mods on your Quest, you may need to update a dependancy that's bundled in with QCXR (e.g. Fabric API, Sodium). However, this may lead to issues, ranging from unexpected behavior to crashes! If you experience any, please [file an issue](https://github.com/QuestCraftPlusPlus/QuestCraft/issues/new/choose).** At the moment, Iris and Canvas do not work. Distant Horizons support is planned, but may take a while. ## Some Recommended Settings and Tips From 61881ce0e793665566ab5e66bb3760dd255556fe Mon Sep 17 00:00:00 2001 From: swaggio Date: Sun, 5 Feb 2023 16:01:09 +0300 Subject: [PATCH 8/8] README Update No.??? AHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHHH -Fixed spelling of steps in the SideQuest part --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 43976d2..3e1fdd5 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ First off, you most likely want to install QuestCraft. If you would like to get **NOTE: In order to install QuestCraft, you must have an internet connection in order for the inital setup to succeed. Furthermore, you MUST own a legal, valid copy of Minecraft: Java Edition to play!** -First, you need to install the QuestCraft APK to your VR Headset using [SideQuest](https://sidequestvr.com) and follow the necessary dteps to connect your Quest. +First, you need to install the QuestCraft APK to your VR Headset using [SideQuest](https://sidequestvr.com) and follow the necessary steps to connect your Quest. Next, open the QuestCraft launcher on your headset. Be sure to grant it all requested permissions. Once complete, follow the on-screen prompts to enter your Minecraft login details and wait for QuestCraft to download any remaining files.