Skip to content

Latest commit

 

History

History
93 lines (67 loc) · 4.33 KB

README.md

File metadata and controls

93 lines (67 loc) · 4.33 KB
Raw

Firmament

Powered by NEU

Forum Thread Discord Modrinth Github Releases

Currently working features

  • Item List of all SkyBlock Items
  • Grouping Items that belong together like minions
  • Recipe Viewer for Crafting Recipes
  • Recipe Viewer for Forge Recipes
  • ... as well as many more custom recipe types.
  • NPC waypoints
  • Image Preview in chat
  • A storage overview as well as a full storage overlay
  • A crafting overlay when clicking the "Move Item" plus in a crafting recipe
  • Cursor position saver
  • Slot locking
  • Support for custom texture packs (loads item models from firmskyblock:<skyblock id> before the vanilla model gets loaded)
  • Fairy soul highlighter
  • A hud editor powered by Jarvis
  • Basic Config Gui (/firm config). Still needs improvement, but for the basics it's enough. You can also use /jarvis options to search through all config options
  • and more (maintaining a feature list properly is a task for the future).

Installation

Firmament needs the following libraries to work:

You can download Firmament itself on Modrinth or on GitHub.

Usage

Everything is configurable via either /firm config, or via /jarvis options.

Recommendations

Infos about the development

Licensing and contribution policy

Most of this mod is licensed under a GPL-3.0-or-later license. Some resources may also be licensed using creative commons licenses. You can use the reuse spec to check the concrete licenses for each file. See the licenses folder for the concrete license terms of each license.

Whenever you add Content to this repository, you license that Content under those terms as specified by reuse, and you agree that you have the right to license that Content under those terms. If you want your Content to be available under a different license, or with explicit credit to you, make sure to request so in your pull request, or to provide an appropriate reuse .license file. (Note that an incompatible deviating license might result in your contribution being rejected.)

Contributions are tentatively welcomed. The structure of the mod is probably not really transparent to newcomers, but if you are interested, feel free to tackle any issues or create your own features. If you need any help contributing feel free to join the discord.

Development

Use Java 21.

Running ./gradlew :build will create a mod jar in build/libs

For a more complete development guide check out the contributing guide.

Affiliation to NEU

This codebase was originally labeled as "NotEnoughUpdates 1.19". While the author is a maintainer to NEU, this project is not affiliated with NEU beyond personal connections. There may still be references to NEU due to old names or overlapping features and libraries.