morgan/Grinch-AP
1
0
Fork 0
mirror of https://github.com/MarioSpore/Grinch-AP.git synced 2025-10-21 12:11:33 -06:00
Code Issues Packages Projects Releases Wiki Activity
Files
7dcb6f66da80a8904604494c5b25732fbe1a4031
Grinch-AP/WebHostLib/static/assets/tutorial/Super Mario 64/setup_en.md
Chris Wilson 7dcb6f66da Website Style Upgrade (#353) 
* [WebHost] Update WebHost to include modular themes system, remove unused and outdated assets

* Landing Page Updates

* Markdown updates, colors coming later

* Remove testing theme from FF1

* Color updates for markdown styles

* Updates to generated pages, so many updates

* [WebHost] Update WebHost to include modular themes system, remove unused and outdated assets

* Landing Page Updates

* Markdown updates, colors coming later

* Remove testing theme from FF1

* Color updates for markdown styles

* Updates to generated pages, so many updates

* Seed download page improvements

* Add styles to weighted-settings page

* Minor adjustments to styles

* Revert base theme to grass

* Add more items to ArchipIDLE

* [WebHost] Update WebHost to include modular themes system, remove unused and outdated assets

* Landing Page Updates

* Markdown updates, colors coming later

* Remove testing theme from FF1

* Color updates for markdown styles

* Updates to generated pages, so many updates

* Seed download page improvements

* [WebHost] Update WebHost to include modular themes system, remove unused and outdated assets

* Landing Page Updates

* Markdown updates, colors coming later

* Remove testing theme from FF1

* Color updates for markdown styles

* Updates to generated pages, so many updates

* Add styles to weighted-settings page

* Minor adjustments to styles

* Revert base theme to grass

* Add more items to ArchipIDLE

* Improve Archipidle item name

* [WebHost] Update background images, waiting on jungle.png, added partyTime theme

* [WebHost] Fix tab ordering on landing page, remove islands on screen scale, fix tutorial page width scaling

* [WebHost] Final touches to WebHost

* Improve get_world_theme function, add partyTime theme to ArchipIDLE WebWorld

* Remove sending_visible from AutoWorld

* AP Ocarina of Time Client (#352)

* Core: update jinja (#351)

* some typing and cleaning, mostly in Fill.py (#349)

* some typing and cleaning, mostly in Fill.py

* address missing Option types

* resolve a few TODOs discussed in pull request

* SM: Optimize a bit (#350)

* SM: Optimize a bit

* SM: init bosses only once

* New World Order (#355)

* Core: update jinja

* SM: Optimize a bit

* AutoWorld: import worlds in alphabetical order, to be predictable rather than arbitrary

Co-authored-by: Hussein Farran <hmfarran@gmail.com>

* Remove references to Z5Client in English OoT setup guide

* Prevent markdown code blocks from overflowing their container

Co-authored-by: espeon65536 <81029175+espeon65536@users.noreply.github.com>
Co-authored-by: Fabian Dill <Berserker66@users.noreply.github.com>
Co-authored-by: Doug Hoskisson <beauxq@users.noreply.github.com>
Co-authored-by: Hussein Farran <hmfarran@gmail.com>
2022-03-28 20:12:17 -04:00

4.4 KiB
Raw Blame History

Super Mario 64 EX MultiWorld Setup Guide

Required Software

  • Super Mario 64 US Rom (Japanese may work also. Europe and Shindou not supported)
  • Either of sm64pclauncher or
  • Cloning and building sm64ex manually.

NOTE: The above linked sm64pclauncher is a special version designed to work with the Archipelago build of sm64ex. You can use other sm64-port based builds with it, but you can't use a different launcher with the Archipelago build of sm64ex.

Installation and Game Start Procedures

Installation via sm64pclauncher (For Windows)

First, install MSYS as described on the page. DO NOT INSTALL INTO A FOLDER PATH WITH SPACES. Do all steps up to including step 6. Best use default install directory. Then follow the steps below

  1. Go to the page linked for sm64pclauncher, and press on the topmost entry
  2. Scroll down, and download the zip file
  3. Unpack the zip file in an empty folder
  4. Run the Launcher and press build.
  5. Set the location where you installed MSYS when prompted. Check the "Install Dependencies" Checkbox
  6. Set the Repo link to https://github.com/N00byKing/sm64ex and the Branch to archipelago (Top two boxes). You can choose the folder (Secound Box) at will, as long as it does not exist yet
  7. Point the Launcher to your Super Mario 64 US/JP Rom, and set the Region correspondingly
  8. Set Build Options. Recommended: -jn where n is the Number of CPU Cores, to build faster.
  9. SM64EX will now be compiled. The Launcher will appear to have crashed, but this is not likely the case. Best wait a bit, but there may be a problem if it takes longer than 10 Minutes

After it's done, the Build list should have another entry titled with what you named the folder in step 7.

NOTE: For some reason first start of the game always crashes the launcher. Just restart it. If it still crashes, recheck if you typed the launch options correctly (Described in "Joining a MultiWorld Game")

Manual Compilation (Linux/Windows)

Dependencies for Linux: sdl2 glew cmake python make. Dependencies for Windows: mingw-w64-x86_64-gcc mingw-w64-x86_64-glew mingw-w64-x86_64-SDL2 git make python3 cmake SM64EX will link jsoncpp dynamic if installed. If not, it will compile and link statically.

  1. Clone https://github.com/N00byKing/sm64ex recursively
  2. Enter sm64ex and copy your Rom to baserom.REGION.z64 where REGION is either us or jp respectively.
  3. Compile with make. For faster compilation set the parameter -jn where n is the Number of CPU Cores.

The Compiled binary will be in build/REGION_pc/.

Joining a MultiWorld Game

To join, set the following launch options: --sm64ap_name YourName --sm64ap_ip ServerIP:Port. Optionally, add --sm64ap_passwd "YourPassword" if the room you are using requires a password. The Name in this case is the one specified in your generated .yaml file. In case you are using the Archipelago Website, the IP should be archipelago.gg.

If everything worked out, you will see a textbox informing you the connection has been established after the story intro.

Playing offline

To play offline, first generate a seed on the game's settings page. Create a room and download the .apsm64ex file, and start the game with the --sm64ap_file FileName launch argument.

Installation Troubleshooting

Start the game from the command line to view helpful messages regarding SM64EX.

Game doesn't start after compiling

Most likely you forgot to set the launch options. --sm64ap_name YourName and --sm64ap_ip ServerIP:Port are required for startup for Multiworlds, and --sm64ap_file FileName is required for (offline) singleplayer. If your Name or Password have spaces in them, surround them in quotes.

Game Troubleshooting

Known Issues

When using a US Rom, the In-Game messages are missing some letters: J Q V X Z and ?. The Japanese Version should have no problem displaying these.

What happens if I lose connection?

SM64EX tries to reconnect a few times, so be patient. Should the problem still be there after about a minute or two, just save and restart the game.

How do I update the Game to a new Build?

When manually compiling just pull in changes and run make again. Sometimes it helps to run make clean before.

When using the Launcher follow the normal build steps, but when choosing a folder name use the same as before. Then continue as normal.