Work in progress on some more rewrites to the scripted classes section.

Author: EliteMasterEric

src/05-custom-playable-characters/05-01-TODO.md

@@ -0,0 +1,28 @@
+# Required Assets
+
+In order to make a fleshed out custom character that can be used from Character Select in Friday Night Funkin', you need a large number of textures, animations, and audio tracks:
+
+- A [custom character](03-custom-characters/03-00-custom-characters.md)
+    - This requires a set of singing animations for the character.
+- At least one custom song that uses that character; this can be either [a new song](02-custom-songs-and-custom-levels/02-02-adding-the-custom-song.md) or a [variation added to an existing song](02-custom-songs-and-custom-levels/02-05-adding-variations-to-existing-songs.md).
+    - This requires an instrumental and split vocal tracks.
+- A pixel icon asset to use for that character's icon in the Character Select grid.
+    - This supports either a static image or a Sparrow spritesheet (which includes the animation to play when the character is selected).
+- A namecard asset to use for that character's name above them in the Character Select menu.
+    - The pixellation effect is done in code so this just needs to be a single static image.
+- Animations for the character to use in the Character Select menu.
+    - This is currently hard-coded to use an Adobe Animate texture atlas and cannot use a Sparrow spritesheet.
+    - The character needs animations for unlock, idle, slide in, slide out, select, and deselect.
+- Assets to use for the character's Girlfriend character to the left of them in the Character Select menu.
+    - This is currently hard-coded to use an Adobe Animate texture atlas and cannot use a Sparrow spritesheet.
+    - The character needs animations for unlock, idle, slide in, slide out, select, and deselect.
+    - NOTE: This is hardcoded to use only GF or Nene right now I swear I'll fix this soon.
+- Assets for the character to use on the Freeplay menu.
+    - This is currently hardcoded to use an Adobe Animate texture atlas.
+    - The character needs animations for leaping in, idle, confirm, and moving to character select. It also optionally has an idle and cartoon animation.
+- Assets for the character's Freeplay skin and the backing card.
+    - This requires a variety of assets but can use Boyfriend's as a fallback.
+- Assets for the character's animations in the Results screen.
+    - Each rank has its own animation and music, but animations can be reused between ranks and results themes can fall back to the default.
+    - Rank animations are Loss, Good, Great, Excellent, Perfect, and Perfect Gold (the base game uses the same animation for Perfect and Perfect Gold)
+    - Each also can take its own music, but you can reuse Boyfriend's as a good placeholder.

src/05-custom-playable-characters/05-01-required-assets.md

@@ -59,4 +59,4 @@ And Polymod will mutate it to get this result:
 }
 ```
 
-If you want something more particular, see [Merging into JSON Files](./10-02-merging-files.md#merging-into-json-files) from [5.2 Merging Files](10-02-merging-files.md) for a more powerful and flexible approach.
+If you want something more particular, see [Merging into JSON Files](./10-02-merging-files.md#merging-into-json-files) for a more powerful and flexible approach.

src/10-appending-and-merging-files/10-01-appending-files.md

@@ -0,0 +1,58 @@
+# Scripted Classes
+
+Funkin's implementation of HScript uses a system of scripted classes. To create a scripted class, create an `.hxc` file in your `mods/mymod/scripts/` folder, and, using Haxe syntax, create a new class which extends the base class for the type of object you are scripting, like so:
+
+```haxe
+// Remember to import each class you want to reference in your script!
+import funkin.play.song.Song;
+
+// Choose a name for your scripted class that will be unique
+// Also specify the class you are extending, we choose Song here.
+// This script's behaviors will extend the default behavior of the song.
+class BallisticSong extends Song {
+	public function new() {
+        // You have to call the super constructor for the class you are extending, which may have different parameters.
+        // Check the specific documentation for more info.
+		super('ballistic');
+	}
+}
+```
+
+## List of Scriptable Classes
+
+There is a predefined list of classes which the game has set up to be scriptable, and will automatically load and execute when relevant. More of these will be added in the future.
+
+- `funkin.play.song.Song` for providing unique behavior to custom songs, including playing cutscenes and other stuff. See [Scripted Songs](21-scripted-classes/21-01-scripted-songs.md).
+	- See also [Video Cutscenes](21-scripted-classes/21-03-video-cutscenes.md), [Ingame Cutscenes](21-scripted-classes/21-04-ingame-cutscenes.md), and [Dialogue Cutscenes](21-scripted-classes/21-05-dialogue-cutscenes.md)
+- `funkin.play.character.BaseCharacter` for providing unique behavior to custom characters (such as playing custom animations in certain circumstances). See [Scripted Characters](21-scripted-classes/21-05-scripted-characters.md).
+	- Note that you need to choose the correct subclass of this class for the animation type of your character!
+	- `funkin.play.character.SparrowCharacter` is used for characters that have Sparrow spritesheet animations.
+	- `funkin.play.character.MultiSparrowCharacter` is used for characters that have several Sparrow spritesheet animations to combine into one character.
+	- `funkin.play.character.PackerCharacter` is used for characters that have Packer spritesheet animations.
+	- `funkin.play.character.AnimateAtlasCharacter` is used for characters that have Adobe Animate texture atlases.
+- `funkin.play.stage.Stage` for providing unique behavior to custom stages, such as creating custom moving props and defining when props animate or when sound effects play in sync with the stage. See [Scripted Stages](21-scripted-classes/24-06-scripted-stages.md).
+- `funkin.ui.story.Level` for providing unique behavior to levels in Story Mode. See [Scripted Story Levels](21-scripted-classes/25-07-scripted-story-levels.md).
+- `funkin.play.notes.notekind.NoteKind` for providing unique visuals and behavior to certain kinds of notes, which can then be placed in the Chart Editor. See [Custom Note Kinds](21-scripted-classes/26-00-custom-note-kinds.md).
+- `funkin.play.event.SongEvent` for creating custom Song Events, which you can place in the Chart Editor and which perform game actions when they are reached. See [Custom Song Events](21-scripted-classes/28-00-custom-note-kinds.md)
+- `funkin.ui.freeplay.charselect.PlayableCharacter` for providing unique behavior to custom playable characters. See [Scripted Playable Characters](21-scripted-classes/25-10-scripted-playable-characters.md)
+- `funkin.ui.freeplay.FreeplayStyle` for defining the sprites and colors used by the Freeplay menu when a given character is selected. See [WIP]
+- `funkin.play.notes.notestyle.NoteStyle` for modifying the behavior of custom note styles. See [WIP]
+- `funkin.play.cutscene.dialogue.Conversation` for providing unique behavior to custom dialogue conversations. See [Dialogue Cutscenes](21-scripted-classes/21-05-dialogue-cutscenes.md)
+- `funkin.play.cutscene.dialogue.DialogueBox` for providing unique behavior to custom dialogue boxes used in conversations. See [Dialogue Cutscenes](21-scripted-classes/21-05-dialogue-cutscenes.md)
+- `funkin.play.cutscene.dialogue.Speaker` for providing unique behavior to custom speakers used in conversations. See [Dialogue Cutscenes](21-scripted-classes/21-05-dialogue-cutscenes.md)
+- `funkin.ui.freeplay.Album` for defining custom behavior for Freeplay Albums. See [WIP]
+
+There is also `funkin.modding.module.Module` for custom scripted Modules, which are scripts which receive events everywhere, rather than only in a specific context. See [Scripted Modules](30-scripted-modules/30-00-scripted-modules.md) for more information on how these work.
+
+There are also scripted classes are also set up to be scriptable, but will only be useful if they're accessed from another script. Expect more of these to be added in the future.
+
+- `funkin.graphics.FunkinSprite` for basic static or animated sprites.
+- `funkin.graphics.adobeanimate.FlxAtlasSprite` for generic sprites which use Adobe Animate texture atlases
+- `flixel.group.FlxSpriteGroup` for groups of sprites which are included inside a state and manipulated together
+- `funkin.ui.MusicBeatState` for groups of sprites which represents a given game state. Includes additional utilities for handling script events.
+- `funkin.ui.MusicBeatSubState` for groups of sprites representing a substate of an existing state
+- `flixel.addons.display.FlxRuntimeShader` for custom GLSL shaders
+- `funkin.play.stage.Bopper` for sprites which will play an idle animation to the beat of the music when they are part of a Stage.
+- `flixel.FlxSprite` for basic static or animated sprites. Use this only if you can't use FunkinSprite.
+- `flixel.FlxState` for basic groups of sprites which represent a given game state. Use this only if you can't use MusicBeatState.
+- `flixel.FlxSubState` for groups of sprites representing a substate of an existing state

src/20-using-hscript/20-02-scripted-classes.md

@@ -0,0 +1,27 @@
+# Creating a Friday Night Funkin' Mod - Scripted Songs
+
+This guide will walk you through the process of creating a functioning, fully compatible Friday Night Funkin' mod, using the game's official systems for loading custom content and scripts. Once your mod is complete, you will be able to place it in the `mods` folder in your game install and use its content in-game without overriding the base game content and still maintain compatibility with other mods.
+
+This chapter will walk you through the process of adding a script to a Song, and giving examples of the kind of custom behavior which can be implemented with this functionality.
+
+Start by creating a scripted class file with the `.hxc` extension (in the `mods/mymod/scripts/songs` if you want to keep things organized).
+
+```haxe
+// Remember to import each class you want to reference in your script!
+import funkin.play.song.Song;
+
+// Choose a name for your scripted class that will be unique, and make sure to specifically extend the Song class.
+// This class's functions will override the default behavior for the song.
+class BallisticSong extends Song {
+	public function new() {
+        // The constructor gets called once, when the game loads.
+        // The constructor takes one parameter, which is the song ID for the song you are applying the script to.
+		super('ballistic');
+	}
+
+    // Add override functions here!
+}
+```
+
+You can then add override functions to perform custom behavior. Here are some useful snippets:
+

src/21-scripted-classes/21-00-scripted-classes.md

@@ -1,5 +1,5 @@
-# Creating a Friday Night Funkin' Mod - Cutscenes
+# Creating a Friday Night Funkin' Mod - Video Cutscenes
 
 This guide will walk you through the process of creating a functioning, fully compatible Friday Night Funkin' mod, using the game's official systems for loading custom content and scripts. Once your mod is complete, you will be able to place it in the `mods` folder in your game install and use its content in-game without overriding the base game content and still maintain compatibility with other mods.
 
-This chapter will specifically walk through using scripted Songs to implement the three different types of cutscenes into a mod; Video Cutscenes, Dialogue Cutscenes, and Ingame Cutscenes.
+This chapter will specifically walk through using scripted Songs to implement a Video Cutscene into a mod.

src/21-scripted-classes/21-01-scripted-songs.md

@@ -0,0 +1,5 @@
+# Creating a Friday Night Funkin' Mod - Ingame Cutscenes
+
+This guide will walk you through the process of creating a functioning, fully compatible Friday Night Funkin' mod, using the game's official systems for loading custom content and scripts. Once your mod is complete, you will be able to place it in the `mods` folder in your game install and use its content in-game without overriding the base game content and still maintain compatibility with other mods.
+
+This chapter will specifically walk through using scripted Songs to implement an Ingame Cutscene into a mod.

src/22-cutscenes/22-00-cutscenes.md renamed to src/21-scripted-classes/21-02-video-cutscenes.md

@@ -0,0 +1,5 @@
+# Creating a Friday Night Funkin' Mod - Dialogue Cutscenes
+
+This guide will walk you through the process of creating a functioning, fully compatible Friday Night Funkin' mod, using the game's official systems for loading custom content and scripts. Once your mod is complete, you will be able to place it in the `mods` folder in your game install and use its content in-game without overriding the base game content and still maintain compatibility with other mods.
+
+This chapter will specifically walk through using scripted Songs to implement Dialogue Cutscenes into a mod, like those seen in Week 6.

src/21-scripted-classes/21-03-ingame-cutscenes.md

@@ -1,5 +1,5 @@
-# Creating a Friday Night Funkin' Mod - Scripted Songs
+# Creating a Friday Night Funkin' Mod - Scripted Note Kinds
 
 This guide will walk you through the process of creating a functioning, fully compatible Friday Night Funkin' mod, using the game's official systems for loading custom content and scripts. Once your mod is complete, you will be able to place it in the `mods` folder in your game install and use its content in-game without overriding the base game content and still maintain compatibility with other mods.
 
-This chapter will walk you through the process of adding a script to a Song, and giving examples of the kind of custom behavior which can be implemented with this functionality.
+This chapter will walk you through the process of adding a script to a Note Kind, and giving examples of the kind of custom behavior which can be implemented with this functionality.

src/21-scripted-classes/21-04-dialogue-cutscenes.md

@@ -1,5 +1,5 @@
-# Creating a Friday Night Funkin' Mod - Scripted Stages
+# Creating a Friday Night Funkin' Mod - Scripted Song Events
 
 This guide will walk you through the process of creating a functioning, fully compatible Friday Night Funkin' mod, using the game's official systems for loading custom content and scripts. Once your mod is complete, you will be able to place it in the `mods` folder in your game install and use its content in-game without overriding the base game content and still maintain compatibility with other mods.
 
-This chapter will walk you through the process of adding a script to a Story Mode Level, and giving examples of the kind of custom behavior which can be implemented with this functionality.
+This chapter will walk you through the process of adding a script to a Song Event, and giving examples of the kind of custom behavior which can be implemented with this functionality.

src/23-scripted-characters/23-00-scripted-characters.md renamed to src/21-scripted-classes/21-05-scripted-characters.md

@@ -30,6 +30,8 @@
     - [Using a Stage in a Song](04-custom-stages/04-02-using-a-stage-in-a-song.md)
 
 - [WIP: Custom Playable Characters](05-custom-playable-characters/05-00-custom-playable-characters.md)
+    - [Required Assets](05-custom-playable-characters/05-01-required-assets.md)
+    - Implementing a Playable Character
 
 - [Custom Note Styles](06-custom-notestyles/06-00-custom-notestyles.md)
     - [Creating a Note Style](06-custom-notestyles/06-01-creating-a-notestyle.md)