Skip to content
This repository has been archived by the owner on Mar 18, 2023. It is now read-only.

Commit

Permalink
update readme and increment version
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sorenon
Sorenon committed Dec 13, 2021
1 parent 2646faa commit a4a81c2
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 34 deletions.
54 changes: 25 additions & 29 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
![MCXR Logo Banner](https://user-images.githubusercontent.com/51373236/114272119-ad237800-9a0c-11eb-8786-6275555a594b.png)
A rudimentary XR mod for Minecraft using OpenXR and the fabric mod loader.


# ⚠ Caution
MCXR is in early pre-pre-alpha. We are not accepting PRs and issues will be ignored until the codebase has become semi-stable.
A VR mod for Minecraft using OpenXR and fabric.

# *Installation*
Installing the mod requires an understanding of programming in Java and managing natives. If you don't know what that means I recommend waiting until we start releasing alpha builds.
</br>
Once built an OpenXR loader needs to be put in the mods/ folder, windows binaries of which can be retrieved from [here](https://www.nuget.org/packages/OpenXR.Loader/)
Fetch the latest version of MCXR core and play from https://github.com/Sorenon/MCXR/releases and put them in the fabric mods folder.
<br/>
For an in game title screen also install and set up a compatible version of https://github.com/Sorenon/TitleWorlds

## *Related Links*
Join the Discord server [here.](https://discord.gg/fyBye2ptkS) <br/>
Expand All @@ -19,24 +15,24 @@ Alternatively, join the Subreddit [here.](https://www.reddit.com/r/MinecraftXR/)

| | [Official Minecraft VR](https://www.minecraft.net/en-us/vr)| [Vivecraft](http://www.vivecraft.org/)| [MCXR VR](https://github.com/Sorenon/MCXR) |
| --------------------------- | ------------------------------- | ----------------------------- | ---------------------------- |
| State | Released | Released | 🚧Pre-Alpha |
| Platform | Bedrock | Java | Java |
| Mod Support | Bedrock Add-Ons | Forge | Fabric |
| Performance | 🥇 | 🥉 | 🥈 (With Sodium) |
| Supported Devices | 👎 Only Oculus headsets and WMR | ✅OpenVR supported devices | ✅OpenXR supported devices |
| Pretty Shader Support | ⛔ | ✅Optifine | 🚧Canvas or Iris |
| Vanilla Compatibility | ✅ | ✅ | ✅ |
| Vr Addon Support | ⛔ | 🚧In development | 🚧In development |
| Thirdparty Mod Intergration | N/A | ⛔ | 🚧In development |
| Immersive UI | ⛔ | ⛔ | 🚧In development |
| Immersive Controls | ⛔ | ✅ | 🚧In development |
| Open Source | ⛔ | ✅ | ✅ |
| Versions | N/A | 1.7.10, and 1.10 through 1.16 | 1.17 |
| Linkless Quest Support | ✅ | 🚧[Heavily delayed](https://discord.com/invite/cRdBUaUzcx) | 🚧In development |
| Vr Multiplayer | ⛔ | ✅ | 🚧In development |
| Spigot Plugin | N/A | ✅ | ⛔ |
| Patch Method | N/A | Jar mod | Mixins |
| Sponsored by Facebook | Yes | No | No |
| Initial Release Year | 2016 | 2013 / 2016 | 2021 |
| Linux Support | ⛔ | ✅ | ✅ |
| Mac Support | ⛔ | ✅? | ⛔ |
| State | Released | Released | Beta |
| Platform | Bedrock | Java | Java |
| Mod Support | Bedrock Add-Ons | Forge | Fabric |
| Performance | 🥇 | 🥉 | 🥈 (With Sodium) |
| Supported Devices | 👎 Only Oculus headsets and WMR | ✅OpenVR supported devices | ✅OpenXR supported devices|
| Pretty Shader Support | ⛔ | ✅Optifine | ✅Iris or 🚧Canvas |
| Vanilla Server Compatibility| ✅ | ✅ | ✅ |
| Vr Addon Support | ⛔ | 🚧In development | 🚧In development |
| Thirdparty Mod Intergration | N/A | ⛔ | 🚧In development |
| Immersive UI | ⛔ | ⛔ | 🚧In development |
| Immersive Controls | ⛔ | ✅ | 🚧In development |
| Open Source | ⛔ | ✅ | ✅ |
| Versions | N/A | 1.7.10, and 1.10 through 1.17 | 1.18 |
| Linkless Quest Support | ⛔ | ⛔ | 🚧[In development](https://discord.gg/ppWG7DyJ)|
| Special VR player models in multiplayer| ⛔ | ✅ | 🚧In development |
| Spigot Plugin | N/A | ✅ | ⛔ |
| Patch Method | N/A | Jar mod | Mixins |
| Sponsored by ~~Facebook~~ 'Meta' | Yes | No | No |
| Initial Release Year | 2016 | 2013 / 2016 | 2021 |
| Linux Support | ⛔ | ✅ | ✅ |
| Mac Support | ⛔ | ✅? | ⛔ |
10 changes: 5 additions & 5 deletions gradle.properties
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ org.gradle.jvmargs=-Xmx1G

# Fabric Properties
# check these on https://fabricmc.net/use
minecraft_version=1.18
loader_version=0.12.6
minecraft_version=1.18.1
loader_version=0.12.11

# Mod Properties
core_version = 0.0.1
play_version = 0.0.1
core_version = 0.1.0
play_version = 0.1.0
maven_group = net.sorenon

# Dependencies
fabric_version=0.43.1+1.18
fabric_version=0.44.0+1.18
pehkui_version=2.5.3
joml_version=1.10.2

0 comments on commit a4a81c2

Please sign in to comment.