diff --git a/docs/guides/blueblur/lighting/example.md b/docs/guides/blueblur/lighting/example.md deleted file mode 100644 index a960f581..00000000 --- a/docs/guides/blueblur/lighting/example.md +++ /dev/null @@ -1 +0,0 @@ -This page is still a work in progress... \ No newline at end of file diff --git a/docs/guides/blueblur/misc/example.md b/docs/guides/blueblur/misc/example.md deleted file mode 100644 index a960f581..00000000 --- a/docs/guides/blueblur/misc/example.md +++ /dev/null @@ -1 +0,0 @@ -This page is still a work in progress... \ No newline at end of file diff --git a/docs/guides/blueblur/files/xncp_anims.md b/docs/guides/hedgehog-engine/blueblur/files/xncp/anims.md similarity index 87% rename from docs/guides/blueblur/files/xncp_anims.md rename to docs/guides/hedgehog-engine/blueblur/files/xncp/anims.md index 8442dba1..cfc683e6 100644 --- a/docs/guides/blueblur/files/xncp_anims.md +++ b/docs/guides/hedgehog-engine/blueblur/files/xncp/anims.md @@ -1,23 +1,30 @@ --- description: XNCP Animation guide for Sonic Generations, using 010 Editor --- +!!! info + This guide uses the following tools: + + - 010 Editor (with XNCP Template) + + These tools and more can be found in the [XNCP tools page](/tools/hedgehog-engine/blueblur/files/xncp) # XNCP Animations + XNCP animations for a specific scene are listed in **AnimationDictionary**, which behaves the same way as the CastDictionary: -![](./assets/xncp_anims/image2.png) +![](./assets/anims/image2.png) In **AnimationFrameDataList**, it’s possible to control the amount of keyframes that a specific animation has: -![](./assets/xncp_anims/image1.png) +![](./assets/anims/image1.png) To control the speed of these animations, we have a single field in the scene that controls the frame rate: -![](./assets/xncp_anims/image4.png) +![](./assets/anims/image4.png) **AnimationKeyFrameDataList** contains the information for all the keyframes in the animation, as well as the casts that belong in that animation. -![](./assets/xncp_anims/image10.png) +![](./assets/anims/image10.png) In the screenshot above, we’re seeing the data referring to Animation 0 (**Intro_Anim** when following the dictionary). XNCPs usually follow this naming scheme for animations: @@ -28,7 +35,7 @@ They can obviously store other animations, and those have their own names. So, in Intro_Anim, we have several **CastAnimationData**. These control what happens to each cast in this animation. Let’s see what happens to Cast 0 (position, which usually is the parent of all casts in a scene and controls their position)... -![](./assets/xncp_anims/image3.png) +![](./assets/anims/image3.png) Seems like we have flags! It’s a bitfield, and it controls what actually animates in this cast. Here’s the meaning of each bit: ``` @@ -46,11 +53,11 @@ Seems like we have flags! It’s a bitfield, and it controls what actually anima So, with this info, we now know what animates in the position cast: It’s its X Position. The **CastAnimationDataSubData1List** is what stores the actual animation data. The amount of entries in this list depends on the number of bits signaled in the **Flags** field. The first entry in the list is referring to the first bit signaled from right to left. So by that logic, the list only has one entry. -![](./assets/xncp_anims/image9.png) +![](./assets/anims/image9.png) And there we go. This entry is what stores the actual **KeyFrames**. Let’s open one up to see how it is. -![](./assets/xncp_anims/image5.png) +![](./assets/anims/image5.png) Scary right? I don’t understand much of what’s going on here, but here we go. @@ -69,16 +76,16 @@ According to the flags of this specific cast, these keyframes are supposed to co The **Offset** and **Offset2** fields are unknown. They seem to offset the value in the Data field, but I don’t know their actual meanings. I still don’t know how animations loop, and if that’s even defined in the XNCP. I’d assume it’s in some of these fields, but I’m not sure. Maybe the game just keeps playing the animation and the XNCP doesn’t control that? Anyway let’s look at the second keyframe then: -![](./assets/xncp_anims/image8.png) +![](./assets/anims/image8.png) As we suspected, the **Frame** field is now set to 10, meaning this is referring to the last frame in the animation. The value in **Data** has increased, so this means that **this cast slides from left to right** in this animation! Looking at the remaining **CastAnimationData** entries, we can see that none of them animate, since their **Flags** field is set to 0. So we can conclude that **Intro_Anim** makes the **position** cast slide from **left to right**, and since “position” controls the entire scene, every single cast from this scene slides from left to right in this animation! -![](./assets/xncp_anims/image6.png) +![](./assets/anims/image6.png) Hope I explained XNCP animations well enough. Have fun! *PS: there’s also AnimationData2List but...* -![](./assets/xncp_anims/image7.png) \ No newline at end of file +![](./assets/anims/image7.png) \ No newline at end of file diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image1.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image1.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image1.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image1.png diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image10.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image10.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image10.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image10.png diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image2.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image2.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image2.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image2.png diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image3.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image3.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image3.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image3.png diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image4.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image4.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image4.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image4.png diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image5.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image5.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image5.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image5.png diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image6.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image6.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image6.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image6.png diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image7.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image7.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image7.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image7.png diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image8.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image8.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image8.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image8.png diff --git a/docs/guides/blueblur/files/assets/xncp_anims/image9.png b/docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image9.png similarity index 100% rename from docs/guides/blueblur/files/assets/xncp_anims/image9.png rename to docs/guides/hedgehog-engine/blueblur/files/xncp/assets/anims/image9.png diff --git a/docs/guides/blueblur/levels/glvl.md b/docs/guides/hedgehog-engine/blueblur/levels/glvl.md similarity index 61% rename from docs/guides/blueblur/levels/glvl.md rename to docs/guides/hedgehog-engine/blueblur/levels/glvl.md index ac83a278..a8f3405e 100644 --- a/docs/guides/blueblur/levels/glvl.md +++ b/docs/guides/hedgehog-engine/blueblur/levels/glvl.md @@ -1,9 +1,18 @@ --- description: Sonic GLvl tutorial for Sonic Generations --- -# How to use Sonic GLvl with Sonic Generations +!!! info + This guide uses the following tools: + + - Sonic GLvl + + These tools and more can be found in the [Level Editing tools page](/tools/hedgehog-engine/blueblur/levels) + !!! note - These video guides are old and still use Sonic GLvl 0.5.7. It's recommended you use the latest 0.9 version instead. + These video guides are old and are for Sonic GLvl 0.5.7. It's recommended you use the latest 0.9 version instead. + Even if 0.9 is a more recent version, the general way of working with it remains the same, hence why these videos are still relevant. + +# How to use Sonic GLvl with Sonic Generations **Part 1 (Getting Levels and Camera Controls)** diff --git a/docs/guides/blueblur/audio/example.md b/docs/guides/hedgehog-engine/common/lighting/example.md similarity index 100% rename from docs/guides/blueblur/audio/example.md rename to docs/guides/hedgehog-engine/common/lighting/example.md diff --git a/docs/guides/index.md b/docs/guides/index.md index 86c0388b..c3a7fc9f 100644 --- a/docs/guides/index.md +++ b/docs/guides/index.md @@ -1,3 +1,7 @@ -# Guides +--- +title: Guides +--- -This page is still a work in progress... \ No newline at end of file +# :fontawesome-solid-book: Guides + +This section contains guides that should hopefully teach you how to mod certain aspects of a couple of Sonic games. On the left you can see the games divided by the engine they use. In each engine, you can see common guides for every game using it, as well as more specific guides regarding a particular game. \ No newline at end of file diff --git a/docs/guides/marathon/levels/assets/glvl/image1.png b/docs/guides/others/marathon/levels/assets/glvl/image1.png similarity index 100% rename from docs/guides/marathon/levels/assets/glvl/image1.png rename to docs/guides/others/marathon/levels/assets/glvl/image1.png diff --git a/docs/guides/marathon/levels/assets/glvl/image2.png b/docs/guides/others/marathon/levels/assets/glvl/image2.png similarity index 100% rename from docs/guides/marathon/levels/assets/glvl/image2.png rename to docs/guides/others/marathon/levels/assets/glvl/image2.png diff --git a/docs/guides/marathon/levels/glvl.md b/docs/guides/others/marathon/levels/glvl.md similarity index 94% rename from docs/guides/marathon/levels/glvl.md rename to docs/guides/others/marathon/levels/glvl.md index 70f0b688..95495802 100644 --- a/docs/guides/marathon/levels/glvl.md +++ b/docs/guides/others/marathon/levels/glvl.md @@ -1,13 +1,16 @@ --- description: Sonic GLvl tutorial for Sonic '06 --- +!!! info + This guide uses the following tools: -# How to use Sonic GLvl with Sonic '06 + - [Sonic GLvl](https://github.com/DarioSamo/libgens-sonicglvl){ target="_blank"} + - [Sonic '06 Stage Editing Archive](https://github.com/Knuxfan24/Sonic-06-Stage-Editing-Archive){ target="_blank" } !!! note Due to a lack of an actual, dedicated level editor for Sonic '06, we (at the time of writing) use a hacked together solution that allows us to use Sonic GLvl as a stand in. This guide will explain how to set up GLvl for this purpose, with the assumption that the user understands basic usage of the program itself. - +# How to use Sonic GLvl with Sonic '06 ## Setting Up Download your preferred version of Sonic GLvl 0.9 and extract the repository to any location. Then, open the database folder and delete the `objects` folder. Next, download the [Sonic '06 Stage Editing Archive](https://github.com/Knuxfan24/Sonic-06-Stage-Editing-Archive) and extract the `SonicGLvl/database` folder to your SonicGLvl location, choosing to merge/replace existing files. diff --git a/docs/index.md b/docs/index.md index 25ba0c6d..5b35991f 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,6 @@ hide: - toc --- -#

HedgeDocs

@@ -18,4 +17,4 @@ hide: Guides :fontawesome-solid-book: - + \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css index 3daecd16..a2df3f56 100644 --- a/docs/stylesheets/extra.css +++ b/docs/stylesheets/extra.css @@ -2,10 +2,20 @@ --md-default-fg-color: #D2D2D2; --md-default-fg-color--light: #E0E6E6; --md-default-fg-color--lighter: #E6E6E6; - --md-default-bg-color: #171717; + --md-default-bg-color: #151515; --md-primary-fg-color: #1656E4; --md-primary-fg-color--light: #75B6E7; } + +[data-md-color-scheme="amoled"] { + --md-default-fg-color: #D2D2D2; + --md-default-fg-color--light: #E0E6E6; + --md-default-fg-color--lighter: #E6E6E6; + --md-default-bg-color: #000000; + --md-primary-fg-color: #014ae7; + --md-primary-fg-color--light: #75B6E7; +} + .md-typeset p { font-size: 16px; } @@ -23,28 +33,34 @@ } .md-tabs__link { - -webkit-backface-visibility: hidden; - backface-visibility: hidden; - display: block; - font-size: .7rem; - margin-top: .8rem; - opacity: .7; - outline-color: var(--md-accent-fg-color); - outline-offset: .2rem; - border-bottom: 0px transparent; - transition: transform .4s cubic-bezier(.1,.7,.1,1),opacity .25s,border-bottom .25s ease; + -webkit-backface-visibility: hidden; + backface-visibility: hidden; + display: block; + font-size: .7rem; + margin-top: .8rem; + opacity: .7; + outline-color: var(--md-accent-fg-color); + outline-offset: .2rem; + border-bottom: 0px transparent; + transition: transform .4s cubic-bezier(.1,.7,.1,1),opacity .25s,border-bottom .25s ease; } .md-tabs__link--active, .md-tabs__link:-webkit-any(:focus,:hover) { - color: inherit; - opacity: 1; - border-bottom: 1px solid #D2D2D2; - padding-bottom: 1em; + color: inherit; + opacity: 1; + border-bottom: 1px solid #D2D2D2; + padding-bottom: 1em; } .md-tabs__link--active, .md-tabs__link:is(:focus,:hover) { - color: inherit; - opacity: 1; - border-bottom: 1px solid; - padding-bottom: 1em; + color: inherit; + opacity: 1; + border-bottom: 1px solid; + padding-bottom: 1em; } + +.txt-background { + background-color: #b71c1c; + border-radius: 20px; + padding: .3em; +} \ No newline at end of file diff --git a/docs/tools/blueblur/files.md b/docs/tools/blueblur/files.md deleted file mode 100644 index 0f4e2e85..00000000 --- a/docs/tools/blueblur/files.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -description: File format tools for Sonic Generations ---- -# File Format Tools - -## CompressAR -Tool to compress and decompress AR files for Sonic Generations, using 'makecab' and 'expand'. - -[Download :fontawesome-solid-download:](https://github.com/PTKickass/CompressAR/releases){ .md-button .md-button--primary target="_blank"} - -## GlitterStudio -Editor application to open, modify, and resave GTE/GTM particle files for Sonic Generations. - -[Download :fontawesome-solid-download:](https://github.com/crash5band/Glitter/releases){ .md-button .md-button--primary target="_blank"} - -## 010 Editor -Allows editing various file formats, in particular the XNCP format through the use of a template. - -[Download :fontawesome-solid-download:](https://www.sweetscape.com/010editor/){ .md-button .md-button--primary target="_blank"} -[XNCP Template :fontawesome-solid-external-link-alt:](https://github.com/tge-was-taken/010-Editor-Templates/blob/master/templates/sonic_xncp_yncp.bt){ .md-button .md-button--primary target="_blank"} \ No newline at end of file diff --git a/docs/tools/blueblur/audio.md b/docs/tools/hedgehog-engine/blueblur/audio.md similarity index 100% rename from docs/tools/blueblur/audio.md rename to docs/tools/hedgehog-engine/blueblur/audio.md diff --git a/docs/tools/hedgehog-engine/blueblur/files/ar.md b/docs/tools/hedgehog-engine/blueblur/files/ar.md new file mode 100644 index 00000000..6e61c502 --- /dev/null +++ b/docs/tools/hedgehog-engine/blueblur/files/ar.md @@ -0,0 +1,9 @@ +--- +description: AR/ARL tools for Sonic Generations +--- +# AR/ARL Tools + +## CompressAR +Tool to compress and decompress AR files for Sonic Generations, using 'makecab' and 'expand'. + +[Download :fontawesome-solid-download:](https://github.com/PTKickass/CompressAR/releases){ .md-button .md-button--primary target="_blank"} \ No newline at end of file diff --git a/docs/tools/hedgehog-engine/blueblur/files/gte.md b/docs/tools/hedgehog-engine/blueblur/files/gte.md new file mode 100644 index 00000000..56ea8c6d --- /dev/null +++ b/docs/tools/hedgehog-engine/blueblur/files/gte.md @@ -0,0 +1,9 @@ +--- +description: GTE/GTM tools for Sonic Generations +--- +# GTE/GTM Tools + +## GlitterStudio +Editor application to open, modify, and resave GTE/GTM particle files for Sonic Generations. + +[Download :fontawesome-solid-download:](https://github.com/crash5band/Glitter/releases){ .md-button .md-button--primary target="_blank"} \ No newline at end of file diff --git a/docs/tools/hedgehog-engine/blueblur/files/xncp.md b/docs/tools/hedgehog-engine/blueblur/files/xncp.md new file mode 100644 index 00000000..f969dc0e --- /dev/null +++ b/docs/tools/hedgehog-engine/blueblur/files/xncp.md @@ -0,0 +1,10 @@ +--- +description: XNCP tools for Sonic Generations +--- +# XNCP Tools + +## 010 Editor +Allows editing various file formats, in particular the XNCP format through the use of a template. + +[Download :fontawesome-solid-download:](https://www.sweetscape.com/010editor/){ .md-button .md-button--primary target="_blank"} +[XNCP Template :fontawesome-solid-external-link-alt:](https://github.com/tge-was-taken/010-Editor-Templates/blob/master/templates/sonic_xncp_yncp.bt){ .md-button .md-button--primary target="_blank"} \ No newline at end of file diff --git a/docs/tools/blueblur/levels.md b/docs/tools/hedgehog-engine/blueblur/levels.md similarity index 100% rename from docs/tools/blueblur/levels.md rename to docs/tools/hedgehog-engine/blueblur/levels.md diff --git a/docs/tools/blueblur/lighting.md b/docs/tools/hedgehog-engine/common/lighting.md similarity index 82% rename from docs/tools/blueblur/lighting.md rename to docs/tools/hedgehog-engine/common/lighting.md index bbea95bc..f90874fb 100644 --- a/docs/tools/blueblur/lighting.md +++ b/docs/tools/hedgehog-engine/common/lighting.md @@ -1,5 +1,5 @@ --- -description: Lighting tools for Sonic Generations +description: Lighting tools for the Hedgehog Engine --- # Lighting Tools diff --git a/docs/tools/index.md b/docs/tools/index.md index 28be05b4..c77af200 100644 --- a/docs/tools/index.md +++ b/docs/tools/index.md @@ -1,3 +1,7 @@ -# Tools +--- +title: Tools +--- -This page is still a work in progress... \ No newline at end of file +# :fontawesome-solid-cog: Tools + +This section contains tools that allow you to mod certain aspects of a couple of Sonic games. On the left you can see the games divided by the engine they use. In each engine, you can see common tools for every game using it, as well as more specific tools regarding a particular game. \ No newline at end of file diff --git a/docs/tools/marathon/files.md b/docs/tools/others/marathon/files.md similarity index 100% rename from docs/tools/marathon/files.md rename to docs/tools/others/marathon/files.md diff --git a/mkdocs.yml b/mkdocs.yml index 467b5ad2..db4e9d78 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,29 +6,35 @@ nav: - Home: index.md - Tools: - tools/index.md - - Sonic Generations: - - Lighting/GI: tools/blueblur/lighting.md - - File Formats: tools/blueblur/files.md - - Audio: tools/blueblur/audio.md - - Level Editing: tools/blueblur/levels.md - - Sonic The Hedgehog (2006): - - File Formats: tools/marathon/files.md + - Hedgehog Engine: + - Common: + - Lighting/GI: tools/hedgehog-engine/common/lighting.md + - Sonic Generations: + - File Formats: + - XNCP: tools/hedgehog-engine/blueblur/files/xncp.md + - GTE/GTM: tools/hedgehog-engine/blueblur/files/gte.md + - AR/ARL: tools/hedgehog-engine/blueblur/files/ar.md + - Audio: tools/hedgehog-engine/blueblur/audio.md + - Level Editing: tools/hedgehog-engine/blueblur/levels.md + - Other Engines: + - Sonic The Hedgehog (2006): + - File Formats: tools/others/marathon/files.md - Guides: - guides/index.md - - Sonic Generations: - - Lighting/GI: - - Example Guide: guides/blueblur/lighting/example.md - - File Formats: - - XNCP Animations: guides/blueblur/files/xncp_anims.md - - Audio: - - Example Guide: guides/blueblur/audio/example.md - - Level Editing: - - Sonic GLvl: guides/blueblur/levels/glvl.md - - Misc: - - Example Guide: guides/blueblur/misc/example.md - - Sonic The Hedgehog (2006): - - Level Editing: - - Sonic GLvl: guides/marathon/levels/glvl.md + - Hedgehog Engine: + - Common: + - Lighting/GI: + - Example Guide: guides/hedgehog-engine/common/lighting/example.md + - Sonic Generations: + - File Formats: + - XNCP: + - Animations: guides/hedgehog-engine/blueblur/files/xncp/anims.md + - Level Editing: + - Sonic GLvl: guides/hedgehog-engine/blueblur/levels/glvl.md + - Other Engines: + - Sonic The Hedgehog (2006): + - Level Editing: + - Sonic GLvl: guides/others/marathon/levels/glvl.md markdown_extensions: - abbr - admonition @@ -60,6 +66,9 @@ plugins: type: timeago exclude: - index.md + - tools/* + - guides/index.md + exclude_tags: false theme: logo: assets/icon.svg favicon: assets/favicon.png @@ -75,10 +84,15 @@ theme: scheme: slate toggle: icon: material/brightness-4 - name: Switch to light mode + name: Switch to AMOLED mode - media: "(prefers-color-scheme: light)" scheme: default primary: blue toggle: icon: material/brightness-7 - name: Switch to dark mode \ No newline at end of file + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: amoled + toggle: + icon: material/brightness-2 + name: Switch to light mode \ No newline at end of file