Skip to content

Add clear Forge compatibility information to address user questions #5

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Copilot wants to merge 2 commits into from
Closed

Add clear Forge compatibility information to address user questions #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2b437b
Initial plan
Copilot Aug 19, 2025
83c7dd1
Add clear Forge compatibility information to README
Copilot Aug 19, 2025
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
28 changes: 27 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
# Skija

**Minecraft Version:** 1.21.4
**Minecraft Version:** 1.21.4 | **Mod Loader:** Fabric Only

This project is an example implementation of integrating the Skija graphics library with Minecraft to enhance rendering capabilities. It demonstrates how to use Skija for advanced rendering techniques within the Minecraft environment.

**鈿狅笍 Note:** This mod is built specifically for Fabric and is not compatible with Forge or NeoForge.

In this example, we render the blurred version of the Minecraft scene using Skija.

## Features
Expand All @@ -13,13 +15,37 @@ In this example, we render the blurred version of the Minecraft scene using Skij
- **Framebuffer Handling:** Ensures Skija is reinitialized when the window is resized.
- **Image Handling:** Provides utilities to convert Minecraft scene to Skija images.

## Mod Loader Support

**This mod currently supports Fabric only.**

- **Supported:** Fabric Loader 0.16.14+
- **Not Supported:** Forge, NeoForge, Quilt

## Usage

To run the project, use the following Gradle tasks:

- **Run Client:** `./gradlew runClient`
- **Run Client with RenderDoc:** `gradlew.bat "runClient + RenderDoc"` (requires Windows and RenderDoc installed in the default location `C:\Program Files\RenderDoc\renderdoccmd.exe`)

## FAQ

### Can this mod be used with Forge?

No, this mod is currently designed specifically for Fabric and is not compatible with Forge or NeoForge. The mod uses Fabric-specific features including:
- Fabric mixins system
- Fabric mod loader APIs
- Fabric build toolchain (fabric-loom)

### Will there be Forge support in the future?

Porting to Forge would require significant architectural changes and is not currently planned. However, the core concepts and Skija integration techniques demonstrated in this project could potentially be adapted for Forge-based mods by experienced developers.

### Can I use this with Quilt?

While not explicitly tested, this mod may work with Quilt since Quilt maintains compatibility with many Fabric mods. However, official support is only provided for Fabric.

## License

This project is licensed under the AGPL-3.0 License. See the [LICENSE](LICENSE) file for details.
Expand Down