Skip to content

Commit

Permalink
Restructure images paths
Browse files Browse the repository at this point in the history
The idea is that images should be organized by the game/tool/etc it's of, not the page it's made for. Allows for using the same image with multiple pages while keeping things tidy and without needing to store duplicates (as I was doing with the Filza Favorites screenshot before).

Also added mkdocs-site-urls to allow for paths to be relative to the `docs` folder instead of the current document path if the path begins with `site:`.
  • Loading branch information
MegAmi24 committed Sep 20, 2024
1 parent 18ddcb5 commit b32bf0c
Show file tree
Hide file tree
Showing 28 changed files with 18 additions and 17 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/github-pages-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,5 @@ jobs:
with:
python-version: 3.x
- run: git config user.name 'github-actions[bot]' && git config user.email 'github-actions[bot]@users.noreply.github.com'
- run: pip install mkdocs-material mkdocs-glightbox
- run: pip install mkdocs-material mkdocs-glightbox mkdocs-site-urls
- run: mkdocs gh-deploy --force
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Since this wiki uses Material for MkDocs, you might want to check its [reference
You can test your changes locally before committing. To do so:

- Install [Python](https://www.python.org/downloads/)
- Install Material For MkDocs and the necessary plug-ins: `pip install mkdocs-material mkdocs-glightbox --upgrade`
- Install Material For MkDocs and the necessary plug-ins: `pip install mkdocs-material mkdocs-glightbox mkdocs-site-urls --upgrade`
- Serve webpage locally: `mkdocs serve`
- You can also build a static site instead, using `mkdocs build`

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,19 +48,19 @@ The datapacks for Sonic 1 and 2 are required for both playing and modding the ga

Open Filza, then tap the :octicons-star-24: Favorites icon at the bottom. In the menu that appears, tap Apps manager.

![Filza favorites menu](iOS/Step1.png){ width="25%" }
![Filza favorites menu](site:assets/images/iOS/Filza/Favorites.png){ width="25%" }

A list of your installed apps will appear. Tap **the :octicons-info-24: info icon** next to Sonic 1 or Sonic 2, then choose Bundle.

![Apps manager](iOS/Step2.png){ width="25%" } ![Info menu](iOS/Step3.png){ width="25%" }
![Apps manager](site:assets/images/iOS/Filza/AppsManager-S1.png){ width="25%" } ![Info menu](site:assets/images/iOS/Filza/Info-S1.png){ width="25%" }

Tap `Sonic 1 US.app` or `Sonic 2 iOS US.app`, then you should see `Data.rsdk` and `DataSonic1.rsdk`. These are the datapacks for Sonic 2 and Sonic 1, respectively.

![Bundle directory](iOS/Step4.png){ width="25%" } ![.app directory](iOS/Step5.png){ width="25%" }
![Bundle directory](site:assets/images/iOS/Filza/Bundle-S1.png){ width="25%" } ![.app directory](site:assets/images/iOS/Filza/AppDirectory-S1.png){ width="25%" }

To share the file with another app, tap the file, open the Hex Editor, then tap the :octicons-share-24: Share button in the top right corner. When you're finished, tap Done in the Hex Editor to close it.

![Open with ...](iOS/Step6.png){ width="25%" } ![Hex editor](iOS/Step7.png){ width="25%" } ![Share menu](iOS/Step8.png){ width="25%" }
![Open with ...](site:assets/images/iOS/Filza/OpenWith-S1.png){ width="25%" } ![Hex editor](site:assets/images/iOS/Filza/HexEditor-S1.png){ width="25%" } ![Share menu](site:assets/images/iOS/Filza/Share-S1.png){ width="25%" }

=== "Sonic Origins (Steam)"

Expand Down
Binary file removed docs/Guides/Games/Sonic1-2/Datapack/iOS/Step6.png
Binary file not shown.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,19 @@ The datapack for Sonic CD is required for both playing and modding the game.

Open Filza, then tap the :octicons-star-24: Favorites icon at the bottom. In the menu that appears, tap Apps manager.

![Filza favorites menu](iOS/Step1.png){ width="25%" }
![Filza favorites menu](site:assets/images/iOS/Filza/Favorites.png){ width="25%" }

A list of your installed apps will appear. Tap **the :octicons-info-24: info icon** next to Sonic CD, then choose Bundle.

![Apps manager](iOS/Step2.png){ width="25%" } ![Info menu](iOS/Step3.png){ width="25%" }
![Apps manager](site:assets/images/iOS/Filza/AppsManager-SCD.png){ width="25%" } ![Info menu](site:assets/images/iOS/Filza/Info-SCD.png){ width="25%" }

Tap `Sonic CD iOS.app`, then you should see the datapack `Data.rsdk`.

![Bundle directory](iOS/Step4.png){ width="25%" } ![.app directory](iOS/Step5.png){ width="25%" }
![Bundle directory](site:assets/images/iOS/Filza/Bundle-SCD.png){ width="25%" } ![.app directory](site:assets/images/iOS/Filza/AppDirectory-SCD.png){ width="25%" }

To share one of the files with another app, tap the file, open the Hex Editor, then tap the :octicons-share-24: Share button in the top right corner. When you're finished, tap Done in the Hex Editor to close it.

![Open with ...](iOS/Step6.png){ width="25%" } ![Hex editor](iOS/Step7.png){ width="25%" } ![Share menu](iOS/Step8.png){ width="25%" }
![Open with ...](site:assets/images/iOS/Filza/OpenWith-SCD.png){ width="25%" } ![Hex editor](site:assets/images/iOS/Filza/HexEditor-SCD.png){ width="25%" } ![Share menu](site:assets/images/iOS/Filza/Share-SCD.png){ width="25%" }

=== "Sonic Origins (Steam)"

Expand Down
Binary file removed docs/Guides/Games/SonicCD/Datapack/iOS/Step1.png
Binary file not shown.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/Guides/RSDKv3/Decompilation/Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [Building the source code](Building.md) (Recommended)
- [Downloading the latest release](https://github.com/RSDKModding/RSDKv3-Decompilation/releases/latest) (Origins Plus DLC will not be accessible)
- [Downloading an autobuild](https://github.com/RSDKModding/RSDKv3-Decompilation/actions) (Must be signed into GitHub to download, Origins Plus DLC will not be accessible)
- [A datapack (Data.rsdk) for Sonic CD](../../Games/SonicCD/Datapack/README.md)
- [A datapack (Data.rsdk) for Sonic CD](../../Games/SonicCD/Datapack.md)
- [Visual C++ Redistributables](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170) (Windows only)

## Setup
Expand Down
2 changes: 1 addition & 1 deletion docs/Guides/RSDKv4/Decompilation/Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
- [Building the source code](Building.md) (Recommended)
- [Downloading the latest release](https://github.com/RSDKModding/RSDKv4-Decompilation/releases/latest) (Origins Plus DLC will not be accessible)
- [Downloading an autobuild](https://github.com/RSDKModding/RSDKv4-Decompilation/actions) (Must be signed into GitHub to download, Origins Plus DLC will not be accessible)
- [A datapack (Data.rsdk) for Sonic 1 or 2](../../Games/Sonic1-2/Datapack/README.md)
- [A datapack (Data.rsdk) for Sonic 1 or 2](../../Games/Sonic1-2/Datapack.md)
- [Visual C++ Redistributables](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170) (Windows only)

## Setup
Expand Down
2 changes: 1 addition & 1 deletion docs/Guides/RSDKv5/Decompilation/Setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
- [Building the source code](Building.md) (Recommended)
- [Downloading the latest release](https://github.com/RSDKModding/Sonic-Mania-Decompilation/releases/latest)
- [Downloading an autobuild](https://github.com/RSDKModding/Sonic-Mania-Decompilation/actions) (Must be signed into GitHub to download)
- [A datapack (Data.rsdk) for Sonic Mania](../../Games/SonicMania/Datapack/README.md)
- [A datapack (Data.rsdk) for Sonic Mania](../../Games/SonicMania/Datapack.md)
- The decompilations are not compatible with datapacks from the Netflix Games releases of the game.
- [Visual C++ Redistributables](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170) (Windows only)

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/assets/images/iOS/Filza/OpenWith-S1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
9 changes: 5 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ extra_javascript:

plugins:
- search
- site-urls
- glightbox:
touchNavigation: true
loop: false
Expand Down Expand Up @@ -514,16 +515,16 @@ nav:
- Guides/Games/README.md
- Sonic CD:
- Guides/Games/SonicCD/README.md
- Obtaining the Datapack: Guides/Games/SonicCD/Datapack/README.md
- Obtaining the Datapack: Guides/Games/SonicCD/Datapack.md
- Sonic 1 & 2:
- Guides/Games/Sonic1-2/README.md
- Obtaining the Datapacks: Guides/Games/Sonic1-2/Datapack/README.md
- Obtaining the Datapacks: Guides/Games/Sonic1-2/Datapack.md
- Sonic Mania:
- Guides/Games/SonicMania/README.md
- Obtaining the Datapack: Guides/Games/SonicMania/Datapack/README.md
- Obtaining the Datapack: Guides/Games/SonicMania/Datapack.md
- Sonic 3 & Knuckles:
- Guides/Games/Sonic3K/README.md
- Obtaining the Datapack: Guides/Games/Sonic3K/Datapack/README.md
- Obtaining the Datapack: Guides/Games/Sonic3K/Datapack.md
- RetroED:
- Guides/RetroED/README.md
- Using S3KOEditorLink: Guides/RetroED/S3KOEditorLink.md
Expand Down

0 comments on commit b32bf0c

Please sign in to comment.