From ce36e49c5814d260fa7b4adeade79b9dc8bf5e24 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Wed, 12 May 2021 08:33:08 -0700 Subject: [PATCH 1/5] Easy one out the way (mostly) also btw i hate Markdown's code text logic --- docs/guides/weeks.md | 90 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 docs/guides/weeks.md diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md new file mode 100644 index 0000000..85217d2 --- /dev/null +++ b/docs/guides/weeks.md @@ -0,0 +1,90 @@ +# Creating A Custom Week + +## Requirements +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. + +### Step 2. Songlist + +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 = [ + + ['Tutorial'], + + ['Bopeebo', 'Fresh', 'Dadbattle'], + + ['Spookeez', 'South', "Monster"], + + ['Pico', 'Philly', "Blammed"], + + ['Satin-Panties', "High", "Milf"], + + ['Cocoa', 'Eggnog', 'Winter-Horrorland'], + + ['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! + + ### 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: + +===== + +var weekCharacters:Array = [ + + ['', 'bf', 'gf'], + + ['dad', 'bf', 'gf'], + + ['spooky', 'bf', 'gf'], + + ['pico', 'bf', 'gf'], + + ['mom', 'bf', 'gf'], + + ['parents-christmas', 'bf', 'gf'], + + ['senpai', 'bf', 'gf'], + + ['tankman', 'bf', 'gf'] + + ]; + +===== + +### Step 3. 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. + +===== + +var weekNames:Array = [ + "How to Funk", + "Daddy dearest", + "Spooky Month", + "PICO", + "Mommy Must Murder", + "Red Snow", + "Hating Simulator ft. Moawlings", + "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? + + ### Step 4. Graphics + + Being honest here, Prokube doesn't really know. More information will be added later, but for now I gotta go. From 54d4726b7e354ddf72d120007d255fcb84790536 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Wed, 12 May 2021 12:38:47 -0700 Subject: [PATCH 2/5] They were twins!! :DD Not anymore --- docs/guides/weeks.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md index 85217d2..6c87126 100644 --- a/docs/guides/weeks.md +++ b/docs/guides/weeks.md @@ -33,14 +33,23 @@ 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! +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: + +['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: var weekCharacters:Array = [ @@ -64,7 +73,7 @@ var weekCharacters:Array = [ ===== -### Step 3. Week Names +### 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. @@ -78,13 +87,13 @@ var weekNames:Array = [ "Mommy Must Murder", "Red Snow", "Hating Simulator ft. Moawlings", - "Tankman" + "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? - ### Step 4. Graphics + ### Step 5. Graphics Being honest here, Prokube doesn't really know. More information will be added later, but for now I gotta go. From a895532e0ae7da9f8722fd7dc9645219e46dc482 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Wed, 12 May 2021 16:05:53 -0700 Subject: [PATCH 3/5] Fix the way the examples display :/ :/ --- docs/guides/weeks.md | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md index 6c87126..65c1c0b 100644 --- a/docs/guides/weeks.md +++ b/docs/guides/weeks.md @@ -80,15 +80,24 @@ Underneath the song list, there should be another array called "weekNames". Crea ===== var weekNames:Array = [ - "How to Funk", - "Daddy dearest", - "Spooky Month", - "PICO", - "Mommy Must Murder", - "Red Snow", - "Hating Simulator ft. Moawlings", - "Tankman" - ]; + + "How to Funk", + + "Daddy dearest", + + "Spooky Month", + + "PICO", + + "Mommy Must Murder", + + "Red Snow", + + "Hating Simulator ft. Moawlings", + + "Tankman" + +]; ===== From 24c27ba4239b342920ee0d344a32ec7ba1880ef6 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Wed, 12 May 2021 16:09:43 -0700 Subject: [PATCH 4/5] =?UTF-8?q?Whitespace=E2=84=A2?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit and i hate it --- docs/guides/weeks.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md index 65c1c0b..be9cc51 100644 --- a/docs/guides/weeks.md +++ b/docs/guides/weeks.md @@ -9,7 +9,7 @@ Navigate to your Kade Engine source code. In the `source` folder, look for `Stor ### Step 2. Songlist -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: +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: ===== @@ -44,7 +44,7 @@ Example: ===== - ### Step 3. Songlist +### 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: From 4ca3c389b73899c41ad0f1fe1978d9e7aaa04161 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Wed, 12 May 2021 16:29:03 -0700 Subject: [PATCH 5/5] A Damn Good 1000th Commit I FINALLY fixed up Step 5 (I reverse engineered MenuItem.hx to figure it out lol), PR open for review. --- docs/guides/weeks.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/guides/weeks.md b/docs/guides/weeks.md index be9cc51..8a6e3f3 100644 --- a/docs/guides/weeks.md +++ b/docs/guides/weeks.md @@ -103,6 +103,10 @@ 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 +### Step 5. Graphics - Being honest here, Prokube doesn't really know. More information will be added later, but for now I gotta go. +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. + +### Conclusion + +If you have followed all the steps correctly, you have successfully created a new week in the Story Mode.