Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Modlauncher for CNE inspired by lunacynne

CODENAME - ENGINE TEMPLATE - Modlauncher-meta OG - Modlauncher preview1 preview2

Overview

🎮 Controls

  • Left/Right Arrows (or A/D): Cycle through available mods
  • Enter: Select the current mod
  • Escape / Back: Exit to the main menu
  • 'I' key: Open the mod information window (InfoSubstate)
  • Left mouse button: Click on the side arrows, the mod icon, the 'INFO' or 'ESCAPE' text

🛠️ Installation

  1. Copy the addon files to the addons/Modlauncher directory in the root of your game.
  2. Add your mods to the mods/ folder and configure them according to the guide above.
  3. Add the meta folder. Meta Folder Template

🌟 Key Features

  • Interesting interface: Wii-like mod selection menu with mesh support, dynamic shadows, and visual effects
  • Custom BG/icon: You can display your mod in the modlauncher however you like! Simply add your icon and background image to the meta folder, then adjust the icon scale in the '/meta/info.json' file.
  • Metadata Reading: Automatic parsing of the modpack.ini file to display the mod's Name, Description, Author, and Version
  • Info Window: Built-in pop-up menu (substate) for viewing detailed information about the selected mod
  • Auto-scaling: The launcher automatically adjusts the window resolution to 1280x720 upon launch and correctly restores the previous screen resolution upon returning to the main menu.
  • Full mouse/sensor support: Switch mods, open information, and close the launcher using the cursor
  • Custom sounds: Support for random mod selection sounds loaded from the meta/enter/ (or meta/default.ogg) folder

🎨 Mod Customization

The launcher offers extensive visual customization options for each individual mod. All customization files should be located in the mods/YOUR_MOD/meta folder:

📂 Mod File Structure (Example)

└── YOUR_MOD/
├── data/
│ └── config/
│ └── modpack.ini <-- Information (Name, Author, Description)
├── meta/
│ ├── icon.png <-- Mod Icon
│ ├── info.json <-- Icon configuration file
│ ├── bg.png <-- Mod Background
│ ├── bg-anim.png / .xml <-- Animated Background (Optional)
│ ├── intro.hxs <-- Custom selection animation script
│ ├── bg.hxs <-- Custom background script
│ └── enter/ <-- Folder with randomly selected sounds (.ogg)
│ ├── sound1.ogg
│ └── sound2.ogg
└── shaders/ <-- Shaders for background (.frag / .vert)

Visual

  • Icons: Place the mod icon at meta/icon.png or icon.png. Resizing is supported via info.json
  • Static Backgrounds: The supported files are meta/bg.png or bg-intro.png
  • Animated Backgrounds: You can use Sparrow Atlas-based animations (.png and .xml). Place them at meta/bg-anim or bg-anim-intro

Scripting and Shaders (GLSL)

The launcher supports embedding custom code via HScript:

  • Background Scripts: Create meta/bg.hxs to control the background with code
  • Intro Scripts: Create meta/intro.hxs to program complex animations when selecting a mod
  • Shaders: Support for loading custom GLSL shaders (.frag and .vert)

Releases

Packages

Contributors

Languages