diff --git a/README.md b/README.md index 94f501f..f23354d 100644 --- a/README.md +++ b/README.md @@ -4,24 +4,31 @@ SPDX-FileCopyrightText: 2023 Linnea Gräf SPDX-License-Identifier: CC0-1.0 --> -# Firmament -Powered by NEU +
+ +# Firmament + +![firmament logo](./docs/firmament_logo_256_nobg.webp) + +
+ [![Forum Thread](https://img.shields.io/badge/Forum%20Thread-blue?style=flat-square)](https://hypixel.net/threads/firmament-a-skyblock-mod-for-1-20-1.5446366/) [![Discord](https://img.shields.io/discord/1088154030628417616?style=flat-square&logo=discord)](https://discord.gg/64pFP94AWA) [![Modrinth](https://img.shields.io/modrinth/dt/IJNUBZ2a?style=flat-square&logo=modrinth)](https://modrinth.com/mod/firmament) [![Github Releases](https://img.shields.io/github/downloads/nea89o/Firmament/total?style=flat-square&logo=github)](https://github.com/nea89o/firmament/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 @@ -38,11 +45,15 @@ SPDX-License-Identifier: CC0-1.0 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) -- [Fabric API](https://modrinth.com/mod/fabric-api) -- [Fabric Language Kotlin](https://modrinth.com/mod/fabric-language-kotlin) + You can download Firmament itself on [Modrinth](https://modrinth.com/mod/firmament) or on [GitHub](https://github.com/romangraef/firmament/releases). diff --git a/docs/firmament_logo.webp b/docs/firmament_logo.webp new file mode 100644 index 0000000..d70327a Binary files /dev/null and b/docs/firmament_logo.webp differ diff --git a/docs/firmament_logo.webp.license b/docs/firmament_logo.webp.license new file mode 100644 index 0000000..8b77b1b --- /dev/null +++ b/docs/firmament_logo.webp.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2025 ic22487 + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/firmament_logo_256.webp b/docs/firmament_logo_256.webp new file mode 100644 index 0000000..2aba841 Binary files /dev/null and b/docs/firmament_logo_256.webp differ diff --git a/docs/firmament_logo_256.webp.license b/docs/firmament_logo_256.webp.license new file mode 100644 index 0000000..8b77b1b --- /dev/null +++ b/docs/firmament_logo_256.webp.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2025 ic22487 + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/firmament_logo_256_nobg.webp b/docs/firmament_logo_256_nobg.webp new file mode 100644 index 0000000..c557fca Binary files /dev/null and b/docs/firmament_logo_256_nobg.webp differ diff --git a/docs/firmament_logo_256_nobg.webp.license b/docs/firmament_logo_256_nobg.webp.license new file mode 100644 index 0000000..8b77b1b --- /dev/null +++ b/docs/firmament_logo_256_nobg.webp.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2025 ic22487 + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/docs/firmament_logo_nobg.webp b/docs/firmament_logo_nobg.webp new file mode 100644 index 0000000..9b76f3c Binary files /dev/null and b/docs/firmament_logo_nobg.webp differ diff --git a/docs/firmament_logo_nobg.webp.license b/docs/firmament_logo_nobg.webp.license new file mode 100644 index 0000000..8b77b1b --- /dev/null +++ b/docs/firmament_logo_nobg.webp.license @@ -0,0 +1,3 @@ +SPDX-FileCopyrightText: 2025 ic22487 + +SPDX-License-Identifier: CC-BY-4.0 diff --git a/src/main/resources/assets/firmament/logo.png b/src/main/resources/assets/firmament/logo.png index e00a2fa..e3f063a 100644 Binary files a/src/main/resources/assets/firmament/logo.png and b/src/main/resources/assets/firmament/logo.png differ