105 lines
4.3 KiB
Markdown
105 lines
4.3 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: 2023 Linnea Gräf <nea@nea.moe>
|
|
|
|
SPDX-License-Identifier: CC0-1.0
|
|
-->
|
|
|
|
|
|
|
|
<div align="center">
|
|
|
|
# Firmament
|
|
|
|
|
|
|
|
<hr>
|
|
|
|
[](https://hypixel.net/threads/firmament-a-skyblock-mod-for-1-20-1.5446366/)
|
|
[](https://discord.gg/64pFP94AWA)
|
|
[](https://modrinth.com/mod/firmament)
|
|
[](https://github.com/nea89o/firmament/releases)
|
|
|
|
</div>
|
|
|
|
|
|
## Currently working features
|
|
|
|
- Item List of all SkyBlock Items
|
|
- Recipe Viewer for Crafting Recipes
|
|
- Recipe Viewer for Forge Recipes
|
|
- ... as well as many more custom recipe types.
|
|
- NPC waypoints
|
|
- 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](https://github.com/romangraef/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:
|
|
|
|
- [Fabric API](https://modrinth.com/mod/fabric-api)
|
|
- [Fabric Language Kotlin](https://modrinth.com/mod/fabric-language-kotlin)
|
|
|
|
As well as (for the item list):
|
|
-
|
|
- [RoughlyEnoughItems](https://modrinth.com/mod/rei)
|
|
- [Architectury](https://modrinth.com/mod/architectury-api)
|
|
- [Cloth Config](https://modrinth.com/mod/cloth-config)
|
|
|
|
|
|
You can download Firmament itself on [Modrinth](https://modrinth.com/mod/firmament) or on
|
|
[GitHub](https://github.com/romangraef/firmament/releases).
|
|
|
|
### Usage
|
|
|
|
Everything is configurable via either `/firm config`, or via `/jarvis options`.
|
|
|
|
### Recommendations
|
|
|
|
- [DulkirMod-Fabric](https://github.com/inglettronald/DulkirMod-fabric), a versatile SkyBlock mod.
|
|
- [Skyblocker](https://modrinth.com/mod/skyblocker-liap), a very feature rich SkyBlock mod.
|
|
- [Sodium](https://modrinth.com/mod/sodium) and [Lithium](https://modrinth.com/mod/lithium), both excellent performance mods.
|
|
- [ModMenu](https://modrinth.com/mod/modmenu), just to see which mods you have installed, and to configure some of them.
|
|
|
|
## 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](https://github.com/fsfe/reuse-tool) 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](https://github.com/nea89o/Firmament/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](./CONTRIBUTING.md).
|
|
|
|
### 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.
|
|
|
|
[discord]: https://discord.gg/64pFP94AWA
|