Skip to content

Commit 397b3c8

Browse files
authored
Merge pull request #453 from swaggio7/main
YetAnotherREADMEUpdate
2 parents f9d24b7 + 61881ce commit 397b3c8

1 file changed

Lines changed: 24 additions & 22 deletions

File tree

README.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ First off, you most likely want to install QuestCraft. If you would like to get
1010

1111
**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!**
1212

13-
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).
13+
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.
1414

1515
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.
1616

@@ -20,27 +20,27 @@ And boom! You have successfully installed QuestCraft on your VR headset! To play
2020

2121
[Better Biome Blend](https://modrinth.com/mod/better-biome-blend) (Fixes and adds features to the Biome Blend setting)
2222

23-
[Concurrent Chunk Management Engine (C2ME)](https://modrinth.com/mod/c2me-fabric) (Improves chunk loading)
24-
2523
[Cloth Config](https://modrinth.com/mod/cloth-config) (Libary for config screens, e.g. Video Settings)
24+
25+
[Concurrent Chunk Management Engine (C2ME)](https://modrinth.com/mod/c2me-fabric) (Improves chunk loading)
2626

2727
[Entity Culling](https://modrinth.com/mod/entityculling) (Renders only visible blocks and entities, improving overall performance)
2828

2929
[Fabric API](https://modrinth.com/mod/fabric-api) (API for Fabric. Essential to basically get any mod running.)
3030

31-
[Fastload](https://modrinth.com/mod/fastload) (Improves world load and prevents potential crashes)
32-
3331
[Ferrite Core](https://modrinth.com/mod/ferrite-core) (Decreases memory usage by doing technical stuff)
3432

33+
[Fastload](https://modrinth.com/mod/fastload) (Improves world load and prevents potential crashes)
34+
3535
[Immediately Fast](https://modrinth.com/mod/immediatelyfast) (Optimizes lots of things, making rendering more GPU efficient)
3636

37-
[Krypton](https://modrinth.com/mod/krypton) (Slightly reduces memory usage on servers, lowers server CPU usage and server ticks)
37+
[Krypton](https://modrinth.com/mod/krypton) (Slightly reduces memory usage on servers, decreases server CPU usage and server ticks)
3838

3939
[LazyDFU](https://modrinth.com/mod/lazydfu) (Improves game boot time, by making DataFixerUpper do less stuff)
4040

4141
[Lithium](https://modrinth.com/mod/lithium) (General purpose performance mod)
4242

43-
[MaLiLib](https://www.curseforge.com/minecraft/mc-mods/malilib) (Libary to make more mods work)
43+
[MaLiLib](https://www.curseforge.com/minecraft/mc-mods/malilib) (Libary for some mods)
4444

4545
[Smooth Boot](https://modrinth.com/mod/smoothboot-fabric) (Makes Minecraft loading smoother)
4646

@@ -54,34 +54,36 @@ And boom! You have successfully installed QuestCraft on your VR headset! To play
5454

5555
[Simple Voice Chat](https://modrinth.com/plugin/simple-voice-chat) (Adds proximity voice chat)
5656

57-
## Recommended mods
57+
## Recommended Mods
5858

59-
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:
59+
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:
6060

61-
- [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!)
62-
- [Architectury API](https://modrinth.com/mod/architectury-api) (makes lots of mods available)
63-
- [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.**)
64-
- [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)
65-
- [LambDynamicLights](https://modrinth.com/mod/lambdynamiclights) (Adds dynamic lights to light emitting blocks, making the lighting more realistic and better overall.)
61+
**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)!**
62+
63+
- [Architectury API](https://modrinth.com/mod/architectury-api) (Library for plenty of mods)
64+
- [Debugify](https://modrinth.com/mod/debugify) (Fixes many Minecraft bugs)
6665
- [Exordium](https://modrinth.com/mod/exordium) (Decrease GUI framerate to speed up world rendering)
66+
- [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.**)
67+
- [LambDynamicLights](https://modrinth.com/mod/lambdynamiclights) (Adds dynamic lights to light emitting blocks. Example, when holding a torch on your hand.)
68+
- [Mod Menu](https://modrinth.com/mod/modmenu) and [YetAnotherConfigLib](https://modrinth.com/mod/yacl) (Allows you to see and (with YACL) configure installed mods.)
69+
- [Memory Leak Fix](https://modrinth.com/mod/memoryleakfix) (Fixes random memory leaks to reduce RAM usage)
70+
- [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!)
6771

68-
**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).**
69-
At the moment, Iris and Canvas do not work. Distant Horizons support is planned, but may take a while.
72+
At the moment, Iris and Canvas do not work. Distant Horizons support is planned, but may take a while.
7073

71-
## Some recommended Settings and Tips
74+
## Some Recommended Settings and Tips
7275
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.
7376
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.
74-
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.
75-
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!
76-
5. You are able to max out Biome Blend if you have QCXR 3.1 or later!
77-
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!
77+
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.
78+
4. Skyblock and Oneblock worlds perform the best, as they require less hardware usage.
79+
4. You are able to max out Biome Blend if you have QCXR 3.1 or later!
7880

7981

8082
# Notes
8183
- We do not exist on TikTok. No one from the dev team makes TikTok videos.
8284
- 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)!
8385
- All support questions should be asked inside of the QuestCraft Discord (discord.gg/questcraft) for the best experience.
84-
- **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/).
86+
- **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/)**.
8587
- Pico support isn't planned for time being. Until then, use Vivecraft PCVR.
8688
## Controls
8789

0 commit comments

Comments
 (0)