From 564df4b519a9dd35644cbd09df8f07eec7dd7c6c Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Thu, 13 May 2021 10:19:06 -0700 Subject: [PATCH 1/6] dude what i fixed it??? what??? screenshots??? --- docs/guides/weeks.md | 47 +++++++++++++++++++++++++++++++------------- 1 file changed, 33 insertions(+), 14 deletions(-) diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md index 8a6e3f3..cd2c2c8 100644 --- a/docs/guides/weeks.md +++ b/docs/guides/weeks.md @@ -4,6 +4,7 @@ 1. The ability to compile Kade Engine from the source code. All information related to building Kade Engine is listed [here.](https://kadedev.github.io/Kade-Engine/building) 2. A text editor. Some form of IDE that can support Haxe is recommended, such as Visual Studio Code. +--- ### Step 1. Navigation Navigate to your Kade Engine source code. In the `source` folder, look for `StoryMenuState.hx`. Open it in your text editor. @@ -11,7 +12,7 @@ Navigate to your Kade Engine source code. In the `source` folder, look for `Stor Scroll down to Line 26, or Search (Windows/Linux: `Ctrl+F`, Mac: `Cmd+F`) for "weekData". You should find an Array that looks like this: -===== +--- var weekData:Array = [ @@ -31,25 +32,26 @@ var weekData:Array = [ ]; -===== - Copy `['Senpai', 'Roses', 'Thorns']` into an empty line below it, and change the song names to the song names you want to use. Don't forget to add a comma at the end of the previous Week, and you have your songlist for the week completed! - -===== -Example: +Example +--- + +--- ['Ugh', 'Guns', 'Stress'] -===== +--- ### Step 3. Songlist Directly below the songlist should be an Array titled `weekCharacters`. This array tells the game what characters to display in the top yellow bar when a certain week is selected. It's not very useful unless you followed the Characters guide (will link to it once it's actually done). If you have, though, you can insert the name of your character into the first pair of quotes in a new "week". Example: -===== -Example: +Example +--- + +--- var weekCharacters:Array = [ @@ -71,13 +73,16 @@ var weekCharacters:Array = [ ]; -===== +--- ### Step 4. Week Names Underneath the song list, there should be another array called "weekNames". Creating a new line in that array, just enter a string that represents what you want the week to be called. -===== +Example +--- + +--- var weekNames:Array = [ @@ -99,14 +104,28 @@ var weekNames:Array = [ ]; - ===== - +--- + Now, compile the game, and if all goes correctly, the Story Mode menu shouldn't crash your game. If you make your way to the bottom of the list, there's your custom week! Except... its displaying as a HaxeFlixel Logo? ### Step 5. Graphics Displaying a week icon for your custom week is as simple as dropping a .png into `assets/images/storymenu`. Rename the file to "week7.png", "week8.png", etc. +Example +--- + +--- + +![frrf](https://user-images.githubusercontent.com/68293280/118160164-cdab6d00-b3d2-11eb-9b29-a940eaf45025.png) + +![frrf 2](https://user-images.githubusercontent.com/68293280/118160865-b8830e00-b3d3-11eb-8a23-818a1b4cfdb2.png) + +NOTE: You will have to add a new item to "weekUnlocked", so that the week is playable. + +![frrf 3](https://user-images.githubusercontent.com/68293280/118161461-7908f180-b3d4-11eb-89fa-e531ae5804d8.png) + + ### Conclusion -If you have followed all the steps correctly, you have successfully created a new week in the Story Mode. +If you followed all of the steps correctly, you have successfully created a new week in the Story Mode. From 1f85696f66f2a9bf0e327795b5f9bc152c52b199 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Thu, 13 May 2021 11:12:01 -0700 Subject: [PATCH 2/6] Prokube X Codebox Type Text --- docs/guides/weeks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md index cd2c2c8..8abfc56 100644 --- a/docs/guides/weeks.md +++ b/docs/guides/weeks.md @@ -110,7 +110,7 @@ var weekNames:Array = [ ### Step 5. Graphics -Displaying a week icon for your custom week is as simple as dropping a .png into `assets/images/storymenu`. Rename the file to "week7.png", "week8.png", etc. +Displaying a week icon for your custom week is as simple as dropping a .png into `assets/images/storymenu`. Rename the file to `week7.png`, `week8.png`, etc. Example --- From e1247e272b745cb37f79f1875b8ddad476164f9e Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Thu, 13 May 2021 11:16:00 -0700 Subject: [PATCH 3/6] WAIT WAIT WAIT there --- docs/guides/index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/guides/index.md b/docs/guides/index.md index 53c065c..4f18fbc 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -1,11 +1,10 @@ # Guides -There aren't any guides yet. But when there are, they'll be listed here. +[Creating A Custom Week](https://kadedev.github.io/Funkin/guides/weeks) ### Contributing If you'd like to write a guide, you can make a [pull request](https://github.com/KadeDev/Kade-Engine/pulls). Make sure you put the guide in `docs/guides/` and that it's written in Markdown. Guides that need to be written: - How to use the charting state/chart editor -- How to make custom weeks - How to make custom dialogue (like Week 6) - How to make custom characters From 04997abb2bf3b7b09c34d264dc69d02d76bb06c8 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Thu, 13 May 2021 12:32:01 -0700 Subject: [PATCH 4/6] "fix codeblock formatting pls" --- docs/guides/weeks.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md index 8abfc56..8ad51bf 100644 --- a/docs/guides/weeks.md +++ b/docs/guides/weeks.md @@ -44,7 +44,7 @@ Example --- -### Step 3. Songlist +### Step 3. Week Characters Directly below the songlist should be an Array titled `weekCharacters`. This array tells the game what characters to display in the top yellow bar when a certain week is selected. It's not very useful unless you followed the Characters guide (will link to it once it's actually done). If you have, though, you can insert the name of your character into the first pair of quotes in a new "week". Example: @@ -77,7 +77,7 @@ var weekCharacters:Array = [ ### Step 4. Week Names -Underneath the song list, there should be another array called "weekNames". Creating a new line in that array, just enter a string that represents what you want the week to be called. +Underneath the song list, there should be another array called `weekNames`. Creating a new line in that array, just enter a string that represents what you want the week to be called. Example --- @@ -121,7 +121,7 @@ Example ![frrf 2](https://user-images.githubusercontent.com/68293280/118160865-b8830e00-b3d3-11eb-8a23-818a1b4cfdb2.png) -NOTE: You will have to add a new item to "weekUnlocked", so that the week is playable. +NOTE: You will have to add a new item to `weekUnlocked`, so that the week is playable. ![frrf 3](https://user-images.githubusercontent.com/68293280/118161461-7908f180-b3d4-11eb-89fa-e531ae5804d8.png) From 61e35069fc43e32639801614a323a4a3c204733a Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Thu, 13 May 2021 12:52:09 -0700 Subject: [PATCH 5/6] consistency with codeblock usage --- docs/guides/weeks.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md index 8ad51bf..2c2668c 100644 --- a/docs/guides/weeks.md +++ b/docs/guides/weeks.md @@ -40,7 +40,7 @@ Example --- -['Ugh', 'Guns', 'Stress'] +`['Ugh', 'Guns', 'Stress']` --- From 8546dcbfde2f1e46f3c0ae1c891c483c6a29cd75 Mon Sep 17 00:00:00 2001 From: Puyo <15311104+daniel11420@users.noreply.github.com> Date: Thu, 13 May 2021 22:35:01 +0200 Subject: [PATCH 6/6] Update weeks.md --- docs/guides/weeks.md | 39 +++++++++++++++++++++++++++++++++------ 1 file changed, 33 insertions(+), 6 deletions(-) diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md index 2c2668c..90b89ca 100644 --- a/docs/guides/weeks.md +++ b/docs/guides/weeks.md @@ -14,6 +14,7 @@ Scroll down to Line 26, or Search (Windows/Linux: `Ctrl+F`, Mac: `Cmd+F`) for "w --- +```haxe var weekData:Array = [ ['Tutorial'], @@ -30,8 +31,11 @@ var weekData:Array = [ ['Senpai', 'Roses', 'Thorns'] - ]; - +]; +``` + +--- + Copy `['Senpai', 'Roses', 'Thorns']` into an empty line below it, and change the song names to the song names you want to use. Don't forget to add a comma at the end of the previous Week, and you have your songlist for the week completed! @@ -40,7 +44,27 @@ Example --- -`['Ugh', 'Guns', 'Stress']` +```haxe +var weekData:Array = [ + + ['Tutorial'], + + ['Bopeebo', 'Fresh', 'Dadbattle'], + + ['Spookeez', 'South', "Monster"], + + ['Pico', 'Philly', "Blammed"], + + ['Satin-Panties', "High", "Milf"], + + ['Cocoa', 'Eggnog', 'Winter-Horrorland'], + + ['Senpai', 'Roses', 'Thorns'], + + ['Ugh', 'Guns', 'Stress'] + +]; +``` --- @@ -53,6 +77,7 @@ Example --- +```haxe var weekCharacters:Array = [ ['', 'bf', 'gf'], @@ -72,7 +97,8 @@ var weekCharacters:Array = [ ['tankman', 'bf', 'gf'] ]; - +``` + --- ### Step 4. Week Names @@ -83,7 +109,7 @@ Example --- --- - +```haxe var weekNames:Array = [ "How to Funk", @@ -103,7 +129,8 @@ var weekNames:Array = [ "Tankman" ]; - +``` + --- Now, compile the game, and if all goes correctly, the Story Mode menu shouldn't crash your game. If you make your way to the bottom of the list, there's your custom week! Except... its displaying as a HaxeFlixel Logo?