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.

❤️ Support The Aether Team

If you enjoy our work, please consider making a pledge 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.

📦 Download the latest releases

Release builds

Cumulus has no stable builds available.

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. 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.

Packages

To install this mod through GitHub Packages in Gradle for development, you will need the Gradle Github Packages Plugin. To use it, make sure you have access to the Gradle plugins maven and the plugin as a buildscript dependency:

Buildscript Code

buildscript {
  repositories {
    ...
    maven {
        name 'Gradle'
        url "https://plugins.gradle.org/m2/"
    }
  }
  dependencies {
    ...
    classpath group: 'io.github.0ffz', name: 'gpr-for-gradle', version: '1.+', changing: true
  }
}
...
apply plugin: 'io.github.0ffz.github-packages'

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}")
  ...
}

🐛 Report bugs or other issues

If you're running into bugs or other problems, feel free to open an issue on our issue tracker. 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.

🔧 Contribute to the project

Looking to contribute to the project? We ask that you read over our Contributor's Guide for more details as well as our Contributor License Agreement (CLA) before getting started.

Not sure what to help with? Take a look at our issue tracker for some ideas! Here's a quick link which shows all the currently open issues that we'd love some help on.

📜 License information

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 for details.

🌟 Special mentions

💬 Translations

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 and our Discord! If you have contributed translations in the past and your name is missing from the above list, please contact us.

🔨 Contributions

All of our code contribution credits can be found here. If you contributed to the project and do not see your name, please contact us.

CDAGaming / Aether-Cumulus