A fork of Iris focused on bringing fixes and features to the user faster and to provide a better in-game user experience. Currently, a major addition over normal iris is preliminary shaderpack config support, including an in-game gui to manage shader settings.
- Log into or create a GitHub account if you don't already have one
- Click Actions at the top of the page or visit this link: https://github.com/HyperCubeMC/Iris/actions
- Each action has a bold title, a commit id, a timestamp, and a blue branch name containing the version (e.g
1.17-starline)
- Find the latest (closest to the top) action with a blue branch name containing the version you want to download, and click on the bold title next to it
- If the branch name does not have a version before it, it is for 1.16
- At the bottom, there should be a text that says Artifacts, with a size next to it
- Click the bold text labeled "Artifacts" to download a zip containing the built starline jars
- If you are unable to click it and nothing happens, you are not logged into a GitHub account and you need to login or create a new one
- Extract the zip by right-clicking it and pressing extract
- After it has been extracted, there should be 4 jars. Copy the one without -sources or -dev on the end, just -starline, a build number and .jar
- Remove normal iris from your mods folder (or iris-reserved folder, if you used the installer with use custom loader checked) and paste in the new starline jar
- Repeat these steps for starline sodium, found at https://github.com/HyperCubeMC/sodium-fabric
Starline specific info:
- Hop on my discord server for further information and help with starline, as well as serving as a place to chill and game with friends and others!
Non-starline specific part of the readme:
- Visit the Iris website for normal, non-starline downloads and pretty screenshots!
- Visit the Iris Discord server to chat about the mod and get support (no starline support here, see above starline for that)! It's also a great place to get development updates right as they're happening.
- Visit the lead Iris developer's Patreon page to support the continued development of Iris!
Iris was created to fill a void that I saw in the Minecraft customization and graphical enhancement community: the lack of an open-source shaders mod that would let me load my favorite shader packs on modern versions of the game, while retaining performance and compatibility with modpacks. OptiFine, the current dominant mod for loading shader packs, has restrictive licensing that firmly stands in the way of any sort of tinkering, and is fairly notorious for having compatibility issues with the mods that I like. It's also mutually incompatible with Sodium, the best rendering optimization mod in existence by a large margin. ShadersMod was never updated past 1.12, and it lacks support for many of the many modern popular shaderpacks. So I created Iris, to try and solve these issues, and also address many other longstanding issues with shader packs.
I first and foremost develop Iris to meet my own needs of a performance-oriented shaders mod with good compatibility and potential for tinkering. Iris when paired with Sodium delivers great performance on my machine, finally making it fully possible for me to actually play with shaders instead of just periodically switching them on to take pretty screenshots, then switching them off once I get tired of frame drops. Of course, as it turns out, I'm far from the only person who benefits from the development of Iris, which is why I've decided to release it to the public as an open-source mod.
Canvas is another shaders mod that has already gained some traction. Its big downside for me, however, is the fact that it doesn't support the existing popular OptiFine shaderpacks that I want to use. This is because it uses a new format for shader packs that isn't compatible with the existing format, in order to achieve many of its goals for better mod integration with shaders. And while Canvas now has a few nice shaders like Lumi Lights, I still want to have the option of using existing shader packs that were designed for OptiFine. Shader packs just aren't interchangeable, just like how you cannot hand a copy of The Last Supper to someone who wants a copy of the Mona Lisa. They're both great pieces of art, but you absolutely cannot just swap one out for the other. That being said, if you're a fan of the shader packs available for Canvas, then great! Canvas and Iris are both perfectly fine ways to enjoy shaders with Minecraft.
These are the goals of Iris. Since Iris isn't yet complete, it hasn't fully achieved all of these goals, though we are on the right track.
- Performance. Iris should fully utilize your graphics card when paired with optimization mods like Sodium.
- Correctness. Iris should try to be as issueless as possible in its implementation.
- Mod compatibility. Iris should make a best effort to be compatible with modded environments.
- Backwards compatibility. All existing ShadersMod / OptiFine shader packs should just work on Iris, without any modifications required.
- Features for shader pack developers. Once Iris has full support for existing features of the shader pipeline and is reasonably bug free, I wish to expand the horizons of what's possible to do with Minecraft shader packs through the addition of new features to the shader pipeline. Unlimited color buffers, direct voxel data access, and fancy debug HUDs are some examples of features that I'd like to add in the future.
- A well-organized codebase. I'd like for working with Iris code to be a pleasant experience overall.
- Agnostic of Minecraft versions. This is more of a long-term goal, but if it is possible to make the majority of Iris version-independent, then porting to new versions should be straightforward and quick. This theoretically works in the other direction as well, though Iris for 1.8.9 (and similar old versions) isn't very practical currently since Sodium doesn't exist for these versions of the game.
Iris has public releases for 1.16 and 1.17 that work with custom versions of Sodium. Iris has made a lot of progress, but it is still not complete software. Though it is already usable for many people, and generally provides a big performance boost over alternatives, there is still much to be done before Iris can be a complete replacement for OptiFine's shaders features. As Iris continues its development, it will only become more and more complete with time.
Compatibility with Sodium is an ongoing project. I've been chatting with JellySquid over the course of many months regarding compatibility, and many refactors and improvements have been implemented into Sodium in order to better accommodate Iris. Though a fork of Sodium is still required, it's my intent that it will be unnecessary in the future. Official downloads of Iris include this modified version of Sodium for performance.
The following shader packs mostly work, though with a few bugs of course:
- Sildur's Vibrant Shaders
- Complementary Shaders
- BSL Shaders
- Sildur's Enhanced Default
- Enchantment glints are broken
- SEUS Renewed
- Note that SEUS Renewed does not work on some platforms and might fail to compile.
- SEUS v11 (from 2016, not to be confused with SEUS PTGI E11)
- General issues with weather
- Note that SEUS v11 does not work on some platforms and might fail to compile.
- Skylec Shader - a very lightweight shaderpack that pulls off some neat effects
- Underwater is broken
- Weather is broken
- XorDev's shaderpacks
Other shaderpacks aren't officially supported currently.
- The Iris Discord server is looking for people willing to provide support and moderate the server! Send @IMS#7902 a message if you'd like to apply.
- Code review on open PRs is appreciated! This helps get important issues with PRs resolved before I give them a look.
- Code contributions through PRs are also welcome! If you're working on a large / significant feature it's usually a good idea to talk about your plans beforehand, to make sure that work isn't wasted.
Iris doesn't support Forge. This is for a few reasons:
- My time is limited, and properly supporting all the mods available for Forge (as well as Forge itself) is a huge amount of work. When people ask for Forge support, they aren't asking just for Iris to run on Forge, they are also asking for it to be compatible out of the box with their kitchen sink modpack that contains over 300 mods. As a result, properly supporting Forge would require me to divert large amounts precious time into fixing tedious compatibility issues and bugs, time that could instead be spent making the Fabric version of Iris better.
- The Forge toolchain isn't really designed to play nice with mods like Iris that need to make many patches to the game code. It's possible, but Fabric & Quilt are just better for mods like Iris. It's no coincidence that the emergence of Fabric and the initial emergence of OptiFine replacements happened at around the same time.
- Sodium, which Iris depends on to achieve its great performance, has no official Forge version. It's a long story, but in short: the lead developers of Forge were incredibly hostile to JellySquid when she developed for Forge, and since then have made no credible attempts to repair relations or even admit wrongdoing.
The license of Iris does permit others to legally port Iris to Forge, and we are not strictly opposed to the existence of an Iris Forge port created by others. However, what we are opposed to is someone doing a bare-minimum port of Iris to Forge, releasing it to the public, and then abandoning it or poorly maintaining it while compatibility issues and bug reports accumulate. When that happens, not only does that hurt the reputation of Iris, but we also ultimately get flooded by users wanting support with a low-effort Forge port that we didn't even make.
So, if you want to distribute a Forge port of Iris, we'd prefer if you let us know. Please don't just name your port "Iris Forge," "Iris for Forge," or "Iris Forge Port" either. Be original, and don't just hijack our name, unless we've given you permission to use one of those kinds of names. If a well-qualified group of people willing to maintain a Forge port of Iris does appear, then a name like "Iris Forge" might be appropriate - otherwise, it probably isn't appropriate.
- TheOnlyThing and Vaerian, for creating the excellent logo
- Mumfrey, for creating the Mixin bytecode patching system used by Iris and Sodium internally
- The Fabric and Quilt projects, for enabling the existence of mods like Iris that make many patches to the game
- JellySquid, for creating Sodium, the best rendering optimization mod for Minecraft that currently exists, and for making it open-source
- All past, present, and future contributors to Iris, for helping the project move along
- Dr. Rubisco, for maintaining the website
- The Iris support and moderation team, for handling user support requests and allowing me to focus on developing Iris
- daxnitro, karyonix, and sp614x, for creating and maintaining the current shaders mods
Iris is completely free and open source, and you are free to read, distribute, and modify the code as long as you abide by the (fairly reasonable) terms of the GNU LGPLv3 license.
Though it's not legally required, I'd appreciate it if you could ask before hosting your own public downloads for compiled versions of Iris. Though if you want to add the mod to a site like MCBBS, that's fine, no need to ask me.