Skip to content

Commit 1674a9a

Browse files
committed
Updated Readme, best I could
1 parent 801bb45 commit 1674a9a

1 file changed

Lines changed: 22 additions & 38 deletions

File tree

.github/README.md

Lines changed: 22 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
![ ](https://www.bisecthosting.com/images/CF/ViaBackwards_Plus/BH_VBP_Header.webp)
2-
<a href="https://modrinth.com/mod/chime" target="_blank">
3-
![req](https://www.bisecthosting.com/images/CF/ViaBackwards_Plus/BH_VBP_Requirements.webp)
4-
</a>
52

6-
<p><strong>This Minecraft pack enhances the gameplay experience with the ViaBackwards plugin</strong>, which allow players to connect to newer servers with an older client. The pack requires the Chime mod to work, which helps identify the items by their custom name or custom NBT data, and assigns the correct model and texture to them. The best part of this pack is that if you put an another resourcespack on top of it, it will load the textures from that!<br><strong><span style="color: red;">Please note that this pack is not an official addon from the <a href="https://github.com/ViaVersion/ViaBackwards/graphs/contributors" target="_blank">ViaBackwards team</a>, and it's just fan-made.</span></strong></p>
73

8-
![showcase_1.20](https://www.bisecthosting.com/images/CF/ViaBackwards_Plus/BH_VBP_Showcase%20.webp)
4+
<p><strong>This Minecraft pack enhances the gameplay experience with the ViaBackwards plugin</strong>, which allows players to connect to newer servers with an older client. Rebuilt from the ground up for modern Minecraft, this pack requires <strong>absolutely no mods</strong> to work! It uses native vanilla features to identify future items by their component data and assigns the correct model and texture to them (officially supporting <strong>1.21.5 through 1.21.11+</strong>). The best part of this pack is that if you put another resource pack on top of it, it will load the textures from that (make sure to place this pack at the bottom)!<br><strong><span style="color: red;">Please note that this pack is not an official addon from the <a href="https://github.com/ViaVersion/ViaBackwards/graphs/contributors" target="_blank">ViaBackwards team</a>, and it's just fan-made.</span></strong></p>
5+
6+
<p><strong>Note:</strong> This pack specifically updates the 2D inventory icons and in-hand 3D models. It does <em>not</em> change the textures of blocks or entities once they are physically placed in the world.</p>
7+
8+
![showcase_modern](https://www.bisecthosting.com/images/CF/ViaBackwards_Plus/BH_VBP_Showcase%20.webp)
99

1010
---
1111

@@ -32,11 +32,9 @@
3232

3333
<h3>Future plans <small>(<a href="https://ko-fi.com/bangetto" blank="_blank">Buy me a coffee</a> to make it happen sooner)</small></h3>
3434
<ul>
35-
<li>Keep the pack up-today</li>
36-
<li><a href="https://github.com/ViaVersionAddons/ViaBackwards-Plus/issues/3" target="_blank">Port the pack to Optifine</a></li>
37-
<li>Create a custom ViaBackwards version for the smoothest experience</li>
38-
<li> Fix every bug</li>
39-
<li>Go below 1.16 (only if the pack get popular enought so I can ask the mod's dev to backport the mod)</li>
35+
<li>Keep the pack up-to-date with the newest Game Drops (26.x and beyond)</li>
36+
<li>Try to integrate optifine or ETF textures for entities</li>
37+
<li>Fix every bug reported by the community</li>
4038
<li>Add more easter eggs, maybe</li>
4139
</ul>
4240

@@ -47,54 +45,40 @@
4745
![FAQ](https://www.bisecthosting.com/images/CF/ViaBackwards_Plus/BH_VBP_FAQ.webp)
4846

4947
<details>
50-
<summary><b>Dependencies</b></summary>
51-
52-
**Chime**: The main priority of this project, the structure of the project is build upon Chime. It helps backporting the items in a fast and efficient way.
53-
54-
Optifine CIT: This is a work in progress more detailed in the next section, but it does the same thing, just the implementation of it is a bit slower.
55-
56-
Respackopts: Used to fix the Minecraft logo in the main menu for 1.20-1.20.1, after it it done trough the overlay_pack feature. It is planned to use the capabilities of the mod more.
48+
<summary><b>Dependencies & Mods</b></summary>
5749

50+
**None!** The modern version of this project relies entirely on Minecraft's native `pack.mcmeta` overlays, `minecraft:component` rules, and the `custom_model_data` system. Players do not need Optifine, CIT, or Chime to see the new items. Just load the pack and play.
5851

5952
</details>
6053

6154
<details>
62-
<summary><b>Optifine?</b></summary>
55+
<summary><b>What about older versions?</b></summary>
6356

64-
**The Optifine versions of the pack is in the works, and will be done in the pack's 2.0 version with the release of Minecraft 1.21.**
57+
This native vanilla approach is only possible because of engine changes introduced recently. **If you are looking to support clients older than 1.21.4**, you will need to use **Version 1** of this pack.
6558

66-
The pack will start with the newly added and 1.17 items then it will move on to the 1.20 items and lastly do the 1.19 items, because there's a smaller Optifine pack called <a href="https://www.planetminecraft.com/texture-pack/viavisual/" target="_blank">ViaVisual</a>. If you want to speed up the development you can do it on <a href="https://github.com/ViaVersionAddons/ViaBackwards-Plus/tree/dev" target="_blank">Github</a>
59+
Version 1 uses the Chime mod and Optifine CIT to backport items. You can still find Version 1 and its documentation in the <a href="https://github.com/ViaVersionAddons/ViaBackwards-Plus/tree/v1" target="_blank">v1 branch of this repository</a>.
6760

6861
</details>
6962

7063
<details>
71-
<summary><b>Release Cycle</b></summary>
64+
<summary><b>Release cycle</b></summary>
7265

73-
**As of Minecraft 1.20.5:**
74-
When a Minecraft release is at Pre-release or Release-candidate stage a beta is released, but it's untested, so there's might be bugs. After a few days of the Minecraft release Viabackwards will also release publicly, this is when i'll fix bugs happened while the backporting, and after that the release of VB+ will be published.
66+
**As of Minecraft 26.1:**
67+
Our Base Pack will always target the newest Minecraft drops to ensure maximum compatibility for modern clients. When a new Minecraft version drops, ViaBackwards follows soon, and we'll update the base pack and push the previous version's items down into backward-compatible overlays. Expect updates shortly after major ViaBackwards protocol updates are published!
7568

7669
</details>
7770

7871
<details>
79-
<summary>How it Works?</summary>
72+
<summary><b>How it works</b></summary>
8073

81-
<p>The pack works by identifying items by their ViaBackwards Protocol ID, which helps determine the correct model and texture to assign to them. For example, "Copper ore" has a protocol id of "44", the Chime mod will help the pack recognize it as a Copper ore and assign the correct model and texture to it.</p>
82-
<p>Think of it like a special tag on each item that tells the pack what it is, so the pack knows how to make it look and behave correctly. This way, you get to enjoy the latest Minecraft textures and the easy identification of items, even if you're playing an older version of the game!</p>
74+
<p>Instead of relying on external mod IDs, this pack uses Minecraft's modern data-driven rendering engine. The pack is split into "overlays" to optmize loading for your particular version. </p>
75+
<p>For example, when you join a 1.21.11 server using a 1.21.5 client, the server translates a new item (like a Copper Spear) into an item your client understands (like an Iron Sword) and attaches hidden component data to it. Our pack intercepts that specific data and says: <em>"Hey, this isn't actually an iron sword, render the Copper Spear model instead!"</em></p>
8376

8477
</details>
8578

8679
<details>
87-
<summary>Implementation on Servers</summary>
80+
<summary><b>Implementation on servers</b></summary>
8881

89-
You can put this resources pack to your server so, it's automatically loads when players join. The only problem is that players still have to install Chime or CIT. As of now the resource pack has a more client-sided approach, but **a more server-side friendly version is planned!** If I see demand for it I will make and maintain a version of this pack which uses the vanilla `custom_model_data` feature to backport the items instead of the external ones. Join my Discord if you want to be notified when this happens!
82+
**This is the ultimate ViaBackwards server-side resource pack.** Because it no longer requires players to download third-party mods like Chime or Optifine, you can safely integrate this resource pack directly in your `server.properties`. When legacy players join your modern server, they'll automatically download the pack and immediately see the correct future items in their GUI!
9083

91-
</details>
92-
93-
<details>
94-
<summary>Even lower versions?</summary>
95-
96-
#### If there's demand for it I can make support for 1.14x and 1.15x.
97-
98-
**For versions below that I probably won't, before 1.14 items had different ID's, which means the entire pack would have to be rewritten!** The only way to make the pack work for versions older then 1.14 would be Optifine CIT, and I hate to work with CIT, even `custom_model_data` was implemented in 1.14, Optifine had a monopoly back then...
99-
100-
</details>
84+
</details>

0 commit comments

Comments
 (0)