Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/the-aether-team/cumulus
A library for custom menu registration.
https://github.com/the-aether-team/cumulus
1-19 1-20 aether aether-team api curseforge forge minecraft minecraft-1-19 minecraft-1-20 mod modrinth official
Last synced: about 1 month ago
JSON representation
A library for custom menu registration.
- Host: GitHub
- URL: https://github.com/the-aether-team/cumulus
- Owner: The-Aether-Team
- License: lgpl-3.0
- Created: 2023-07-26T02:50:13.000Z (over 1 year ago)
- Default Branch: 1.21.0-develop
- Last Pushed: 2024-10-29T20:18:51.000Z (about 2 months ago)
- Last Synced: 2024-10-29T22:46:58.620Z (about 2 months ago)
- Topics: 1-19, 1-20, aether, aether-team, api, curseforge, forge, minecraft, minecraft-1-19, minecraft-1-20, mod, modrinth, official
- Language: Java
- Homepage: https://modrinth.com/mod/cumulus
- Size: 907 KB
- Stars: 1
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: docs/README.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
README
# Cumulus
A library for custom menu registration, used by the Aether mods.
The library adds a new menu selection screen which can be used to switch the game's main menu and dirt backgrounds. The button to access the selection screen can be found in the top right corner of the main menu.
## :heart: Support The Aether Team
[](https://patreon.com/TheAetherTeam)
[](https://discord.gg/aethermod)
[](https://twitter.com/DevAether)
[](https://mastodon.gamedev.place/@DevAether)
[](https://bsky.app/profile/aether-mod.net)
[](https://www.threads.net/@devaether)
[](https://www.facebook.com/AetherMod)
[](https://www.instagram.com/devaether)
[](https://www.tiktok.com/@devaether)
[](https://www.youtube.com/@DevAether)
[](https://www.twitch.tv/theaetherteam)
[](https://www.reddit.com/r/TheAether/)
[](https://aether.wiki.gg/)
If you enjoy our work, [please consider making a pledge](https://patreon.com/TheAetherTeam) today to help fund development. Every pledge goes directly into our development process and services, enabling us to continue making the Minecraft mods you know and love.
You can also support Cumulus and The Aether Team by telling your friends, joining our Discord server, and sharing our progress and announcements on social media. Every bit helps!
If you're interested in sponsoring Cumulus or The Aether Team, please [contact Oz#1986 on the Aether Community Discord](https://discord.gg/aethermod).
## :package: Download the latest releases
[](https://files.minecraftforge.net/net/minecraftforge/forge/)
[](https://modrinth.com/mod/cumulus)
[](https://modrinth.com/mod/cumulus)
[](https://www.curseforge.com/minecraft/mc-mods/cumulus)
[](https://www.curseforge.com/minecraft/mc-mods/cumulus)
[](https://app.circleci.com/pipelines/github/The-Aether-Team/Cumulus?branch=1.20.2-develop)
### Release builds
Cumulus has stable release builds available for 1.19.2, 1.19.4, 1.20.1, and 1.20.2 on [Modrinth](https://modrinth.com/mod/cumulus) and [CurseForge](https://www.curseforge.com/minecraft/mc-mods/cumulus).
### Bleeding edge builds
If you’re feeling a bit more adventurous or wish to help test the in-development versions, we provide **bleeding edge builds** which are produced on [CircleCI](https://app.circleci.com/pipelines/github/The-Aether-Team/Cumulus). These builds are created for every new commit and contain the latest available code. We do not recommend users treat these builds as releases, as they are unfinished and may contain serious issues. If you wish to download these builds, check out [this guide](https://github.com/The-Aether-Team/Cumulus/wiki/CircleCI-Guide).
### Packages
To install this mod through GitHub Packages in Gradle for development, you will need the [Gradle Github Packages Plugin](https://github.com/0ffz/gpr-for-gradle). To use it, make sure you have access to the Gradle plugins maven and the plugin as a buildscript dependency:
Buildscript Code
`settings.gradle`
```
pluginManagement {
repositories {
gradlePluginPortal()
}
}
```
`build.gradle`
```
plugins {
id 'io.github.0ffz.github-packages' version '[1,2)'
}
```
Then you need to specify the package you want to use in your repository:
Repositories Code
```
repositories {
...
maven githubPackage.invoke("The-Aether-Team/Cumulus")
}
```
Then load it through your dependencies, with `project.cumulus_version` specified in the `gradle.properties`:
Dependencies Code
```
dependencies {
...
implementation fg.deobf("com.aetherteam.cumulus:cumulus_menus:${project.cumulus_version}")
...
}
```
## :bug: Report bugs or other issues
If you're running into bugs or other problems, feel free to open an issue on our [issue tracker](https://github.com/The-Aether-Team/Cumulus/issues). When doing so, make sure to use one of the provided templates and fill out all the requested information. Make sure to keep your issue's description clear and concise. Your issue's title should also be easy to digest, giving our developers and reporters a good idea of what's wrong without including too many details. Failure to follow any of the above may result in your issue being closed.
## :wrench: Contribute to the project
Looking to contribute to the project? We ask that you read over our [Contributor's Guide](https://github.com/The-Aether-Team/Cumulus/blob/1.19.4-develop/docs/CONTRIBUTING.md) for more details as well as our [Contributor License Agreement (CLA)](https://github.com/The-Aether-Team/Cumulus/blob/1.19.4-develop/docs/AGREEMENT.md) before getting started.
Not sure what to help with? Take a look at our issue tracker for some ideas! [Here's a quick link](https://github.com/The-Aether-Team/Cumulus/labels/status%2Fhelp-wanted) which shows all the currently open issues that we'd love some help on.
## :scroll: License information
[](https://github.com/The-Aether-Team/Cumulus/blob/1.19.4-develop/LICENSE.txt)
If you're wanting to create a gameplay video/review, extension or addon, parody, or any other fan work of your own for Cumulus, go for it! We love seeing the content our community creates, and we hope to make it as welcoming as possible for everyone. We ask however that you please don't advertise using our brand (our specific logo assets, team name, official social media posts).
If you are thinking about using Cumulus' code or assets, please note our licensing. The source code and assets of Cumulus is under the LGPL v3.0 license.
If you have a reason that you wish to use our brand or any unlicensed material, please [get in contact with Oz#1986 on the Aether Community Discord](https://discord.gg/aethermod) for details.
## :star2: Special mentions
### :speech_balloon: Translations
[](https://translate.cumulus.devaether.com/)
Cumulus is available in these languages thanks to the following contributors:
| Language | Locale | Translators |
|-----------------------------|---------|------------------------------------------------------------------------------------------------------------|
| | | |
If you are interested in contributing translations to Cumulus, check out our [Crowdin](https://translate.cumulus.devaether.com/) and our [Discord](https://discord.gg/aethermod)! If you have contributed translations in the past and your name is missing from the above list, please contact us.
### :hammer: Contributions
All of our code contribution credits can be found [here](https://github.com/The-Aether-Team/Cumulus/blob/1.19.4-develop/docs/CREDITS.txt). If you contributed to the project and do not see your name, please contact us.