community category

Author: Kade-github

assets/content/cookbook/Community/01.Community.md

@@ -0,0 +1,7 @@
+# Community Articles
+
+This series of articles dictates tutorials for **custom** content, meaning not supported by the game (or provided).
+
+Though community members have created this content to make modding easier, so you can view it in this series.
+
+> Author: [Kade](https://github.com/Kade-github)

assets/content/cookbook/Community/02.MenuCore.md

@@ -0,0 +1,90 @@
+# Menu Core
+<img width="640" height="360" alt="image" src="https://github.com/user-attachments/assets/52320c53-0084-4494-8376-c11ec65e7125" />
+
+
+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.
+
+## Setting up
+
+Download the latest version of MenuCore, [here](https://github.com/Kade-github/Menu-Core/releases/latest).
+
+Then extract the folder into your `mods/` directory.
+
+You are now ready to start using menu core
+
+## Using Menu Core
+
+Inside of your *mod* (not MenuCore), create a new Module:
+
+```haxe
+package kade.hex;
+
+import kade.hex.states.HexMainMenu;
+
+import funkin.modding.module.Module;
+import funkin.modding.module.ModuleHandler;
+
+import flixel.FlxState;
+
+class HMenuCore extends Module {
+    var addedVersion:Bool = false;
+
+    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();
+```
+
+This will be what state will be created by MenuCore (and where the user will be sent too). To find out more about how to create states like this, please check out the [Scripted States](../Expert/03.ScriptedStates.md) article.
+
+> Author: [Kade](https://github.com/Kade-github)

assets/content/cookbook/Expert/03.ScriptedStates.md

@@ -1,7 +1,65 @@
-[tags]: / "expert,hscript,module"
+[tags]: / "expert,hscript"
 
 # Scripted States
 
-todo :P
+Creating scripted states is the most powerful thing in the modding framework, it basically lets you create entirely custom... *things*. Be it a menu, object, or entirely different game!
 
-> Author: [Kade](https://github.com/Kade-github)
+## Creating a custom menu
+
+A typical custom MusicBeatState (Menu) might look like this:
+
+```haxe
+package kade.menucore.states;
+
+import flixel.FlxSprite;
+import flixel.text.FlxText;
+
+import funkin.ui.MusicBeatState;
+import funkin.ui.FullScreenScaleMode;
+
+class MenuSwitch extends MusicBeatState {
+
+    public function new():Void {
+        super();
+    }
+
+    public override function create():Void {
+        super.create();
+
+        var bg = new FlxSprite();
+        // ... bg code
+        add(bg);
+
+        var chooseBlackBar = new FlxSprite(0, 0);
+        // ... black bar code
+        add(chooseBlackBar);
+
+        var choose = new FlxText(Math.max(FullScreenScaleMode.gameNotchSize.x, 6), 2, FlxG.width, "CHOOSE THE VERSION");
+        // ... choose text code
+        add(choose);
+
+        var topRightText = new FlxText(0, 15, FlxG.width / 2, "");
+        // ... top right text code
+        add(topRightText);
+
+        // Middle black bar of bg
+        var blackBar = new FlxSprite(0, 0);
+        // ... middle bar code
+        add(blackBar);
+
+        // ...
+    }
+
+    public override function update(elapsed:Float):Void {
+        super.update(elapsed);
+    }
+}
+```
+
+Looking at this code, it looks scarily similar to the actual source code of the game - and that's the point. You're basically given the tools to create your own states, in which you control entirely. This allows for custom menus, and different games entirely.
+
+The limit really, is your imagination.
+
+For community examples of custom states/objects/helpers, check out [here](../Community/Community.md)
+
+> Author: [Kade](https://github.com/Kade-github)

src/Generator.hx

@@ -61,6 +61,10 @@ class Generator {
 		sitemap.remove(expertCategory);
 		sitemap.push(expertCategory);
 
+		var communityCategory = sitemap.filter(function(c) return c.title.toLowerCase() == "community")[0];
+		sitemap.remove(communityCategory);
+		sitemap.push(communityCategory);
+
 		// add overview page for each category
 		addCategoryPages(sitemap);