From f10818ec6b98e667c29054fa2731932f0bdd98ab Mon Sep 17 00:00:00 2001 From: Merith Date: Wed, 13 Oct 2021 19:31:43 +0000 Subject: [PATCH] update readme --- README.md | 74 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 39 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index 8a705d2e..163334a1 100644 --- a/README.md +++ b/README.md @@ -16,56 +16,60 @@ This mod includes textures that are more in-line with the style of Mojang's new CC: Restitched [3prm3/cc-pack](https://github.com/3prm3/cc-pack/) We also have a second resourcepack made by [3prm3](https://github.com/3prm3), it features a complete overhaul and can be enabled by enabling the `overhaul` resource pack, go check out his resource pack over here! -# Conflicts -Currently Iris and Canvas Shaders are Incompatible with this mod, - - Iris has transparent monitors, and when a computer displays something on the monitor, the face becomes black. - - Canvas... uhm... - - Computer Terminals are 100% unusable and scuffed - - - Monitors break with either rendering option. - - TBO - - Just crashes on world load. - - VBO - +# Does this work with shaders/sodium? +* [ YES ] Sodium +* [ YES ] Optifine + * Works with VBO Rendering (automatically set) + * No issues +* [ EHH ] Iris Shaders + * "Works" with TBO Rendering (Default) + * Crashes with VBO Rendering + *
+ Shaders are broken + + * Shaders will cause varrying results ranging from monitors being invisible, to straight up crashing. + * Not using shaders will result in odd Z-Fighting of the monitor display and the transparent texture + - ![](https://user-images.githubusercontent.com/10422110/136869483-91824c5f-841f-4316-bfb1-2412477a29ee.png) + - ![](https://user-images.githubusercontent.com/10422110/136869535-a16581a3-5e0a-4632-923f-c8de8cc8a6ea.png) +
+* [ YES ] Canvas + * Works with TBO Rendering (Default) + * Scuffed with VBO Rendering + *
+ VBO is broken + + Monitors are just... scuffed beyond beleif + - ![](https://i.imgur.com/JVNZ2Pn.png) + - ![](https://i.imgur.com/SXXpr54.png) + * The content to the left is supposed to be on the monitors to the right, also the bottom one is supposed to `black/white` not colored. + * Turtle Texture for some reason? + - ![](https://i.imgur.com/OEmZXsx.png) +
+ + ## Contributing Any contribution is welcome, be that using the mod, reporting bugs or contributing code. In order to start helping develop CC: R there are a few rules; -1) Any updates that port commits from CC: T, ***MUST*** follow the format defined in [patchwork.md](patchwork.md) otherwise they will not be accepted, - * Commit Message must be the same as it is in CC: T , - * patchwork.md must be updated in the following format. - > Comments, optional but useful if you had to do something differently than in CC: T outside of [Fabric](https://fabricmc.net/)/[Forge](https://mcforge.readthedocs.io/en/1.16.x/) differences. - > - > \`\`\` - > - >commitID - > - > commit title - > - > commit desc - > - > \`\`\` -2) Follow the [Fabric](https://fabricmc.net/) programming guidelines as close as possible. This means you have to use [`loom`](https://fabricmc.net/wiki/tutorial:mappings) mappings, -3) You cannot intentionally implement bugs and security vulnerabilities. -4) Unless the commit is a ["patchwork"](https://github.com/Merith-TK/cc-restitched/blob/fabric/patchwork.md) compliant commit, (IE: taken from CC: T), the lua code is off limits. +1) Follow the [Fabric](https://fabricmc.net/) programming guidelines as close as possible. This means you have to use [`loom`](https://fabricmc.net/wiki/tutorial:mappings) mappings, if you use anything else, your code will be rejected. +2) You cannot intentionally implement bugs and security vulnerabilities. +3) Unless the code is taken directly from CC:Tweaked, `lua` code is offlimits from alteration. + ## Bleeding Edge Builds Bleeding edge builds can be found [here](https://github.com/Merith-TK/cc-restitched/actions) at Github Actions. ## Community If you need help getting started with CC: Restitched, want to show off your latest project, or just want to chat about ComputerCraft, here is the [Forum](https://forums.computercraft.cc/) and the [Discord](https://discord.gg/H2UyJXe). -## Known Issues +## Known Bugs/Issues Main Known issue * Mods that add blocks that can be used as peripherals for CC: T on forge, don't work with CC: R. * This is because of the differences between forge and fabric, and that mod devs, to my knowledge have not agreed upon a standard method in which to implement cross compatibility between mods, -* [Fixed (d10f297c): please report if bug persists]
~~Storage Peripherals throw a java "StackOverflowError" when using `pushItems()`,~~ - * ~~Work around, you are probably using `pushItems(chest, 1)` or similar. please use `pushItems(chest, 1, nil, 1)`.~~ -* Computers will not run built in commands, saying "File not found". - * This is a know bug, dont know what causes it, but just restart the computer (`ctrl+r` for one second) and it will work again. - * Occurs when server runs `/reload` or a datapack is updated. +* Occasionally a computer will say "File not found" when running a built in program, this is normal just hold `crtl+r` to reboot it. + * We do not know what causes it directly, however it happens when the world is `/reload`ed, and currently running programs are not affected so nothing *should break* ## Perpherals Unfortunately, unlike the original CC: Tweaked project, CC: Restitched, does not have any actual peripheral mods, currently the only one we have is an example for mod devs to get started with making/adding the peripheral API to their mods! If your a mod dev made a mod with CC: R peripheral support, OR if your a player who found a mod with CC: R support, please open an [issue here](https://github.com/Merith-TK/cc-restitched/issues/new?assignees=&labels=peripheralShoutout&template=peripheral_shoutout.md) to let us know so we can add it to the list! -* ![icon](https://raw.githubusercontent.com/Toad-Dev/cc-peripheral-test/master/src/main/resources/assets/cc_test/textures/block/test_peripheral.png) [CC Peripheral Test](https://github.com/Toad-Dev/cc-peripheral-test) +* ![icon](https://raw.githubusercontent.com/Toad-Dev/cc-peripheral-test/master/src/main/resources/assets/cc_test/textures/block/test_peripheral.png) [CC Peripheral Test [1.16.5]](https://github.com/Toad-Dev/cc-peripheral-test) * This is an example mod for how to make peripherals that work as a block, or as a turtle upgrade!