Game-Decompilation/sm
1
0
Fork 0
mirror of https://github.com/snesrev/sm.git synced 2024-11-23 05:39:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
main
sm/BUILDING.md
DaBanana64 9680714094 Overhaul MSYS2 compilation instruction and make the Switch instruction work. (#27) 
### Description
People seemed to be having issues compiling the game on MSYS2 so this PR
fixes all of it.
And I also overhauled the instruction to make it look prettier.
This also updates the Switch compiling instructions to make it work.

### Will this Pull Request break anything?
No.

### Suggested Testing Steps
See if it compiles.
2023-04-06 18:36:34 +02:00

3.3 KiB
Raw Permalink Blame History

Requirements

  • A Super Metroid rom (Make sure to rename it to sm.smc)
  • libsdl2-dev
  • Super Metroid repo git clone --recursive https://github.com/snesrev/sm

For Linux/MacOS you must install these for your desired OS:

  • Ubuntu/Debian: sudo apt install libsdl2-dev
  • Fedora Linux: sudo dnf in sdl2-devel
  • Arch Linux: sudo pacman -S sdl2
  • macOS: brew install sdl2

Windows

Building with MSYS2

Dependencies and requirements:

  • The libsdl2-dev library
  • MSYS2

Note: Make sure you're using MINGW64 and you're in sm folder in the terminal.

  1. Install MSYS2 on your machine.
  2. Place the copy of your rom in the main directory.
  3. Install the necessary dependencies by inputting this command in the terminal.
pacman -S mingw-w64-x86_64-SDL2 && pacman -S make && pacman -S mingw-w64-x86_64-gcc
  1. Type sdl2-config --cflags, it should output:
-IC:/msys64/mingw64/include/SDL2 -Dmain=SDL_main
  1. After that type sdl2-config --libs, should output:
-LC:/msys64/mingw64/lib -lmingw32 -mwindows -lSDL2main -lSDL2

After you've done installing everything, cd to sm folder. Type make In order to speed up the compilation, type make -j16

Building with Visual Studio

Dependencies and requirements:

Download VS installer. On installer prompt, make sure you're on "Workloads" and check Desktop Development with C++ this will install the necessary deps for compilation.

  1. Open sm.sln solution.
  2. Change the build target from Debug to Release
  3. Build the solution.

Building with Tiny C Compiler

Dependencies and requirements:

  • You'll need TCC and SDL2 in order to compile using TCC.
  1. Unzip both TCC and SDL and place them in third_party folder.
  2. Double click run_with_tcc.bat
  3. Wait for it to compile and the game will automatically boot-up.

Linux/MacOS

CD to your SM root folder and open the terminal and type:

make

For more advanced usage:

make -j$(nproc) # run on all core
make clean all  # clear gen+obj and rebuild
CC=clang make   # specify compiler

Nintendo Switch

Dependencies and requirements:

  1. Make sure you've installed Atmosphere on your Switch.
  2. Please download the DevKitPro version of MSYS2 through their installer, as the default MSYS2 causes issues with windows compiling.
  3. Now that you've installed DevKitPro, open up the location you've installed DevKitPro to, then find mingw64.exe inside msys2 located in devkitPro folder.
  4. Type pacman -S git switch-dev switch-sdl2 switch-tools in the terminal to install the switch-sdl2 library.
  5. CD to switch folder by typing cd src/platfrom/switch in the terminal on the sm root folder.
  6. type make to compile the Switch Port.
  7. Transfer the .ini, nro, ncap and your rom file to the Switch.

OPTIONAL STEP

make -j$(nproc) # To build using all cores