Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/trainb0y/fabrizoom

Highly-configurable zoom for Fabric/NeoForge. Maintained fork of OkZoomer v4
https://github.com/trainb0y/fabrizoom

fabricmc fabricmc-mod minecraft minecraft-mod qol-mod

Last synced: 2 days ago
JSON representation

Highly-configurable zoom for Fabric/NeoForge. Maintained fork of OkZoomer v4

Awesome Lists containing this project

README

        

# FabriZoom

![modrinth badge](https://img.shields.io/modrinth/dt/pNFKDyna?label=Modrinth)

[Modrinth](https://modrinth.com/mod/fabrizoom/)

A simple, lightweight, configurable, cross-platform zoom mod for Minecraft.

## What?

Fork of OkZoomer v4, updated to modern Minecraft, rewritten in Kotlin, moved to different (actually maintained) GUI and
configuration libraries, and ported to (Neo)Forge using Architectury.

This mod adds a zoom key (by default, `c`) that allows the user to zoom in their view, and is highly configurable.
If you don't like the default "feel" of the zoom, you can configure it to be however you want.

## Forge? NeoForge?

Despite the name, this mod ***does*** support NeoForge since version `2.0.0` (and MinecraftForge for Minecraft `1.20.2`
only).
**However, it is not as well tested** and may have issues or bugs not present in the Fabric version,
so be sure to report any issues you come across.

Also, **FabriZoom is looking for a new name!**. Since the mod now supports (Neo)Forge, it doesn't make sense to have
Fabric in the name.
If you have any ideas, please let me know!

## Requirements

- All Platforms
- [Minecraft](https://minecraft.net) `1.21`
- [YACL](https://github.com/isXander/yetanotherconfiglib) `3.*`
- Fabric Only
- [Fabric Loader](https://fabricmc.net/) `0.15.*` (or the equivalent [Quilt](https://quiltmc.org/) version)
- [ModMenu](https://github.com/TerraformersMC/ModMenu) `11.*`
- [Fabric Language Kotlin](https://github.com/FabricMC/fabric-language-kotlin) `1.11.*` (or the
equivalent [QKL](https://modrinth.com/mod/qkl) version)
- [Fabric API](https://modrinth.com/mod/fabric-api) `0.100.*` (or the
equivalent [QFAPI](https://modrinth.com/mod/qsl) version)
- NeoForge Only
- [NeoForge](https://neoforged.net/) `21.*`
- [Kotlin for Forge](https://modrinth.com/mod/kotlin-for-forge) `5.*`

## Future Plans

- New name
- Scaling mouse sensitivity
- Add setting explanation gifs to config menu
- Pick a better default keybind, since it conflicts

Feel free to suggest new features or report bugs
on [the GitHub Issues page](https://github.com/trainb0y/fabrizoom/issues).

## Contributing

All contributions are welcome, including translations. [The source code](https://github.com/trainb0y/fabrizoom) is
licensed under the MIT license.

Thanks
to [Configurate](https://github.com/SpongePowered/Configurate), [SpruceUI](https://github.com/LambdAurora/SpruceUI),
and [YACL](https://github.com/isXander/YetAnotherConfigLib) for being excellent libraries.
Also [Devin's Badges](https://github.com/intergrav/devins-badges) are great.
Some inspiration taken from the excellent [Zoomify](https://github.com/isXander/Zoomify) mod though I've never
intentionally used its code.