diff --git a/docs/ports/sm64ex-uwp-guide.mdx b/docs/ports/sm64ex-uwp-guide.mdx new file mode 100644 index 0000000..4988db6 --- /dev/null +++ b/docs/ports/sm64ex-uwp-guide.mdx @@ -0,0 +1,171 @@ +--- +title: "sm64ex UWP Guide" +sidebar_position: 33 +description: "A guide for setting up sm64ex UWP on Xbox Dev Mode." +tags: + - guides + - ports + - xbox + - uwp +slug: sm64ex-uwp-guide +--- + +# sm64ex UWP Guide + +:::warning +No game assets are included with this port. Use your own legally obtained Super Mario 64 assets. +::: + +## Install + +Download the `.msix`, dependency file and `sm64ex_asset_extract.zip`. + +Install the `.msix` and the included dependency file through Xbox Device Portal. + +## First Setup + +Before copying anything to the Xbox, use the included asset extract helper on your PC. + +1. Extract `sm64ex_asset_extract.zip`. +2. Open the included README. +3. Follow the instructions to generate the required files. + +Once finished, you should have: + +```text +res\base.zip +demo\*.bin +``` + +## External Storage Setup + +If you are using USB or external Xbox storage, use this layout: + +```text +E:\sm64ex\res\base.zip +E:\sm64ex\demo\*.bin +``` + +The game checks `E:\sm64ex` first if it exists and can be written to. + +## Internal Storage Setup + +If you are using internal storage, place the files in the app's LocalState folder: + +```text +LocalState\res\base.zip +LocalState\demo\*.bin +``` + +You can upload these through Xbox Device Portal. + +## Saves And Config + +Saves, settings, texture packs and DynOS packs use the same storage location as your assets. + +So if your assets are in: + +```text +E:\sm64ex +``` + +your saves and config will be there too. + +If your assets are in LocalState, saves and config will be written to LocalState instead. + +## Frame Rate + +This build uses the sm64ex 60 FPS enhancement. + +For the US version, rendering is interpolated at 60 FPS while the game logic keeps the original 30 FPS timing. + +The Mario head intro still runs at 30 FPS. + +## Included Enhancements + +This build has these enabled: + +```text +BETTERCAMERA=1 +TEXTURE_FIX=1 +DYNOS=1 +``` + +That means Better Camera, upstream texture fixes and DynOS support are already included. + +## Texture Packs + +Loose texture replacements use the normal sm64ex `gfx` folder layout. + +Use: + +```text +E:\sm64ex\gfx +LocalState\gfx +``` + +For example: + +```text +E:\sm64ex\gfx\actors +E:\sm64ex\gfx\levels +E:\sm64ex\gfx\textures +``` + +Texture packs can also be used as ZIP files in `res`: + +```text +E:\sm64ex\res\render96.zip +LocalState\res\render96.zip +``` + +The ZIP should contain the `gfx` folder at the top level: + +```text +render96.zip +└── gfx + ├── actors + ├── levels + └── textures +``` + +## Large Texture Pack Fix + +Large texture packs can be heavy on Xbox if sm64ex tries to precache everything at startup. + +If the game crashes or fails to boot after adding a large texture pack, open: + +```text +E:\sm64ex\sm64config.txt +LocalState\sm64config.txt +``` + +Set: + +```text +precache false +``` + +This keeps texture packs enabled, but stops the game loading the whole pack at startup. + +## DynOS Packs + +DynOS packs go here: + +```text +E:\sm64ex\dynos\packs +LocalState\dynos\packs +``` + +## Quick Checks + +If the game does not start, check: + +- `base.zip` is inside `res` +- demo `.bin` files are inside `demo` +- the files are under `E:\sm64ex` or LocalState +- large texture packs have `precache false` set if startup is failing + +--- + +*Contributor: MewLew* diff --git a/docs/ports/snake-guide.mdx b/docs/ports/snake-guide.mdx index 0d9cce7..203feff 100644 --- a/docs/ports/snake-guide.mdx +++ b/docs/ports/snake-guide.mdx @@ -1,6 +1,6 @@ --- title: "Snake Guide" -sidebar_position: 33 +sidebar_position: 34 description: "A guide for setting up Snake on dev mode." tags: - guides diff --git a/docs/ports/soh-guide.mdx b/docs/ports/soh-guide.mdx index 249642e..621082f 100644 --- a/docs/ports/soh-guide.mdx +++ b/docs/ports/soh-guide.mdx @@ -1,6 +1,6 @@ --- title: "SOH (Ship of Harkinian) Foxtrot UWP Edition Guide" -sidebar_position: 34 +sidebar_position: 35 description: "A guide for setting up SOH (Ship of Harkinian) Foxtrot UWP Edition on dev mode." tags: - guides diff --git a/docs/ports/sonic-adventure-blast2-uwp-guide.mdx b/docs/ports/sonic-adventure-blast2-uwp-guide.mdx index 710c73e..0956e0c 100644 --- a/docs/ports/sonic-adventure-blast2-uwp-guide.mdx +++ b/docs/ports/sonic-adventure-blast2-uwp-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 39 +sidebar_position: 40 title: Sonic Adventure Blast 2 UWP Setup Guide description: Complete guide for installing and setting up Sonic Adventure Blast 2 UWP on Xbox tags: diff --git a/docs/ports/sonic-unleashed-recompiled-guide.mdx b/docs/ports/sonic-unleashed-recompiled-guide.mdx index 7449057..c7b1ffe 100644 --- a/docs/ports/sonic-unleashed-recompiled-guide.mdx +++ b/docs/ports/sonic-unleashed-recompiled-guide.mdx @@ -1,5 +1,5 @@ --- -sidebar_position: 46 +sidebar_position: 47 title: Sonic Unleashed Recompiled UWP Setup Guide description: Complete guide for installing and setting up Sonic Unleashed Recompiled UWP on Xbox tags: diff --git a/docs/ports/sonic1decomp-guide.mdx b/docs/ports/sonic1decomp-guide.mdx index f74acfc..88a0b47 100644 --- a/docs/ports/sonic1decomp-guide.mdx +++ b/docs/ports/sonic1decomp-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 1 Decompilation Guide" -sidebar_position: 36 +sidebar_position: 37 description: "A guide for setting up Sonic 1 Decompilation on dev mode." tags: - guides diff --git a/docs/ports/sonic2decomp-guide.mdx b/docs/ports/sonic2decomp-guide.mdx index c4d8277..3a15e27 100644 --- a/docs/ports/sonic2decomp-guide.mdx +++ b/docs/ports/sonic2decomp-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 2 Decompilation Guide" -sidebar_position: 37 +sidebar_position: 38 description: "A guide for setting up Sonic 2 Decompilation on dev mode." tags: - guides diff --git a/docs/ports/sonic3air-guide.mdx b/docs/ports/sonic3air-guide.mdx index 8faf924..dc553e2 100644 --- a/docs/ports/sonic3air-guide.mdx +++ b/docs/ports/sonic3air-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 3 A.I.R. Guide" -sidebar_position: 38 +sidebar_position: 39 description: "A guide for setting up Sonic 3 A.I.R on dev mode." tags: - guides diff --git a/docs/ports/soniccd-guide.mdx b/docs/ports/soniccd-guide.mdx index df43523..052bd3c 100644 --- a/docs/ports/soniccd-guide.mdx +++ b/docs/ports/soniccd-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic CD (Decompilation) Guide" -sidebar_position: 40 +sidebar_position: 41 description: "A guide for setting up Sonic CD (Decompilation) on dev mode." tags: - guides diff --git a/docs/ports/sonicmania-guide.mdx b/docs/ports/sonicmania-guide.mdx index 369e2fa..7be7918 100644 --- a/docs/ports/sonicmania-guide.mdx +++ b/docs/ports/sonicmania-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Mania Guide" -sidebar_position: 41 +sidebar_position: 42 description: "A guide for setting up Sonic Mania on dev mode." tags: - guides diff --git a/docs/ports/sonicrealms-guide.mdx b/docs/ports/sonicrealms-guide.mdx index b10f45d..041f1da 100644 --- a/docs/ports/sonicrealms-guide.mdx +++ b/docs/ports/sonicrealms-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Realms Guide" -sidebar_position: 42 +sidebar_position: 43 description: "A guide for setting up Sonic Realms on dev mode." tags: - guides diff --git a/docs/ports/sonicringracers-guide.mdx b/docs/ports/sonicringracers-guide.mdx index 7da4f29..4fa0b46 100644 --- a/docs/ports/sonicringracers-guide.mdx +++ b/docs/ports/sonicringracers-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Ring Racers Guide" -sidebar_position: 43 +sidebar_position: 44 description: "A guide for setting up Sonic Ring Racers on dev mode." tags: - guides diff --git a/docs/ports/sonicroboblast2-guide.mdx b/docs/ports/sonicroboblast2-guide.mdx index d0d89a3..cf73220 100644 --- a/docs/ports/sonicroboblast2-guide.mdx +++ b/docs/ports/sonicroboblast2-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Robo Blast 2 Guide" -sidebar_position: 44 +sidebar_position: 45 description: "A guide for setting up Sonic Robo Blast 2 on dev mode." tags: - guides diff --git a/docs/ports/sonicsms-guide.mdx b/docs/ports/sonicsms-guide.mdx index 74dc430..dd570ba 100644 --- a/docs/ports/sonicsms-guide.mdx +++ b/docs/ports/sonicsms-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic 1 & 2 SMS remakes Guide" -sidebar_position: 35 +sidebar_position: 36 description: "A guide for setting up Sonic 1 & 2 SMS remakes on dev mode." tags: - guides diff --git a/docs/ports/sonictimetwisted-guide.mdx b/docs/ports/sonictimetwisted-guide.mdx index 22858e8..fe43778 100644 --- a/docs/ports/sonictimetwisted-guide.mdx +++ b/docs/ports/sonictimetwisted-guide.mdx @@ -1,6 +1,6 @@ --- title: "Sonic Time Twisted Guide" -sidebar_position: 45 +sidebar_position: 46 description: "A guide for setting up Sonic Time Twisted on dev mode." tags: - guides diff --git a/docs/ports/spacecadetpinball-guide.mdx b/docs/ports/spacecadetpinball-guide.mdx index f1089cb..f73751d 100644 --- a/docs/ports/spacecadetpinball-guide.mdx +++ b/docs/ports/spacecadetpinball-guide.mdx @@ -1,6 +1,6 @@ --- title: "SpaceCadetPinball Guide" -sidebar_position: 47 +sidebar_position: 48 description: "A guide for setting up SpaceCadetPinball on dev mode." tags: - guides diff --git a/docs/ports/spelunky-guide.mdx b/docs/ports/spelunky-guide.mdx index a774307..4bdda5b 100644 --- a/docs/ports/spelunky-guide.mdx +++ b/docs/ports/spelunky-guide.mdx @@ -1,6 +1,6 @@ --- title: "Spelunky Classic HD Guide" -sidebar_position: 48 +sidebar_position: 49 description: "A guide for setting up Spelunky Classic HD on dev mode." tags: - guides diff --git a/docs/ports/spookydimensions-guide.mdx b/docs/ports/spookydimensions-guide.mdx index 62b896d..bb90b8d 100644 --- a/docs/ports/spookydimensions-guide.mdx +++ b/docs/ports/spookydimensions-guide.mdx @@ -1,6 +1,6 @@ --- title: "Spooky Dimensions Guide" -sidebar_position: 49 +sidebar_position: 50 description: "A guide for setting up Spooky Dimensions on dev mode." tags: - guides diff --git a/docs/ports/starfox64-guide.mdx b/docs/ports/starfox64-guide.mdx index 87a6ea5..91901c5 100644 --- a/docs/ports/starfox64-guide.mdx +++ b/docs/ports/starfox64-guide.mdx @@ -1,6 +1,6 @@ --- title: "Starfox 64: Recompiled Guide" -sidebar_position: 50 +sidebar_position: 51 description: "A guide for setting up Starfox 64: Recompiled on dev mode." tags: - guides diff --git a/docs/ports/super-mario-bros-remastered-guide.mdx b/docs/ports/super-mario-bros-remastered-guide.mdx index dff5374..7f385e7 100644 --- a/docs/ports/super-mario-bros-remastered-guide.mdx +++ b/docs/ports/super-mario-bros-remastered-guide.mdx @@ -1,6 +1,6 @@ --- title: "Super Mario Bros. Remastered Guide" -sidebar_position: 51 +sidebar_position: 52 description: "A guide for setting up Super Mario Bros. Remastered on Xbox Dev Mode." tags: - guides diff --git a/docs/ports/super-mario-world-remastered-plus-guide.mdx b/docs/ports/super-mario-world-remastered-plus-guide.mdx index 013af0f..35021ef 100644 --- a/docs/ports/super-mario-world-remastered-plus-guide.mdx +++ b/docs/ports/super-mario-world-remastered-plus-guide.mdx @@ -1,6 +1,6 @@ --- title: "Super Mario World Remastered Plus Guide" -sidebar_position: 52 +sidebar_position: 53 description: "A guide for setting up Super Mario World Remastered Plus on Xbox Dev Mode." tags: - guides diff --git a/docs/ports/supertuxkart-guide.mdx b/docs/ports/supertuxkart-guide.mdx index 99b903e..830bb4a 100644 --- a/docs/ports/supertuxkart-guide.mdx +++ b/docs/ports/supertuxkart-guide.mdx @@ -1,6 +1,6 @@ --- title: "SuperTuxKart Guide" -sidebar_position: 53 +sidebar_position: 54 description: "A guide for setting up SuperTuxKart on dev mode." tags: - guides diff --git a/docs/ports/tailsadventure-guide.mdx b/docs/ports/tailsadventure-guide.mdx index 76973ba..f0c145c 100644 --- a/docs/ports/tailsadventure-guide.mdx +++ b/docs/ports/tailsadventure-guide.mdx @@ -1,6 +1,6 @@ --- title: "Tails Adventure Remake Guide" -sidebar_position: 54 +sidebar_position: 55 description: "A guide for setting up Tails Adventure Remake on dev mode." tags: - guides diff --git a/docs/ports/trogdor-guide.mdx b/docs/ports/trogdor-guide.mdx index c8f4a34..6fe39ea 100644 --- a/docs/ports/trogdor-guide.mdx +++ b/docs/ports/trogdor-guide.mdx @@ -1,6 +1,6 @@ --- title: "Trogdor Reburninated Guide" -sidebar_position: 55 +sidebar_position: 56 description: "A guide for setting up Trogdor Reburninated on dev mode." tags: - guides diff --git a/docs/ports/vvvvvv-guide.mdx b/docs/ports/vvvvvv-guide.mdx index f6fc1c7..434df1f 100644 --- a/docs/ports/vvvvvv-guide.mdx +++ b/docs/ports/vvvvvv-guide.mdx @@ -1,6 +1,6 @@ --- title: "VVVVVV (V6) Guide" -sidebar_position: 56 +sidebar_position: 57 description: "A guide for setting up VVVVVV (V6) on dev mode." tags: - guides diff --git a/docs/ports/zelda3-guide.mdx b/docs/ports/zelda3-guide.mdx index 1c113c5..6e9ecc0 100644 --- a/docs/ports/zelda3-guide.mdx +++ b/docs/ports/zelda3-guide.mdx @@ -1,6 +1,6 @@ --- title: "Zelda 3 Guide" -sidebar_position: 57 +sidebar_position: 58 description: "A guide for setting up Zelda 3 on dev mode." tags: - guides diff --git a/docs/ports/zelda64-guide.mdx b/docs/ports/zelda64-guide.mdx index d9bb9ea..e729c97 100644 --- a/docs/ports/zelda64-guide.mdx +++ b/docs/ports/zelda64-guide.mdx @@ -1,6 +1,6 @@ --- title: "Zelda 64 Recompiled Guide" -sidebar_position: 58 +sidebar_position: 59 description: "A guide for setting up Zelda 64 Recompiled on dev mode." tags: - guides diff --git a/docs/ports/zircon-guide.mdx b/docs/ports/zircon-guide.mdx index 69e2c33..f76a32b 100644 --- a/docs/ports/zircon-guide.mdx +++ b/docs/ports/zircon-guide.mdx @@ -1,6 +1,6 @@ --- title: "Zircon (Quake) Guide" -sidebar_position: 59 +sidebar_position: 60 description: "A guide for setting up Zircon (Quake) on dev mode." tags: - guides