https://github.com/up-mods/libzoomer

A library that allows other mods to create zooms and custom spyglasses easily. Essentially Ok Zoomer but it's an API.
https://github.com/up-mods/libzoomer

Last synced: about 1 month ago
JSON representation

A library that allows other mods to create zooms and custom spyglasses easily. Essentially Ok Zoomer but it's an API.

• Host: GitHub
• URL: https://github.com/up-mods/libzoomer
• Owner: Up-Mods
• License: mit
• Created: 2020-12-09T14:44:10.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-14T15:22:13.000Z (6 months ago)
• Last Synced: 2024-06-14T16:33:14.074Z (6 months ago)
• Language: Java
• Size: 474 KB
• Stars: 6
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


# LibZoomer

A library that allows other mods to create zooms and custom spyglasses easily. The current supported version is Minecraft 1.20.

## Usage

**WARNING:** This API is still not finished and breaking changes may happen until a 1.0.0 release happens!

This library is available through Maven Central and Jitpack. If none of these options work, consider using local Maven on the source code of a released version.

LibZoomer provides zooming through zoom instances, which contains three sub-instances: transition modes, mouse modifiers and zoom overlays. A zoom instance can be created with different subinstances, which can be either provided by the library or implemented by the mod itself. In order to a zoom instance to be functional, it must be registered by the ZoomRegistry. In order to make the instance zoom in, the instance's zoom state must be set to true, which can be done using the `setZoom` method, the vice-versa can be done by setting it to false.

A better guide will be written later, feel free to take a look on this mod's testmod if you want an example!

## Download

This mod is meant to be JiJ'd by mods, so you wouldn't need to download it at all in most cases. If you really need to download it, it's available in the following services:

- [Modrinth (recommended)](https://modrinth.com/mod/libzoomer)

- [GitHub Releases (alternative)](https://github.com/EnnuiL/LibZoomer/releases)

## License

This mod is licensed under the MIT license. You can freely Jar-in-Jar this mod on any mod with no permission. Usage of this mod's code on other projects or derivatives of this mod is allowed as long as attribution is given.