Skip to content

Commit

Permalink
Merge pull request #318 from DataDalton/1.16.5
Browse files Browse the repository at this point in the history
[Readme] Update README to fit Rubidium's readme
  • Loading branch information
Asek3 authored Sep 5, 2023
2 parents 4524b21 + d9ff1c8 commit 71a21fb
Showing 1 changed file with 39 additions and 2 deletions.
41 changes: 39 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,39 @@
![Oculus: An open-source shaders mod compatible with OptiFine shaderpacks](banner.png)
[Discord](https://discord.gg/UCsyn5RS4s)
<p align="center">
<img src="banner.png">
</p>

# Oculus
[![](http://cf.way2muchnoise.eu/short_oculus_downloads.svg)](https://www.curseforge.com/minecraft/mc-mods/oculus)
[![](http://cf.way2muchnoise.eu/versions/Available%20for_oculus_full.svg)](https://www.curseforge.com/minecraft/mc-mods/oculus/files)

Oculus is an Unofficial Fork of ["Iris"](https://www.curseforge.com/minecraft/mc-mods/irisshaders), made to work with Forge Mod Loader.

## Disclaimer
Oculus is not and never will be compatible with Optifine!

## Dependencies
Oculus requires [Rubidium](https://www.curseforge.com/minecraft/mc-mods/rubidium) made by Asek3!

## Features
* Performance. Oculus should fully utilize your graphics card when paired with optimization mods like Rubidium.

* Mod compatibility. Oculus should make a best effort to be compatible with modded environments.

* Backwards compatibility. All existing ShadersMod / OptiFine shader packs should just work on Oculus, without any modifications required.

* A well-organized codebase. I'd like for working with Oculus code to be a pleasant experience overall.

## Discord
[![](https://dcbadge.vercel.app/api/server/UCsyn5RS4s)](https://discord.gg/UCsyn5RS4s)

## Contributors
<a href="https://github.com/Asek3/Oculus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Asek3/Oculus" />
</a>

## License

[LGPL-3.0 license](https://github.com/Asek3/Oculus/blob/1.16.5/LICENSE)

## Consider supporting
[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dasek3%26type%3Dpatrons&style=for-the-badge)](https://patreon.com/asek3)

0 comments on commit 71a21fb

Please sign in to comment.