Skip to content

Commit 8a4b776

Browse files
committed
Update readme
1 parent 371e0cf commit 8a4b776

1 file changed

Lines changed: 38 additions & 58 deletions

File tree

README.md

Lines changed: 38 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,57 @@
1-
# <a href="https://github.com/xCollateral/VulkanMod"> <img src="./src/main/resources/assets/vulkanmod/vlogo.png" width="30" height="30"/> </a> VulkanMod
1+
# <a href="https://github.com/xCollateral/VulkanMod"> <img src="./src/main/resources/assets/vulkanmod/vlogo.png" width="125"/> </a>
22

3-
This is a fabric mod that introduces a brand new **Vulkan** based voxel rendering engine to **Minecraft java** in order to both replace the default OpenGL renderer and bring performance improvements.
3+
# VulkanMod
44

5-
### Why?
6-
- Highly experimental project that overhauls and modernizes the internal renderer for Minecraft. <br>
7-
- Updates the renderer from OpenGL 3.2 to Vulkan 1.2. <br>
8-
- Provides a potential reference for a future-proof Vulkan codebase for Minecraft Java. <br>
9-
- Utilizes the VulkanAPI to allow for capabilities not always possible with OpenGL. <br>
10-
- Including reduced CPU Overhead and use of newer, modern hardware capabilities. <br>
5+
This is a Minecraft mod that introduces a brand new **Vulkan** based voxel rendering engine to **Minecraft** in order to both replace the default OpenGL renderer and bring performance improvements and new features.
116

12-
### Demonstration Video:
7+
<p style="text-align: left;">
8+
<a href="https://ko-fi.com/V7V7CHHJV"><img height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/donate/kofi-singular-alt_vector.svg" alt='Support me on ko-fi.com' style="margin: 5px 5px;"></a>
9+
<a href="https://discord.gg/FVXg7AYR2Q"><img height="56" src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/social/discord-plural_vector.svg" alt='Discord' style="margin: 5px 5px;"></a>
10+
</p>
1311

14-
[![Demostration Video](http://img.youtube.com/vi/sbr7UxcAmOE/0.jpg)](https://youtu.be/sbr7UxcAmOE)
12+
## Features
13+
- Reduced CPU and GPU Overhead
14+
- Terrain rendering optimizations, ranging from optimized draw loop to section culling
15+
- Chunk building optimizations
16+
- Entity rendering optimization
17+
- The Vulkan API allows for modern device capabilities not always possible with the default OpenGL renderer.
18+
- Native Wayland support (Linux specific)
19+
- Windowed fullscreen mode
20+
- and many others...
1521

16-
## FAQ
17-
- Remember to check the [Wiki](https://github.com/xCollateral/VulkanMod/wiki) we wrote before asking for support!
1822

1923
## Installation
2024

21-
### Download Links:
25+
### Download Links
2226

23-
- [![CurseForge](https://cf.way2muchnoise.eu/full_635429_downloads.svg?badge_style=flat)](https://www.curseforge.com/minecraft/mc-mods/vulkanmod)
27+
<p style="text-align: left;">
28+
<a href="https://modrinth.com/mod/vulkanmod/versions"><img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/modrinth_vector.svg" alt="Modrinth" style="margin: 5px 5px;"></a>
29+
<a href="https://www.curseforge.com/minecraft/mc-mods/vulkanmod"><img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/available/curseforge_vector.svg" alt="Curseforge" style="margin: 5px 5px;"></a>
30+
</p>
2431

25-
- [![Modrinth Downloads](https://img.shields.io/modrinth/dt/JYQhtZtO?logo=modrinth&label=Modrinth%20Downloads)](https://modrinth.com/mod/vulkanmod/versions)
32+
### Install guide:
33+
![fabric](https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@3/assets/cozy/supported/fabric_vector.svg)
2634

27-
- [![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/xCollateral/VulkanMod/total?style=flat-square&logo=github&label=Github%20Downloads)](https://github.com/xCollateral/VulkanMod/releases)
35+
- Install the [fabric modloader](https://fabricmc.net).
36+
- Download and put the `VulkanMod.jar` file into `.minecraft/mods`
2837

29-
### Install guide:
30-
>1) Install the [fabric modloader](https://fabricmc.net).
31-
>1) Download and put the `Vulkanmod.jar` file into `.minecraft/mods`
32-
>1) Enjoy !
33-
34-
## Useful links
35-
<table>
36-
<tr>
37-
<th> Discord server</th>
38-
<th> Ko-Fi</th>
39-
</tr>
40-
<tr>
41-
<td style="text-align:center">
42-
<a href="https://discord.gg/FVXg7AYR2Q">
43-
<img alt="Discord" align="top" src="https://img.shields.io/discord/963180553547419670?style=flat-square&logo=discord&logoColor=%23FFFFFF&label=Vulkanmod%20official%20discord%20server&labelColor=%235865F2&color=%235865F2">
44-
</a>
45-
</td>
46-
<td>
47-
<a href="https://ko-fi.com/V7V7CHHJV">
48-
<img alt="Static Badge" align="top" src="https://img.shields.io/badge/KoFi-%23ff5e5b?logo=ko-fi&logoColor=%23FFFFFF&link=https%3A%2F%2Fko-fi.com%2FV7V7CHHJV">
49-
</a>
50-
</td>
51-
</tr>
52-
</table>
38+
## What about shaders
5339

40+
### If you want to use shaders with VulkanMod, then check [**Beryl**](https://modrinth.com/mod/beryl)
5441

55-
## Features
42+
<a href="https://modrinth.com/mod/beryl"> <img src="https://cdn.modrinth.com/data/rYeGeBaO/4095a8bee8b54b4f88692e63f0202b45a3106c6b_96.webp" width="56" alt="beryl" style="margin: 5px 5px;"/> </a>
43+
44+
45+
## Issues
46+
47+
Remember to check the [Wiki](https://github.com/xCollateral/VulkanMod/wiki) we wrote before asking for support!
48+
49+
If you found a new issue that hasn't been already reported, then open a new instance in the [issue tab](https://github.com/xCollateral/VulkanMod/issues)
5650

57-
### Optimizations:
58-
>- [x] Multiple chunk culling algorithms
59-
>- [x] Reduced CPU overhead
60-
>- [x] Improved GPU performance
61-
>- [x] Indirect Draw mode (reduces CPU overhead)
62-
>- [x] Chunk rendering optimizations
6351

64-
### New changes:
65-
>- [x] Native Wayland support
66-
>- [x] GPU selector
67-
>- [x] Windowed fullscreen mode
68-
>- [x] Revamped graphic settings menu
69-
>- [x] Resizable render frame queue
70-
>- [ ] Shader support
71-
>- [ ] Removed Herobrine
7252

53+
---
7354

74-
## Notes
75-
- This mod is still in development, please report issues in the [issue tab](https://github.com/xCollateral/VulkanMod/issues) with logs attached!
76-
- This mode isn't just "minecraft on vulkan" (e.g: [zink](https://docs.mesa3d.org/drivers/zink.html) ), it is a full rewrite of the minecraft renderer.
55+
Developing this mod requires huge amounts of time and effort. If you want to help me continue developing this project, consider buying me a coffee.
7756

57+
<a href="https://ko-fi.com/V7V7CHHJV"><img src="https://storage.ko-fi.com/cdn/brandasset/v2/support_me_on_kofi_dark.png" width=260 alt='Support me on ko-fi.com'></a>

0 commit comments

Comments
 (0)