Skip to content

Commit 7f60df6

Browse files
authored
Refactor README for better structure and readability
Updated README to improve formatting and clarity of issues and features.
1 parent b158422 commit 7f60df6

1 file changed

Lines changed: 13 additions & 15 deletions

File tree

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
> reports about crashes or errors caused by OptiRefine are welcome. Note: rendering anomalies while shaders
66
> are active are expected — don't worry, it is normal.
77
8-
<img width="683" height="293" alt="a6fade3b-b7ea-4651-a2a5-a69ffbf996b0" src="https://github.com/user-attachments/assets/4ec54838-aa21-4877-a38f-d50d8e11f554" />
9-
108
---
119

1210
OptiRefine is a mod that utilizes Mixin to patch Optifine, keeping optifine compatible with cleanroom and reducing its destructiveness.
@@ -25,7 +23,7 @@ The project targets **Java 25**
2523
```
2624

2725
Note: mixins are written against the vanilla MCP classes on the compile classpath;
28-
OptiFine-only members are accessed via `@AccessibleOperation` / `@Shadow` (see FOR_AGENT.md).
26+
OptiFine-only members are accessed via `@AccessibleOperation`
2927

3028
## Test Environment
3129

@@ -36,15 +34,14 @@ OptiFine-only members are accessed via `@AccessibleOperation` / `@Shadow` (see F
3634
## Feats
3735

3836
### Cleanroom removed Realms
39-
OptiRefine does not perform any special repairs, which may prove to be universal.
4037

41-
with Fugue
38+
| Configuration | Image | Note |
39+
| --- | --- | --- |
40+
| with Fugue | ![image](https://github.com/user-attachments/assets/9ac12224-b8dd-42f0-ba33-2975854a0fef) ||
41+
| with OptiRefine | ![image](https://github.com/user-attachments/assets/2c701e4b-1325-4b61-a5c7-5308e7d34528) | OptiRefine does not perform any special repairs, which may prove to be universal. |
4242

43-
<img width="851" height="477" alt="image" src="https://github.com/user-attachments/assets/9ac12224-b8dd-42f0-ba33-2975854a0fef" />
4443

45-
with OptiRefine
4644

47-
<img width="833" height="507" alt="image" src="https://github.com/user-attachments/assets/2c701e4b-1325-4b61-a5c7-5308e7d34528" />
4845

4946
## OptiFine Great Again
5047

@@ -58,12 +55,13 @@ Make OptiFine great again.
5855

5956
## Fixed Issue under Cleanroommc/Cleanroom
6057

61-
https://github.com/CleanroomMC/Cleanroom/issues/600
62-
63-
https://github.com/CleanroomMC/Cleanroom/issues/513
64-
65-
https://github.com/CleanroomMC/Cleanroom/issues/359
58+
<details>
59+
<summary>Issues</summary>
6660

67-
https://github.com/CleanroomMC/Fugue/issues/123
61+
- [Cleanroom #600](https://github.com/CleanroomMC/Cleanroom/issues/600)`Crashes when used with OptiFine`
62+
- [Cleanroom #513](https://github.com/CleanroomMC/Cleanroom/issues/513)`Optifine make the game crash in full screen`
63+
- [Cleanroom #359](https://github.com/CleanroomMC/Cleanroom/issues/359)`Instant crash on nearly vanilla setup (0.3.4)`
64+
- [Fugue #123](https://github.com/CleanroomMC/Fugue/issues/123)`Optifine breaks "Remove Realms Button" patches when Fugue is installed`
65+
- [Fugue #113](https://github.com/CleanroomMC/Fugue/issues/113)`[Optifine] Fullscreen Mode doesn't move.`
6866

69-
https://github.com/CleanroomMC/Fugue/issues/113
67+
</details>

0 commit comments

Comments
 (0)