Merge pull request #471 from swaggio7/future-proof

CADIndie · web-flow · commit dd7a2161d0ef · 2023-04-02T15:25:16.000-04:00
Future Proofing for the next update
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,6 +1,6 @@
 ---
-name: Feature request
-about: Suggest an idea for this project
+name: Feature Suggestion
+about: Suggest an idea for QuestCraft!
 title: "[FEATURE]"
 labels: feature
 assignees: CADIndie, gusbunce, ManiacGamer156
@@ -16,5 +16,8 @@ A clear and concise description of what you want to happen.
 **Describe alternatives you've considered**
 A clear and concise description of any alternative solutions or features you've considered.
 
-**Additional context**
-Add any other context or screenshots about the feature request here.
+**Additional Context**
+Adding more context and/or screenshots is useful to us!
+
+**QuestCraft Version**
+(3.0.1,3.1..)
diff --git a/QCSimple3.jpg b/QCSimple3.jpg
diff --git a/README.md b/README.md
@@ -1,91 +1,98 @@
 # Welcome to the QuestCraft GitHub!
-[Support us on Patreon!](https://patreon.com/QuestCraftXR)
+### **[Support us on Patreon!](https://patreon.com/QuestCraftXR)**
 
-First off, you most likely want to install QuestCraft. If you would like to get going instantly then please go to the release page for [QuestCraft](https://github.com/QuestCraftPlusPlus/QuestCraft/releases/latest) and download the APK to your computer or mobile device.
-
-### We are partnered with BisectHosting! Support us by going to their [website](https://bisecthosting.com/xrcraft) and using code "xrcraft" at checkout to get 25% off of any server over 3GB.
+### We are partnered with BisectHosting! Support us by going to their **[website](https://bisecthosting.com/xrcraft)** and using code "xrcraft" at checkout to get 25% off of any server over 3GB.
 
 ![sponsor image](/partnerimage.png)
-# Installation Instructions
-
-**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!**
+# QuestCraft
+![QC](/QCSimple3.jpg)
 
-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. 
+QuestCraft, utilizing Vivecraft and Pojlib, is a standalone port of Minecraft: Java Edition to Oculus Quest Headsets. With a team of four main developers and 8 third party developers, over the past year we have not only gotten the bestselling game, Minecraft: Java Edition running on Android, but we have also worked with third-party developers to bring it into Virtual Reality on the Oculus Quest line of standalone HMDs.
 
-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.
+# Features
+- ### **Roomscale Minecraft VR!** 
+- ### **Quest and Queat 2 Native!**
+- ### **Full Multiplayer in VR!**                                                                    
+- ### **Immersive Controls through Vivecraft, Like Punching Blocks!**                                                                                                   
+- ### **Supports 1.19.3 both 1.18.2!**                                                                                                                                 
+- ### **Includes a Unity and Pojlib-built *launcher* that allows you to start QuestCraft, switch between versions and renderers, and use Mod Manager, a tool to download and install supported mods right from your Quest!!**
 
-And boom! You have successfully installed QuestCraft on your VR headset! To play, simply press the **Play** button and wait for it to load, it might take a while depending on headset age and model.
+# Installation Instructions
 
-## Included Mods (Performance is key!) 
+**NOTE: In order to install QuestCraft, you must have an internet connection in order for the initial setup to succeed. Furthermore, you MUST own a legal, valid copy of Minecraft: Java Edition to play!**
 
-[Better Biome Blend](https://modrinth.com/mod/better-biome-blend) (Fixes and adds features to the Biome Blend setting)                                                                                                                           
+First off, you most likely want to install QuestCraft. Please go to the release page for **[QuestCraft](https://github.com/QuestCraftPlusPlus/QuestCraft/releases/latest)** and download the APK to your computer or Android device.
 
-[Cloth Config](https://modrinth.com/mod/cloth-config) (Libary for config screens, e.g. Video Settings)
+Secondly, 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. Drag and drop the APK, and wait for it to install.
 
-[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)
+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 (seen in the bottom-right).
 
-[Fabric API](https://modrinth.com/mod/fabric-api) (API for Fabric. Essential to basically get any mod running.)
+And boom! You have successfully installed QuestCraft on your VR headset! To play, simply press the **Play** button and wait for it to load, it might take a while depending on headset age and model.
 
-[Ferrite Core](https://modrinth.com/mod/ferrite-core) (Decreases memory usage by doing technical stuff)
+## Supported Renderers (Take note when installing mods!)
+### **We have a [list](https://docs.google.com/spreadsheets/d/12yUTO_HgAEyZFoETxmzqaxPZrOUF1ocaQjbi_u5U2jI/edit?usp=sharing) that contains supported mods that are not in the ModManager! You can also add to this list with this [form](https://forms.gle/TRU7NN4YdgR4oDeW9)!**
+These are renderers that you can toggle on anytime. Each of them comes with their own benefits. **Note that GL4ES and Zink already have performance mods installed. (see [the mod list.)](https://docs.google.com/spreadsheets/d/12yUTO_HgAEyZFoETxmzqaxPZrOUF1ocaQjbi_u5U2jI/edit?usp=sharing)**
+- ### GL4ES
+GL4ES (**[OpenGL ES](https://www.khronos.org/opengles/#)**) has moderate speed, with moderate mod compatibility. Complex mods like Distant Horizons and Immersive Portals may not work.
+- ### Zink
+**[Zink](https://docs.mesa3d.org/drivers/zink.html)**, while being primarily slow, has great mod compatibility. Complex mods like Distant Horizons and Immersive Portals should work.
+- ### Vulkan
+**[Vulkan](https://www.vulkan.org/)**, while being very fast, has low mod compatibility. Complex mods like Distant Horizons and Immersive Portals should work.
 
-[Fastload](https://modrinth.com/mod/fastload) (Improves world load and prevents potential crashes)
+## Included Mods (For GL4ES and Zink)
 
-[Immediately Fast](https://modrinth.com/mod/immediatelyfast) (Optimizes lots of things, making rendering more GPU efficient)
+- **[Better Biome Blend](https://modrinth.com/mod/better-biome-blend)** (Fixes and adds features to the Biome Blend setting)                                                                                                                           
 
-[Krypton](https://modrinth.com/mod/krypton) (Slightly reduces memory usage on servers, decreases server CPU usage and server ticks)
+- **[Cloth Config](https://modrinth.com/mod/cloth-config)** (Libary for config screens, e.g. Video Settings)
 
-[LazyDFU](https://modrinth.com/mod/lazydfu) (Improves game boot time, by making DataFixerUpper do less stuff)
+- **[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)
 
-[Lithium](https://modrinth.com/mod/lithium) (General purpose performance mod)
+- **[Fabric API](https://modrinth.com/mod/fabric-api)** (API for Fabric. Essential to basically get any mod running.)
 
-[MaLiLib](https://www.curseforge.com/minecraft/mc-mods/malilib) (Libary for some mods)
+- **[Ferrite Core](https://modrinth.com/mod/ferrite-core)** (Decreases memory usage by doing technical stuff)
 
-[Smooth Boot](https://modrinth.com/mod/smoothboot-fabric) (Makes Minecraft loading smoother)
+- **[Fastload](https://modrinth.com/mod/fastload)** (Improves world load and prevents potential crashes)
 
-[Sodium](https://modrinth.com/mod/sodium) (Improves FPS and fixes graphical issues)
+- **[Immediately Fast](https://modrinth.com/mod/immediatelyfast)** (Optimizes lots of things, making rendering more GPU efficient)
 
-[Starlight](https://modrinth.com/mod/starlight) (Improves the lighting engine)
+- **[Krypton](https://modrinth.com/mod/krypton)** (Slightly reduces memory usage on servers, decreases server CPU usage and server ticks)
 
-[Tweakeroo](https://www.curseforge.com/minecraft/mc-mods/tweakeroo) (Big QOL mod that changes alot of things)
+- **[LazyDFU](https://modrinth.com/mod/lazydfu)** (Improves game boot time, by making DataFixerUpper do less stuff)
 
-[VivecraftMod](https://github.com/ferriarnus/VivecraftMod) (Port of Vivecraft to run on Fabric)
+- **[Lithium](https://modrinth.com/mod/lithium)** (General purpose performance mod)
 
-[Simple Voice Chat](https://modrinth.com/plugin/simple-voice-chat) (Adds proximity voice chat)
+- **[MaLiLib](https://www.curseforge.com/minecraft/mc-mods/malilib)** (Libary for some mods)
 
-## Recommended Mods
+- **[Smooth Boot](https://modrinth.com/mod/smoothboot-fabric)** (Makes Minecraft loading smoother)
 
-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:                                             
+- **[Sodium](https://modrinth.com/mod/sodium)** (Improves FPS and fixes graphical issues)
 
-**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)!**
+- **[Starlight](https://modrinth.com/mod/starlight)** (Improves the lighting engine)
 
-- [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. 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!)
+- **[Tweakeroo](https://www.curseforge.com/minecraft/mc-mods/tweakeroo)** (Big QOL mod that changes alot of things)
 
-At the moment, Iris and Canvas do not work. Distant Horizons support is planned, but may take a while.                                                   
+- **[VivecraftMod](https://github.com/ferriarnus/VivecraftMod)** (Port of Vivecraft to run on Fabric)
 
-## 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) exist at once.
-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!
+- **[Simple Voice Chat](https://modrinth.com/plugin/simple-voice-chat)** (Adds proximity voice chat)
 
+**Iris and shaders in general are not yet available in QC. Installing any will crash the game!**
 
+## Some Recommended Settings and Tips (For Zink and GL4ES)
+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-6, but you *may* encounter lag spikes when using it. 9 and above is not recommended.
+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 entities (in this case, kelp waiting to be picked up) exist at once.
+4. [Skyblock](https://minecraft.fandom.com/wiki/Tutorials/Skyblock) and [Oneblock](https://www.curseforge.com/minecraft/worlds/oneblock) worlds perform the best, as they require less hardware usage.
 # 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)! 
-- The repo's we use is [Pojlib](https://github.com/questcraftplusplus/pojlib) and [VivecraftModQCXR](https://github.com/questcraftplusplus/vivecraftmod)
+- 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)**, **[PojavLauncher](https://github.com/PojavLauncherTeam/PojavLauncher)** (for Pojlib!), and **[VulkanMod](https://github.com/xCollateral/VulkanMod)** for Vulkan support!
+- The forks we use are **[Pojlib](https://github.com/questcraftplusplus/pojlib)**, **[VivecraftMod](https://github.com/questcraftplusplus/vivecraftmod)**, and **[VulkanMod](https://github.com/QuestCraftPlusPlus/VulkanMod).** 
 - 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/)**. 
-- Pico support isn't planned for time being. Until then, use Vivecraft PCVR.
+- Pico (or any other device) support isn't planned for time being. Until then, use **[Vivecraft PCVR](https://www.vivecraft.org/)**.
+- When installing mods that are not from Mod Manager on your Quest, you may face issues, ranging from unexpected behavior to crashes! If you experience any, please **[file an issue](https://github.com/QuestCraftPlusPlus/QuestCraft/issues/new/choose)**!
+
 ## Controls
 
 ![There's supposed to be controls here](/Control.png)
