Provides an easy-to-use system for customizing the main menu around a server or a world!
To get started using the library, check out the Getting Started Guide!
Features:
Themed Splash Text
Create your own splash text! Make it say whatever you want!
Multiple Panoramas
Supports adding one or more panoramas to the main menu. There are pre-made options for determining which theme is used, or bring your own logic!
Quick-join button
One-click button to automatically connect to a specified server, world, or whatever you specify in code!
Client Configuration
Multiple options on the client side to customize the main menu and override theme settings.
Known Mod Compatibility:
- Replay Mod's button appears correctly.
- If you encounter an issue or have any suggestions, please let me know!
How to Install SimpleMainMenu Lib (Mod)
SimpleMainMenu Lib by MoSadie is verified for Fabric across Minecraft versions 1.20.1, 1.20.2, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.10 (latest release: 3.1.0, file size: 47 KB). Follow the steps below to install it safely from ModCraft.tv:
- Click the Download button above and select your Minecraft version (1.20.1, 1.20.2, 1.20.4, 1.20.5, 1.20.6, 1.21, 1.21.1, 1.21.10) and platform (Fabric).
- Make sure you have the compatible loader or environment installed for Fabric.
- Move the downloaded SimpleMainMenu Lib file into your Minecraft
.minecraft/modsfolder and launch the game.
- Minecraft 26.2 Support by @MoSadie in https://github.com/MoSadie/SimpleMainMenu-Lib/pull/22
- Full Changelog**: https://github.com/MoSadie/SimpleMainMenu-Lib/compare/v3.0.0...v3.1.0
## What is new?
### Branding Change
This mod has outgrown its original name and does so much more than just theming around only servers. It seems fitting to take the opportunity to update the name to reflect how much it can actually do.
- NOTE: THIS DOES MEAN THAT ANY MODS USING THIS LIBRARY WILL NEED TO UPDATE TO BE COMPATIBLE!*
Specifically, a lot of references in code to the previous name have also been changed, BUT I kept the initials and mod link the same, so when mods update to use SMM-Lib v3.0.0 they will still get the version update, it just will have a lot of missing imports. (and some other changes, keep reading...)
### Splash Text Overhaul (by @OffsetMonkey538)
You will notice a brand new SplashText class has appeared as the returned object for
getSplashText()! This allows multi-line splash text to happen! Use SplashText.builder() to create a new Builder! You can add one or more lines then use the .build() when returning the Splash Text!Also, in case you missed it last update changed from just raw Strings to Components, allowing for styling and translatable components if desired! There are some string fallbacks of the methods in the builder for simple uses, but if you're looking to get fancy feel free to use a Component instead!
If you need help updating, or just want examples, both [Island Menu](https://github.com/MoSadie/Island-Menu/tree/smm-lib-3.0.0) and [smm-example-mod](https://github.com/MoSadie/smm-example-mod) have been updated, so check out the recent changes there to see what I had to change!
## What's Changed
- Add support for multiline splash text by @OffsetMonkey538 in https://github.com/MoSadie/SimpleMainMenu-Lib/pull/18
- Update name to SimpleMainMenu Lib by @MoSadie in https://github.com/MoSadie/SimpleMainMenu-Lib/pull/17
- v3.0.0, rebrand time! by @MoSadie in https://github.com/MoSadie/SimpleMainMenu-Lib/pull/20
- Full Changelog**: https://github.com/MoSadie/SimpleMainMenu-Lib/compare/v2.1.0...v3.0.0
- Note:** If you encounter any existing mods using this library that have issues with this update, please let me know! There is a major under-the-hood change to splash text.
In this release we have a switch from the splash text from themes changing from a String to a Text object, there is a fallback in case a mod isn't updated, but I do recommend changing over at some point for the advantages a Text object provides! (Styling, localization, etc.)
In addition, I want to share that the mod will be getting renamed VERY SOON to
SimpleMainMenu Lib. There will be a breaking change due to the name change starting with v3.0.0 of SMM-Lib. This means all theme mods *will* need to update to be compatible with v3.0.0.
## What's Changed
- Allow using Text for splash text by @OffsetMonkey538 in https://github.com/MoSadie/ServerMainMenu-Lib/pull/16
## New Contributors
- @OffsetMonkey538 made their first contribution in https://github.com/MoSadie/ServerMainMenu-Lib/pull/16
- Full Changelog**: https://github.com/MoSadie/ServerMainMenu-Lib/compare/v2.0.7...v2.1.0
- Update to 1.21.11 by @MoSadie in https://github.com/MoSadie/ServerMainMenu-Lib/pull/15
- Full Changelog**: https://github.com/MoSadie/ServerMainMenu-Lib/compare/v2.0.6...v2.0.7
- Fix StackOverflow and also fix a possible crash by @MoSadie in https://github.com/MoSadie/ServerMainMenu-Lib/pull/13
(The first bug was only triggered if no other menu themes were installed, and the bump to 1.21.6 is for a likely impossible to hit crash scenario)
- Full Changelog**: https://github.com/MoSadie/ServerMainMenu-Lib/compare/v2.0.5...v2.0.6
- Minecraft 1.21.5 by @MoSadie in https://github.com/MoSadie/ServerMainMenu-Lib/pull/10
- Update setup-gradle action by @MoSadie in https://github.com/MoSadie/ServerMainMenu-Lib/pull/11
- Full Changelog**: https://github.com/MoSadie/ServerMainMenu-Lib/compare/v2.0.4...v2.0.5
- Update to Minecraft 1.21.4 by @MoSadie in https://github.com/MoSadie/ServerMainMenu-Lib/pull/9
- Full Changelog**: https://github.com/MoSadie/ServerMainMenu-Lib/compare/v2.0.3...v2.0.4
- Update to Minecraft 1.21(.1) by @MoSadie in https://github.com/MoSadie/ServerMainMenu-Lib/pull/6
- Full Changelog**: https://github.com/MoSadie/ServerMainMenu-Lib/compare/v2.0.2...v2.0.3
- Added Minecraft 1.20.5 and 1.20.6 support (https://github.com/MoSadie/ServerMainMenu-Lib/pull/5)
- Full Changelog**: https://github.com/MoSadie/ServerMainMenu-Lib/compare/v2.0.1...v2.0.2
New in this update:
- The ability for themes to define what main buttons are available on the main menu. Specifically, they can hide:
- Singleplayer
- Multiplayer
- Mods
- Quick Join (New name for the server join button, keep reading)
- Changed the Quick Join button to allow for custom code to be run. There are now two new methods in Util to look at:
joinServerandloadWorld
There are new overrides in the configuration screen in the Mod Menu to go along with the new features. (You will need to show library mods in the list to find SMM-Lib!)
In addition, the minimum Minecraft version is now 1.20.2 with Fabric Loader 0.15.0
If anything doesn't work correctly, please let me know on [the issue tracker](https://github.com/MoSadie/ServerMainMenu-Lib/issues)!