Bertogim-LoadingScreen icon

LoadingScreen

A fork of BepInEx.SplashScreen, with a different UI, and some things fixed

Last updated 6 days ago
Total downloads 5880
Total rating 4 
Categories Misc Client-side
Dependency string Bertogim-LoadingScreen-1.0.8
Dependants 16 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

Loading preview

This is a cool mod if you want to disable the console and have a visible loading bar! It's also very useful for tracking progress when loading large modpacks.

Custom loading image

  • If you're making a mod, create a folder named LoadingScreen anywhere inside your mod, and place a LoadingImage.png file inside it. The loading screen search is something like this: BepInEx/plugins/*/LoadingScreen/LoadingImage.png

  • If you're making a modpack and want to add or override a mod's loading image, simply place your LoadingImage.png (you can name it whatever you want in this case) inside BepInEx/patchers/Bertogim-LoadingScreen.

About the fork

BepInEx.SplashScreen.GUI.exe is renamed to LoadingScreen.GUI.exe to try to fix discord activity detecting the loading screen as other game

This fork is only tested with Lethal Company but it should work with other games

Got issues or feedback?

Feel free to open an issue at https://github.com/Bertogim/BepInEx.SplashScreen/issues

Or you can open the discord thread:
https://discordapp.com/channels/1168655651455639582/1364323192423977002
To open the link on the discord app jusy replace the https:// by discord://

Config

Config can be seen in Bertogim.LoadingScreen.cfg.

Window type

FakeGame = Makes a window with the same icon as the game, tries to mimic the game till it appears

FixedWindow = A fixed loading screen on top of all windows, cant move or close and is not on the taskbar (Same behavior as v1.0.5 and less)

Window width

The window width in pixels (Gets affected by windows screen scale config)

More configs in the config file!

You can disable the BepInEx console in BepInEx\config\BepInEx.cfg ([Logging.Console] > Enabled = false), since the loading window will act as the game with FakeGame.

BepInEx Loading Progress Splash Screen

A BepInEx patcher that displays a loading screen on game startup with information about patchers and plugins being currently loaded. It's best suited for games where patchers and plugins take a long time to initialize.

This patcher is mostly meant for inclusion in modpacks to give end-users immediate feedback after starting a heavily modded game. It can sometimes take a long time for the game window to appear and/or become responsive - especially on slow systems - which can be interpretted by the user as the game crashing.

🛠️ This project is a fork of BepInEx/BepInEx.SplashScreen wich is a fork of an early version of risk-of-thunder/BepInEx.GUI, with significant modifications and repackaging. While the original GUI code served as a starting point, most of it has been rewritten.

How to use

  1. Install BepInEx 5.4.15 or later, or 6.0.0-be.674 or later (works on both mono and IL2CPP). (This fork does not support BepInEx 6)
  2. Download latest release for your BepInEx version.
  3. Extract the release so that the patcher files end up inside BepInEx\patchers.
  4. You should now see the splash screen appear on game start-up, assuming BepInEx is configured properly.

Splash screen doesn't appear

  1. Make sure that LoadingScreen.GUI.exe and BepInEx.SplashScreen.Patcher.dll are both present inside the BepInEx\patchers folder.
  2. Check if the splash screen isn't disabled in BepInEx\config\BepInEx.cfg. If you can't see this file or the SplashScreen Enable setting, it means either BepInEx isn't correctly configured or this patcher is failing to start for some reason.
  3. Update BepInEx 5 to latest version and make sure that it is running.
  4. If the splash screen still does not appear, check the game log for any errors or exceptions. You can report issues on GitHub.

Contributing

Feel free to start issues, and by all means submit some PRs! Contributions should be submitted to the repository at https://github.com/Bertogim/BepInEx.SplashScreen.

You can discuss changes and talk with other modders on the official BepInEx Discord server.

Compiling

Clone the repository and open the .sln with Visual Studio 2022 (with .NET desktop development and .NET 3.5 development tools installed). Hit Build Solution and it should just work.