https://github.com/kade-github/menu-core
A FNF helper mod to enable multiple custom main menus and mod content switching.
https://github.com/kade-github/menu-core
Last synced: 4 months ago
JSON representation
A FNF helper mod to enable multiple custom main menus and mod content switching.
- Host: GitHub
- URL: https://github.com/kade-github/menu-core
- Owner: Kade-github
- Created: 2025-09-05T21:48:30.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2025-09-06T00:05:17.000Z (4 months ago)
- Last Synced: 2025-09-06T00:16:11.097Z (4 months ago)
- Size: 2.75 MB
- Stars: 5
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Menu Core
> A FNF helper mod to enable multiple custom main menus and mod content switching.
**Current Funkin' Version:** `0.7.4`
A Friday Night Funkin' mod to enable a custom menu at the start of the game. This menu will allow the user to switch between different mods and their own custom menus, to allow for custom mod content to be enabled/disabled, or grouped together.
# Download
Head over to the [latest release](https://github.com/Kade-github/Menu-Core/releases/latest), and extract the folder `menu-core` into your mods folder!
## Modders: How to implement?
```haxe
package kade.hex;
import kade.hex.states.HexMainMenu;
import funkin.modding.module.Module;
import flixel.FlxState;
import funkin.modding.module.ModuleHandler;
class HMenuCore extends Module {
var modName = "VS Hex";
var modDescription = "V.S Hex v3";
var modAssetKey = "mc_hex";
var modState = null;
public function new() {
// Priority is set to 3 here.
super("HMenuCore", 3);
}
public function addVersion()
{
var mcHandle = ModuleHandler.getModule("MC_Data");
if (mcHandle == null) {
trace("MenuCore: MC_Data not found!");
return;
}
if (mcHandle.versions.indexOf(modName) != -1) {
// Already added
return;
}
modState = new HexMainMenu();
mcHandle.addVersion(modName, modAssetKey, modDescription, modState);
}
public override function onStateChangeBegin(event:StateChangeScriptEvent):Void {
super.onStateChangeBegin(event);
addVersion();
}
public override function onCreate(event):Void {
super.onCreate(event);
addVersion();
}
}
```
You will create a module like so, name it whatever. Make sure it's `priority` is after **2**! After that, copy the three other non-constructor functions and change the top properties to what you'd like!
```haxe
var modName = "VS Hex";
var modDescription = "V.S Hex v3";
var modAssetKey = "mc_hex";
```
Then at the bottom (in the `addVersion` method) you'll see
```haxe
modState = new HexMainMenu();
```
It's very important that you create a new custom state, like so:
```haxe
package kade.hex.states;
import funkin.ui.MusicBeatState;
class HexMainMenu extends MusicBeatState {
public function new():Void {
super();
}
public override function create():Void {
super.create();
}
public override function update(elapsed:Float):Void {
super.update(elapsed);
}
}
```
Then take that state and instantiate it in that variable.
The next step is to take the `mc_template.png` asset and change it to your mod's own icon.
Then put it in your mods `shared/images/` folder, and you'll be done!
### Todo
- Mobile Support
- Animation for selection
### Credits
> Music
Created by Kade
> Assets
Created by YingYang
*Originally created for V.S Hex v3!*