Skip to content

Commit 72640af

Browse files
Update modding docs to v0.6.2.
1 parent 2d209ea commit 72640af

File tree

3 files changed

+35
-2
lines changed

3 files changed

+35
-2
lines changed

src/01-fundamentals/01-01-the-metadata-file.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Inside this file, we will put the information the game needs in order to learn a
1919
"optionalDependencies": {
2020
"modB": "1.3.2"
2121
},
22-
"api_version": "0.5.0",
22+
"api_version": "0.6.2",
2323
"mod_version": "1.0.0",
2424
"license": "Apache-2.0"
2525
}
@@ -37,7 +37,7 @@ Inside this file, we will put the information the game needs in order to learn a
3737
- The mod list will be reordered such that dependencies load first.
3838
- `optionalDependencies`: A map of mod IDs which are optional dependencies, along with their version numbers.
3939
- These mods do not necessarily need to be installed for this mod to load, but they will still force the mod list to be reordered so that the dependencies load before this mod.
40-
- `api_version`: A version number used to determine if mods are compatible with your copy of Funkin'. Change this to the version number for Friday Night Funkin' that you want to support, preferably the latest one (`0.5.0` at time of writing.).
40+
- `api_version`: A version number used to determine if mods are compatible with your copy of Funkin'. Change this to the version number for Friday Night Funkin' that you want to support, preferably the latest one (`0.6.2` at time of writing.).
4141
- `mod_version`: A version number specifically for your mod. Choose any version or leave it at `1.0.0`.
4242
- `license`: The license your mod is distributed under. [Pick one from here](https://opensource.org/licenses) or just leave it as `Apache-2.0`.
4343

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Migrating from v0.5.0 to v0.6.0
2+
3+
Migration from v0.5.0 to v0.6.0 requires only minor changes to mods, and won't break most mods.
4+
5+
# Migrate from hxCodec to hxvlc
6+
7+
The library used for video playback has changed from hxCodec to hxvlc. This has resulted in improved performance and various bug fixes overall, but breaks mods which interact directly with the video library. This should not break any mods which use the built-in system for cutscenes in Funkin'.
8+
9+
Make the following changes:
10+
11+
```haxe
12+
// BEFORE: Imports from the package `hxcodec`
13+
import hxcodec.flixel.FlxVideoSprite;
14+
15+
// AFTER: Imports from the package `hxvlc`
16+
import hxvlc.flixel.FlxVideoSprite;
17+
18+
19+
// BEFORE: Callback to onTextureSetup
20+
video.bitmap.onTextureSetup.add(() -> { ... });
21+
22+
// AFTER: Callback to onFormatSetup
23+
video.bitmap.onFormatSetup.add(() -> { ... });
24+
25+
26+
// BEFORE: Play a video by path.
27+
video.play(videoPath);
28+
29+
// AFTER: Load a video by path, then play if load was successful.
30+
// You can also run video.load() in advance before playing the video.
31+
if (video.load(videoPath)) video.play();
32+
```

src/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@
4141

4242
- [Migration](09-migration/09-00-migrating-mods-to-newer-versions.md)
4343
- [v0.1.0 to v0.5.0](09-migration/09-01-0.1.0-to-0.5.0.md)
44+
- [v0.5.0 to v0.6.0](09-migration/09-01-0.5.0-to-0.6.0.md)
4445

4546
- [Appending And Merging Files](10-appending-and-merging-files/10-00-appending-and-merging-files.md)
4647
- [Appending Files](10-appending-and-merging-files/10-01-appending-files.md)

0 commit comments

Comments
 (0)