Skip to content

Commit 9fa84ab

Browse files
Add docs regarding the API version increment.
1 parent 43a1ca2 commit 9fa84ab

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
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.6.2",
22+
"api_version": "0.6.3",
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.6.2` 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.3` 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

src/09-migration/09-02-0.5.0-to-0.6.0.md renamed to src/09-migration/09-02-0.5.0-to-0.6.3.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
1-
# Migrating from v0.5.0 to v0.6.0
1+
# Migrating from v0.5.0 to v0.6.3
22

3-
Migration from v0.5.0 to v0.6.0 requires only minor changes to mods, and won't break most mods.
3+
Migration from v0.5.0 to v0.6.3 requires some changes to mods.
4+
5+
# Update the API Version
6+
7+
Eric accidentally forgot to increment the API version for the game when updating to v0.6.0, and this got fixed with v0.6.3.
8+
This means that mods won't load unless the `api_version` value in the `_polymod_meta.json` file is at least v0.6.3. This allows mod creators to perform testing and ensure their mods are compatible before releasing an update on their distribution platforms of choice. Most mods (especially ones with minimal scripting) will need no changes to work as expected, but developers should probably do some playtesting to be sure.
49

510
# Migrate from hxCodec to hxvlc
611

@@ -57,6 +62,6 @@ if (Std.isOfType(currentState, OptionsState)) {
5762

5863
# Sticker Changes
5964

60-
v0.6.0 rewrote how stickers get used by the game (and v0.6.3 rewrote it again but better this time). Any existing mods that provided stickers will break.
65+
v0.6.0 rewrote how stickers get used by the game (and v0.6.3 rewrote it again but better this time). Any existing mods that provided stickers will probably break.
6166

6267
New or updating mods looking to add, remove, or replace stickers should consult the [custom Sticker Packs documentation](../07-custom-sticker-packs/07-00-custom-sticker-packs.md)

src/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +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-02-0.5.0-to-0.6.0.md)
44+
- [v0.5.0 to v0.6.3](09-migration/09-02-0.5.0-to-0.6.3.md)
4545

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

0 commit comments

Comments
 (0)