Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
JNNGL committed Apr 29, 2024
1 parent 62b65cc commit caa53e6
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

-----

Fully vanilla minimaps, without any mods.
A minimap plugin, without any clientside mods.

https://github.com/JNNGL/VanillaMinimaps/assets/45935949/4a6f9cf4-0575-4a46-852e-da11a18edc56

Expand All @@ -14,6 +14,7 @@ https://github.com/JNNGL/VanillaMinimaps/assets/45935949/ea7738c9-bd4a-4388-9d65

- Clientside layer entities
- Smooth clientside rotation
- Real-time world rendering
- Position interpolation
- Better map colors
- Configurable markers
Expand All @@ -25,6 +26,28 @@ https://github.com/JNNGL/VanillaMinimaps/assets/45935949/ea7738c9-bd4a-4388-9d65
- [x] Sodium (without shaders)
- [x] OptiFine (without shaders)
- [ ] Iris/OptiFine shader packs
- [ ] MoreCulling
- [ ] ImmediatelyFast

### Common problems

**The plugin isn't working!!!!!! I get two maps, one above my chest and the other one above my head.**
> This means that the resource pack is not installed properly, or you have iris/optifine shaders enabled.
> If you are using plugins like ItemsAdder, they may overwrite shaders in the resource pack,
> ask the dev of the plugin you are using.
**This doesn't work with optifine/iris shaderpacks.**
> Optifine/Iris override vanilla shaders. This can't be fixed.
**This doesn't work on Bedrock.**
> The plugin uses vanilla shaders to display the minimap, this is an exclusive feature for the Java Edition.
> Bedrock will never be supported by this plugin.
**The minimap is not displayed with mod ...**
> There are some mods that break the minimap, compatibility with some of them can be fixed and with some not.
> Check [Mods compatibility](https://github.com/JNNGL/VanillaMinimaps?tab=readme-ov-file#mods-compatibility)
> and [Issues](https://github.com/JNNGL/VanillaMinimaps/issues). If you haven't found any information for a mod
> that breaks the minimap, feel free to open an issue.
### Credits

Expand Down

0 comments on commit caa53e6

Please sign in to comment.