Intermediate mapping page revamp (#564)

* Advancing Intermediate mapping

* Some more advances, up to technical sections included.

* Updated and rephrased some things, added examples.

* Bunch of additions to intermediate/advanced mapping pages. Not finished yet.

* Some more changes...

* Committing everything before running automatic linter. Intermedaite mapping is finished (full draft). Glossary still needs updating.

* Dealt with most linter issues, but there are some I don't know how to fix.

* Fixing linting errors.

* Trying to make the deployment work.

* compressing/clarifying - up through "identity"

reworded and restructured a number of lines and paragraphs to be quicker and clearer to read through.
might be some typos or other issues, lmk if something's cringe

* Linting and some small fixes to AllPoland's changes.

* Changed images, some rewordings and changes of presentation

* Some improvements to images and fixing typos.

* rewording up through "rotations"

* rewording up through "Arcs"

* Added glossary terms, changed "pattern" for "hit" when referring to individual hits only, and added a mention to synchronizing the HJD with the song's beats.

* Added deployment info to README.md

* README.md needed linting lol

* rewording up through "Pattern Setup"

* rewording "Jump settings"

* finish rewording

FINALLY

* Some changes suggested by GalaxyMaster

* Removed 90/360 mapping as it's actually covered in Extended Mapping.

* Changes based on GalaxyMaster's feedback.

* Reconfiguring for my own fork.

* Added traces to be able to identify what to change before pushing back to main repo.

* Some final changes.

* Fixing.

* Some indications on how to deploy to GitHub pages.

* Linting...

* Initial content review and edits

* revise deployment step 6 to refer to github documentation

* update .gitignore for other config files

* new images

* update arm circle

* phrasing adjustments

* fix lint

* Update intermediate-mapping.md

Two small typos.

---------

Co-authored-by: AllPoland <[email protected]>
Co-authored-by: Bloodcloak <[email protected]>

.gitignore

@@ -25,3 +25,6 @@ wiki/.vitepress/cache
 
 # Visual Studio-created directory for... something?
 /.vs
+
+# Ignore config copies forks may keep to deploy a test instance
+/wiki/.vitepress/config.*.ts

README.md

@@ -35,6 +35,19 @@ The Wiki has a built-in linter that runs automatically when you push commits to
 
 Once you have finished making changes, you can either commit them directly using `git` tools, or copy them into the GitHub web interface if you don't know how to use `git`.
 
+## 🖧 Deployment
+
+To deploy your fork of the wiki to GitHub pages (for example to allow others to preview your changes):
+
+1. Open `/wiki/.vitepress/config.ts`.
+2. Search for `export default defineConfig({`.
+3. Add an entry to this dictionary with `base: '<reponame>'` where `<reponame>` is the name of your forked repository.
+4. In the same file, search for `sitemap: {`.
+5. Change the `hostname` entry to `https://<username>.github.io/<reponame>/)` where `<username>` is your GitHub username and `<reponame>` is the name of your forked repository.
+6. [Enable GitHub pages from GitHub actions](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow) on your repository.
+7. Whenever you push changes to the repository, GitHub will automatically attempt to deploy it. You can check the state in the Actions tab of your repository on GitHub.
+8. When you make a push request to the main repository, remember to exclude these changes!!
+
 ## 🔐 Licensing
 
 - The code that generates the wiki is licensed under the [MIT License](https://github.com/bsmg/wiki/blob/master/LICENSE).

wiki/.vitepress/config.ts

@@ -63,6 +63,8 @@ export default defineConfig({
   title: 'BSMG Wiki',
   description:
     'Guides on how to mod Beat Saber, create custom content, and get involved in the community!',
+  // If deploying to GitHub pages, uncomment this and replace with the name of your repository.
+  // base: '/<nameofyourrepo>/',
   lastUpdated: true,
 
   head: [['link', { rel: 'icon', href: '/icon.png' }]],
@@ -179,6 +181,7 @@ export default defineConfig({
               ['Basic Mapping', '/mapping/basic-mapping'],
               ['Downmapping', '/mapping/downmapping'],
               ['Intermediate Mapping', '/mapping/intermediate-mapping'],
+              ['Advanced Mapping', '/mapping/advanced-mapping'],
               ['Extended Mapping', '/mapping/extended-mapping'],
               ['Mapping Glossary', '/mapping/glossary'],
             ],
@@ -316,6 +319,7 @@ export default defineConfig({
   },
 
   sitemap: {
+    // Replace this with the URL of your GitHub pages deployment
     hostname: 'https://bsmg.wiki/',
   },
 

wiki/mapping/advanced-mapping.md

@@ -0,0 +1,55 @@
+---
+prev: false
+next: false
+description: Advanced topics in mapping.
+---
+
+# Advanced Mapping
+
+:::warning NOTE
+If you are looking to begin mapping, please start by reading the [Basic Mapping](./basic-mapping.md) page.
+
+If you know the basics and are looking for a complete overview of all the important mapping topics,
+check the [Intermediate Mapping](./intermediate-mapping.md) page.
+:::
+
+This page is a collection of individual detailed guides on specific topics from an advanced perspective and does not have
+a straightforward structure as the previous mapping pages. Feel free to skip around between the topics that interest you
+the most.
+
+If you think you have some wisdom to share about something you are a master of, please consider contributing by
+modifying the existing pages or adding a new one.
+
+## Advanced Timing
+
+### Variable BPM Songs
+
+If, while mapping, you notice that your song was properly aligned but suddenly changes or starts to fall off beat,
+then it's likely a BPM issue.
+
+If the alignment suddenly and dramatically shifts for large parts of the song, but it seems consistent, it is likely
+your map has multiple BPMs. Depending on how often it occurs, this is relatively easy to fix. You can simply cut the
+map up into pieces where the grid becomes unaligned, and then run each one through
+[Arrow Vortex](./basic-audio.md#sync-using-arrow-vortex) to find the correct BPM for each part. You can then use BPM
+blocks to readjust the grid to align to the beat.
+
+However, if the grid is less consistent and drifts around being aligned with no dramatic changes, then it is likely your
+song has a drifting BPM. This is common in older songs. This can be more of a hassle to deal with, but it is possible to
+address. Please see the [variable BPM guide](./advanced-audio.md#variable-bpm) for more information.
+
+### Swing In a Song and How Shuffle Helps
+
+::: tip NOTE
+This is a stub section. If you'd like to contribute, submit suggestions via
+[this form](https://docs.google.com/forms/d/e/1FAIpQLSfVS6_EMZOujxthR3lTa2eEwHg5C3x1INouLgnbHhBDpv1M5A/viewform).
+:::
+
+See this guide by Sykes
+[What swing is, and how "shuffle" will make your mapping easier](https://docs.google.com/document/d/1j7w1X-0QtnJDFVKzyyQc_KR7RE9H3C3JFesIXGR0s1c/edit)
+on how to use the built in shuffle feature to make mapping songs that have swing easier.
+
+## Momentum Mapping
+
+There is knowledge written and discussed that is not completely included in the
+[momentum section](./intermediate-mapping.md#momentum-and-tension) of the Intermediate Mapping page.
+However, nobody has yet spent the time presenting it in this page. For now, feel free to use what is written there.