Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/RadzPrower/Super-Metroid-Launcher

Conversion of Zelda 3 Launcher to Super Metroid Launcher
https://github.com/RadzPrower/Super-Metroid-Launcher

Last synced: 3 months ago
JSON representation

Conversion of Zelda 3 Launcher to Super Metroid Launcher

Lists

README 

        
# Super Metroid Launcher

This launcher is intended to be a near 1-click tool for downloading, extracting, and compiling steps required to play the Super Metroid reimplementation (created by [snesrev](https://github.com/snesrev/sm)) on Windows.

# Prerequisites

1. A legitimately obtained copy of the Super Metroid (US) ROM.



SHA256: `12B77C4BC9C1832CEE8881244659065EE1D84C70C3D29E6EAF92E6798CC2CA72`



And that's it outside of this exectuable itself.

# Build Instructions

1. [Download the the latest release](https://github.com/RadzPrower/Super-Metroid-Launcher/releases/latest)

2. Unzip the file.

3. Run `Super Metroid Launcher.exe` at which point you will be greeted by a window that looks like this:



![image](https://user-images.githubusercontent.com/37708128/226466146-fde7bb92-b4a9-43fe-a1dd-4b38ab685c31.png)



4. Click the download button. If you happen to have a `sm.sfc` file in the same directory as the executable, it will copy it over automatically for you, but if not, a file selection dialog will open and allow you to select your ROM file (naming is not important).

5. The button will change from `Download` to indicate `Downloading...` This will quickly pop up a number of windows indicating download progress. Once the files are downloaded, the button will change to indicate `Building...` at which point it may take up to several minutes to complete the process depending on your system. You will know the process is complete when the window looks like this:



![image](https://user-images.githubusercontent.com/37708128/226466278-a904a590-3a4d-4395-82a2-a78c9568739f.png)



6. Click `Launch Super Metroid` and enjoy your time revisiting this classic natively on modern hardware.



The top button at this point should say `Restore` which will completely re-do the entire process again in case something was broken. However, as new updates are made to the sm repository by snesrev, the launcher will detect those changes and change the button to say `Update`. This will let you know if there has been an update to the Super Metroid reimplementation itself.



NOTE: There have been no updates since this functionality was programmed, so there is a chance it will not work. If you notice that it is not working, please let me know.



# Settings Menu

![image](https://user-images.githubusercontent.com/37708128/226466334-9eba7154-19dd-4261-9101-ba78fdee41ee.png)



There are a number of settings available for you to change here. I will briefly explain them here.



### General

- Autosave: Essentially a "sleep mode". Automatically creates savestates as you close the game and will restart you in the exact same place the next time you start your game.



### Graphics

- Window Size

  * Auto: This will automatically size the window based on your selected `Fullscreen Mode` and `Window Scaling`.

  * Custom: Allows you to set the size of your window. The `Aspect Ratio` setting will still be respected, so if your window is not the same aspect ratio as that, you will end up with black bars.

- Fullscreen Mode

  * Windowed: This will provide you a window which can be move around your desktop. It's size can be changed via the `Window Scaling` option or using the assigned hotkey for increasing/decreasing the window size.

  * Borderless Fullscreen: This is still a window as part of your overall desktop, but it covers everything on a single monitor to appear as if it is fullscreen. This is generally considered the best performing option of the two fullscreen options.

  * Fullscreen: The screen is fully in control of a given monitor.

- Optimized SNES PPU: Use a more optimized but potentially buggy SNES PPU implementation.

- No Sprite Limit: No longer limits the number of sprites allowed to be rendered thus elminating flicker.

- Linear Filtering: Apply a linear filter to enlarged graphics. Results in a generally blurry image.

- Enhanced Mode7: Results in a higher resolution map.

- Stretch: Enabling this stretches the output to match the window size, this includes fullscreen modes, resulting a squashed or stretched visual. This can however be used to emulate a CRT since the 4:3 aspect ratio of a TV did not actually match the true 8:7 aspect ratio the SNES output.

- Window Scaling: Integer scaling of the display window. Only worked in `Windowed` mode.

- Render Method: Allows you to choose between SDL, SDL-Software, or OpenGL rendering. **NOTE: This setting may be overridden when certain other options are selected if they require a specific renderer to be used.**

- Use GLSL Shader: Allows you to select and load shaders to change how the visuals are rendered. A link is provided to a list of verified compatible shaders for you to select from.



### Sound

- Enable Audio

- Audio Channels: Mono or Stereo

- Audio Frequency

- Audio Samples: Defaults to 512, but the larger the number the less cracking, but the longer lag between the audio and visuals.



# Keymapper Utility

![image](https://user-images.githubusercontent.com/37708128/226466429-8ded6770-73af-4f8c-b042-bab8d6706cbe.png)



This utility allows you to set all the available standard controls (SNES controller) and additional hotkeys for `sm` exclusive functionality. The keyboard and gamepad settings are stored simultaneously for the main controls in the INI, so you must select which version you want to set for those controls specifically. The hotkeys however are unique so they can be freely set to either a gamepad or keyboard input.



You can hit the `Assign All Input` button to be sequentially moved from input to input so that you can set all keys without having to click on each individual input.



### Game Functions

- Reset

- Pause: This pauses the game without bringing up the item menu.

- Dim When Paused: This toggles whether the screen dims when using the above pause function.

- Increase Window Size

- Decrease Window Size

- Volume Up

- Volume Down



### Cheats

- Restore Health: Full heal Samus

- Jump: Gives you a sort of Moon Jump

- Turbo: Increases game speed while held.



### Replays

- Toggle Replay Speed: Toggles replay speed between realtime and turbo.

- Stop Repaly: Stops the current replay and you assume control of the game.



# Other Tools

[Zelda 3 Launcher](https://github.com/RadzPrower/Zelda-3-Launcher/releases/latest)