Simple Splash Screen Manual

Introduction

image-1626178392292.png


image-1626178592986.png

Simple Splash Screen is a mod that allows you to completely customize the Minecraft Loading screen. It allows you to add your own colors, images, logo and even your own custom progress bar. This mod is basically a Forge port of the original Custom Splash Screen mod by Motschen.

Please note, on forge this mod will only take effect once the forge pre-loading screen is done. This screen of forge is hidden behind non-accessible code, so as such, no modifications can be made to it without causing a crash risk.

 

image-1626178779386.png

If you need help to configure this mod, please check out the rest of this documentation, or alternative, you can join my discord server and ask for help in the "simple-splash-screen" channel.

If you find a bug, or have any suggestions, then you can also Log a ticket. If you'd like to contribute to the mod, you can find the Source Code on github.

Test Builds (Builds with bug fixes/new features that haven't been released yet, can be found HERE

 

image-1626178992506.png

image-1626179136796.png 

image-1626179145501.png

 

image-1626179160432.png

You are allowed to include this mod in your modpack, BUT, all downloads have to go through this Curseforge page. You are not allowed to re-upload the mod to any other sites.

You are free to clone the code and distribute the mod as your own, but I ask that you please change the name and do not use any of my official docs/resources.


image-1626179265383.jpg

 

Understanding The Config

Since this mod relies on Cloth Config and provides a config screen, I would suggest using the config screen to make changes to the config.

However, if it's needed to make manual changes, here is a short explanation of what each option does:

 

showProgressText -> This Enables/Disables the loading/memory text that forge shows on the Loading Screen (FORGE ONLY).

Valid values are true or false

 

progressBarType -> This controls what type of progress bar is used.

Valid values are Vanilla, Bossbar, Custom, Hidden.

 

logoStyle -> This controls what logo should be shown.

Valid values are Mojang, Aspect1to1, Hidden. When set to Aspect1to1, it uses a custom logo of your choice. This logo must be 512px x 512px.

 

backgroundImage -> This controls if the loading screen background is an image or color

Valid values are true or false

 

backgroundColor -> Here you define what color to use for the loading screen background.

This has no effect when backgroundImage is set to true.

Color values must be in decimal format. If you use the ingame config, it has to be a hex code. You can use this site to help with the conversion: https://www.mathsisfun.com/hexadecimal-decimal-colors.html

 

progressBarColor -> Here you can define the color of the progress bar.

This only has effect when progressBarType is set to Vanilla

Color values must be in decimal format. If you use the ingame config, it has to be a hex code. You can use this site to help with the conversion: https://www.mathsisfun.com/hexadecimal-decimal-colors.html

 

progressFrameColor -> Here you can define the color of the frame around the progress bar.

This only has effect when progressBarType is set to Vanilla

Color values must be in decimal format. If you use the ingame config, it has to be a hex code. You can use this site to help with the conversion: https://www.mathsisfun.com/hexadecimal-decimal-colors.html

 

customProgressBarMode -> This defines if your Custom progress bar texture should be stretched out or clipped to the percent loaded.

Valid values are Linear or Stretch

This only has effect when the progressBarType is set to Custom

 

customProgressBarBackground -> This defines if your custom progress bar also has a custom background

This only has effect when the progressBarType is set to Custom

Valid values are true or false

 

Textures

This section is about defining your custom images to use. Images must be placed inside your config/simplesplashscreen folder

Images can only be JPG or PNG. There is currently no support for any other image type. ALSO NOTE that image names CANNOT contain ANY CAPITAL LETTERS. This will result in a crash. This might be changed in a future version.

 

BackgroundTexture -> This is the name of your Background image to use.

MojangLogo -> The logo to use when the logoStyle is set to mojang

Aspect1to1Logo -> This is the image to use when logoStyle is set to Aspect1to1. This image must be a 512px x 512px image!

BossBarTexture -> This is the image to use when progressBarType is set to Bossbar

CustomBarTexture -> This is the image to use for your custom progress bar

CustomBarBackgroundTexture -> This is the image to use for your custom progress bar background

 

You can find out how to properly create these images here: Creating Custom Images

Creating Custom Images

This guide aims to help you create your own custom images so that they render correctly in the game.

 

Background Texture

This texture is pretty straight forward to create. It can be any size you want, but I recommend a minimum size of 1920px x 1080px.

This file must either be a JPG or PNG.

 

I don't recommend changing this file at all. Because of how Minecraft renders the logo, it's a tricky texture to create. If you really want to do it, use the included mojang logo as a template. The image size must be 512px by 512px and in PNG format.

 

This logo isn't as tricky. It just needs to be 512px x 512px and be in a PNG format.

 

Progress Bar Texture

This applies to both the BossBar and Custom progress bar. Your texture needs to be 400px x 10px in a PNG format. This also applies to the CustomBarBackgroundTexture