Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
RadzPrower committed Jul 17, 2020
2 parents 357a5a7 + ddab973 commit 34399f9
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,25 @@ While the launcher is an all-in-one tool, it does require a few prerequisites.
2. Python 3.6+ - This is a requirement of sm64ex itself, therefore it is a requirement for the launcher. You can download it at https://www.python.org/downloads/. When installing, make sure that you enable the "py" functionality as well as add Python to Windows' native PATH. Both of these options should be checked by default with the express install, however.
3. A legally obtained copy of the US version of the Super Mario 64 ROM file. No need to rename for the launcher!
# Installation
The installation process is pretty simple. Just download the zip file found on the releases page, unzip it to a directory of your choice, and then run the included `setup.exe`. This is a traditional Windows installer, so follow the familiar prompts and you'll soon have yourself a Start Menu entry, Desktop shortcut, and a brand new launcher, ready for its first run.
The installation process is pretty simple. Just download the zip file found on the releases page, unzip it to a directory of your choice, and then run the included `setup.exe`. This is a traditional Windows installer, so follow the familiar prompts and you'll soon have yourself a Start Menu entry, Desktop shortcut, and a brand new launcher, ready for its first run. Future updates should be detected and downloaded via the launcher automatically going forward.

NOTE: The first time you run the launcher, there will be a number of prompts, downloads, and background processes. These could take some time initially, but once everything is properly set up, your general use should be simple and snappy.
# Features
The launcher is generally straightforward. That said, let's break the different buttons down and explain what they do.

![Super Mario 64 NX Launcher](https://i.imgur.com/65Dkur1.png)
![Super Mario 64 NX Launcher](https://i.imgur.com/7Sw3v3x.png)

The top button is pretty self-explanatory. Click this button and you will launch the game with the selected mod paks applied. This process also includes doing necessary checks and/or processes required on your first run as well, so your first execution may take longer than usual. It is also at this point that mod paks are actually downloaded to your computer.

The next two buttons are currently not enabled, but in the next major version, these will allow you to just automatically start the game with all or no mods. As the next version will also allow for user settings to consist across sessions, these options will allow you to quickly run in either mode WITHOUT changing your underlying settings.
The second button allows you to launch the game without any mods enabled at all. This does not affect your mod selections and they will be retained.

The next button is for checking for PAK updates. This will make a call to a personally curated database of PAK files for you to select from. This process is currently manual (aside from your initial load of course) because at the moment I'm using a free database host solution, so I have a limited number of calls a month and want to cut down on unnecessary calls when someone just wants to launch the game.

The last working button right now is "Check for Updates". This will check your repository and python dependencies for updates. This is generally unnecessary as the launcher checks for repo updates at startup and you do not typically need the python dependencies once the !!base.pak is generated on your initial launch.
Below this is a toggle which allows you to prevent the launcher from closing when you launch the game proper. This can be used as a convenience for trying out different PAK files in rapid succession, but may also help those who utilize the launcher via Steam.

Next is "Check for Updates". This will check your repository and python dependencies for updates. This is generally unnecessary as the launcher checks for repo updates at startup and you do not typically need the python dependencies once the !!base.pak is generated on your initial launch.

A new addition with 2.0 is the button for adding a local PAK file to your own personalized grid. This will open a pop-up which will allow you to select a file and optionally include some information about said PAK. Below this button is also a button for removing PAKs from your list and `romfs` folders as well.

The bulk of the application though is the grid that contains the list of PAK files available and some information about them including creator names and a brief description. This list is dynamically generated and (in this version) will be reset to disable everything with each launch. Next version I hope to retain these selections across sessions.
# Closing
Expand Down

0 comments on commit 34399f9

Please sign in to comment.