From bdfdbdcc06b08def530393147b7c0a5f4888039f Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Fri, 14 May 2021 20:33:26 -0700 Subject: [PATCH 1/9] Chart Editor Guide #1 i'm tired --- docs/guides/charting.md | 62 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/guides/charting.md diff --git a/docs/guides/charting.md b/docs/guides/charting.md new file mode 100644 index 0000000..9d040f1 --- /dev/null +++ b/docs/guides/charting.md @@ -0,0 +1,62 @@ +# Using The Chart Editor + +## Requirements +There are no specific requirements for this guide. + +## Key + +![insert screenshot here]() + +--- +### How to Access The Chart Editor +To access the Chart Editor, simply begin a level in Freeplay Mode. Once the countdown finishes, press `7` on your keyboard. The screen will wipe, and +you will end up in the Chart Editor. + +## Basics +To place or delete notes, click on a square in the Charting Grid. + +To navigate the current section, use the scroll wheel or `W` and `S`. +To go to the previous or next section, press `A` or `Left Arrow` and `D` or `Right Arrow` respectively. + +To change the sustain length of a note, press `Q` to shorten and `E` to lengthen the sustain trail by 1 step. + +To playtest the chart, press `Enter`. +To test the chart's sync, press `Space`. This will play the song, and appropriately progress the strumline. When the camera is focused on Boyfriend, all notes will make a clap sound. When the camera is focused on Player 2, all notes wil make a snap sound. + +## The Tabs + +### Assets +The Assets tab is where you can change level data such as the background, player characters, and note skin. +Everything here is labelled, so this tab should be easy to use. + +### Note Data +This tab doesn't have much going on, but you can change the sustain length of the currently selected note here. And no, Apply Data doesn't do anything. + +### Section Data +The Section Data tab contains data related to the current section, such as the length of the current section (in steps), the BPM of the section, and whether or not +the camera should point to Boyfriend. Here, you can also copy another section of the chart by clicking "Copy Last". The stepper next to that button indicates +how far back the section you want to copy from is. This stepper can go into negative values to copy sections from later in the song. + +"Clear Section" and "Swap Section", respectively, clear the current section and swap the notes of Player 1 and Player 2. + +Alternate Animation is used exclusively for the Mom and Dad from Week 5, but if your character has an Alternate Animation, you can tick this checkbox to use it instead of the normal animation. + +### Song Data +In the Song Data tab, you can change the BPM of the chart and the speed at which the arrows arrive on the screen. +You can also reset the whole chart to start over again, and reload the chart or audio in case you changed something. + +"Load Autosave" attempts to roll the chart back to when you last playtested or saved it. + +"Save" does what you would think it does, and allows you to save your chart to somewhere on your computer. + +## Extra Shortcuts + +Hold `Shift`: Unlock note placement. + +`Shift` + `W` / `S`: Move up / down 2 steps. + +`Shift` + `A` / `D`: Go backward / forward 4 sections. + +`Tab`: Cycle right 1 tab. + +`Shift` + `Tab`: Cycle left 1 tab. From a06264b16c9f3b6994dcf56f241de1afc0c82fd6 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Sat, 15 May 2021 06:24:10 -0700 Subject: [PATCH 2/9] yawn --- docs/guides/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/index.md b/docs/guides/index.md index a1b30c6..feed0ac 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -1,10 +1,10 @@ # Guides [Creating A Custom Week](https://kadedev.github.io/Kade-Engine/guides/weeks) +[Using The Chart Editor](https://kadedev.github.io/Kade-Engine/guides/charting) ### 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 dialogue (like Week 6) - How to make custom characters From a827584db556c0a9a194948bc1de38a094a726be Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Sat, 15 May 2021 06:24:31 -0700 Subject: [PATCH 3/9] bruh Markdown indenting be like --- docs/guides/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/guides/index.md b/docs/guides/index.md index feed0ac..ee7e16c 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -1,5 +1,6 @@ # Guides [Creating A Custom Week](https://kadedev.github.io/Kade-Engine/guides/weeks) + [Using The Chart Editor](https://kadedev.github.io/Kade-Engine/guides/charting) ### Contributing From 7d13f5362442f089feeab152bc32781404dfb732 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Sat, 15 May 2021 16:04:43 -0700 Subject: [PATCH 4/9] maybe??? hey what if null images break GitHub Pages --- docs/guides/charting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/charting.md b/docs/guides/charting.md index 9d040f1..40753ae 100644 --- a/docs/guides/charting.md +++ b/docs/guides/charting.md @@ -5,7 +5,7 @@ There are no specific requirements for this guide. ## Key -![insert screenshot here]() +TBA --- ### How to Access The Chart Editor From 0c007b9f8cfe79d58559962e236deb8052935784 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Sun, 16 May 2021 13:19:22 -0700 Subject: [PATCH 5/9] i swear to god if this is the thing --- docs/guides/{charting.md => charting-state.md} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename docs/guides/{charting.md => charting-state.md} (100%) diff --git a/docs/guides/charting.md b/docs/guides/charting-state.md similarity index 100% rename from docs/guides/charting.md rename to docs/guides/charting-state.md From e7eee8efbcecc5cfd20cc657ce1b048900e058c5 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Mon, 17 May 2021 09:43:45 -0700 Subject: [PATCH 6/9] applying daniel's suggestions and adding images don't ask me why it took 2 days to finish this commit --- .../guides/{charting-state.md => charting.md} | 34 ++++++++++++++----- 1 file changed, 25 insertions(+), 9 deletions(-) rename docs/guides/{charting-state.md => charting.md} (55%) diff --git a/docs/guides/charting-state.md b/docs/guides/charting.md similarity index 55% rename from docs/guides/charting-state.md rename to docs/guides/charting.md index 40753ae..06fc2d2 100644 --- a/docs/guides/charting-state.md +++ b/docs/guides/charting.md @@ -1,15 +1,10 @@ # Using The Chart Editor -## Requirements -There are no specific requirements for this guide. - -## Key - -TBA +![Key and Table Of Contents are two different things. You're still correct though. I think..](https://user-images.githubusercontent.com/68293280/118520877-49692a80-b6ef-11eb-95fa-f2061fa6ad39.png) --- ### How to Access The Chart Editor -To access the Chart Editor, simply begin a level in Freeplay Mode. Once the countdown finishes, press `7` on your keyboard. The screen will wipe, and +To access the Chart Editor, simply begin a level. Once the countdown finishes, press `7` on your keyboard. The screen will wipe, and you will end up in the Chart Editor. ## Basics @@ -21,27 +16,39 @@ To go to the previous or next section, press `A` or `Left Arrow` and `D` or `Rig To change the sustain length of a note, press `Q` to shorten and `E` to lengthen the sustain trail by 1 step. To playtest the chart, press `Enter`. -To test the chart's sync, press `Space`. This will play the song, and appropriately progress the strumline. When the camera is focused on Boyfriend, all notes will make a clap sound. When the camera is focused on Player 2, all notes wil make a snap sound. +To test the chart's sync and see if the notes are aligned with the audio, press `Space`. This will play the song, and appropriately progress the strumline. When the camera is focused on Boyfriend, all notes will make a clap sound. When the camera is focused on Player 2, all notes wil make a snap sound. ## The Tabs ### Assets + +![ass sets haha funny one ninjamuffin](https://user-images.githubusercontent.com/68293280/118521235-ac5ac180-b6ef-11eb-9d59-10cdbeadb4f0.png) + The Assets tab is where you can change level data such as the background, player characters, and note skin. Everything here is labelled, so this tab should be easy to use. ### Note Data + +![The Useless Tab™](https://user-images.githubusercontent.com/68293280/118521260-b67cc000-b6ef-11eb-8ad3-3be0a503ad9a.png) + This tab doesn't have much going on, but you can change the sustain length of the currently selected note here. And no, Apply Data doesn't do anything. ### Section Data + +![i spend all my time here](https://user-images.githubusercontent.com/68293280/118521302-c09ebe80-b6ef-11eb-9c71-6305416e51c7.png) + The Section Data tab contains data related to the current section, such as the length of the current section (in steps), the BPM of the section, and whether or not the camera should point to Boyfriend. Here, you can also copy another section of the chart by clicking "Copy Last". The stepper next to that button indicates how far back the section you want to copy from is. This stepper can go into negative values to copy sections from later in the song. "Clear Section" and "Swap Section", respectively, clear the current section and swap the notes of Player 1 and Player 2. -Alternate Animation is used exclusively for the Mom and Dad from Week 5, but if your character has an Alternate Animation, you can tick this checkbox to use it instead of the normal animation. +Alternate Animation is used exclusively for the Mom and Dad from Week 5, but if your character has an Alternate Animation, you can tick this checkbox to use the other animation instead of the normal animation. This checkbox is applied per-section, which means you have to tick the checkmark across all the sections it is required for. ### Song Data + +![musics](https://user-images.githubusercontent.com/68293280/118521334-c8f6f980-b6ef-11eb-8eea-68d17c941ff1.png) + In the Song Data tab, you can change the BPM of the chart and the speed at which the arrows arrive on the screen. You can also reset the whole chart to start over again, and reload the chart or audio in case you changed something. @@ -49,6 +56,15 @@ You can also reset the whole chart to start over again, and reload the chart or "Save" does what you would think it does, and allows you to save your chart to somewhere on your computer. +"Vocal Volume" and "Instrumental Volume" control the volume of their respective audios. + +## Position Info + +![statistics sucks](https://user-images.githubusercontent.com/68293280/118525571-30af4380-b6f4-11eb-8a49-b7d5af6dba28.png) + + +In the top right of the chart editor, there is various information about your position in the chart, such as your current Section, Step, and how long the song that accompanies the track is. + ## Extra Shortcuts Hold `Shift`: Unlock note placement. From 3da80c10bc743eae8032bcb176de65428b42315a Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Mon, 17 May 2021 09:47:50 -0700 Subject: [PATCH 7/9] i think this is what she means right? --- docs/guides/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/guides/index.md b/docs/guides/index.md index ee7e16c..230198a 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -1,7 +1,7 @@ # Guides -[Creating A Custom Week](https://kadedev.github.io/Kade-Engine/guides/weeks) +[Creating A Custom Week]({{site.url}}guides/weeks) -[Using The Chart Editor](https://kadedev.github.io/Kade-Engine/guides/charting) +[Using The Chart Editor]({{site.url}}Kade-Engine/guides/charting) ### 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. From 0fb314dcb84753cdde3ff2a988d3c5b09f1e0501 Mon Sep 17 00:00:00 2001 From: Prokube <68293280+prokube@users.noreply.github.com> Date: Mon, 17 May 2021 09:53:41 -0700 Subject: [PATCH 8/9] stupid --- docs/guides/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/index.md b/docs/guides/index.md index 230198a..4de3130 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -1,7 +1,7 @@ # Guides [Creating A Custom Week]({{site.url}}guides/weeks) -[Using The Chart Editor]({{site.url}}Kade-Engine/guides/charting) +[Using The Chart Editor]({{site.url}}guides/charting) ### 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. From 73e1dc5b292fe5e09d9c857affc745c44a1bf7eb Mon Sep 17 00:00:00 2001 From: Puyo <15311104+daniel11420@users.noreply.github.com> Date: Mon, 17 May 2021 22:14:26 +0200 Subject: [PATCH 9/9] Update charting.md --- docs/guides/charting.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/guides/charting.md b/docs/guides/charting.md index 06fc2d2..2b3876b 100644 --- a/docs/guides/charting.md +++ b/docs/guides/charting.md @@ -63,7 +63,7 @@ You can also reset the whole chart to start over again, and reload the chart or ![statistics sucks](https://user-images.githubusercontent.com/68293280/118525571-30af4380-b6f4-11eb-8a49-b7d5af6dba28.png) -In the top right of the chart editor, there is various information about your position in the chart, such as your current Section, Step, and how long the song that accompanies the track is. +In the top right of the chart editor, you can find information about your position in the chart, such as your current Section, Step, and how long the song that accompanies the track is. ## Extra Shortcuts