Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Completely rewrite README to make it better #124

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

Completely rewrite README to make it better #124

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
177c356
Update README.md
SnowzNZ Jan 13, 2024
a19affc
Update README.md
SnowzNZ Jan 18, 2024
277fb9e
Update README.md
SnowzNZ Feb 17, 2024
13239e3
Update README.md
SnowzNZ Sep 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,21 @@
# Nvidium
# nvidium
SnowzNZ marked this conversation as resolved.
Show resolved Hide resolved

[![Modrinth](https://img.shields.io/modrinth/dt/nvidium?logo=modrinth)](https://modrinth.com/mod/nvidium)

Nvidium is an alternate rendering backing for sodium, it uses cutting edge nvidia features to render huge amounts of
terrain geometry at very playable framerates.
nvidium is an alternative rendering backend designed for [Sodium](https://github.com/CaffeineMC/sodium-fabric). It utilizes exclusive NVIDIA OpenGL extensions and cutting-edge features to efficiently render vast amounts of terrain geometry, resulting in highly playable experiences with consistently high framerates.

### Requires sodium and an nvidia gtx 1600 series or newer to run (turing+ architecture)
## Requirements
- [Sodium](https://github.com/CaffeineMC/sodium-fabric)
- An NVIDIA GPU that supports mesh shaders (GTX 1600 series/Turing architecture or newer)

## FAQ
> Will this mod work even if dont have an NVIDIA graphics card?
SnowzNZ marked this conversation as resolved.
Show resolved Hide resolved
>
No, nvidium will automatically disable itself

> Can I use this mod with Iris?
>
See [this](https://github.com/MCRcortex/nvidium/issues/3#issuecomment-1512757604) issue

## How does it work?
With mesh shaders, a nearly fully GPU-driven rendering pipeline is used, enabling very fast and performant geometry culling of terrain meaning your GPU can work much more efficiently.