Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 0 additions & 9 deletions BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,15 +51,6 @@ Download VS installer. On installer prompt, make sure you're on "Workloads" and
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](https://github.com/FitzRoyX/tinycc/releases/download/tcc_20221020/tcc_20221020.zip) and [SDL2](https://github.com/libsdl-org/SDL/releases/download/release-2.24.1/SDL2-devel-2.24.1-VC.zip) 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:
Expand Down
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ Our discord server is: https://discord.gg/AJJbJAzNNJ

Early version. It has bugs and the code is messy.

For building instructions, see: https://github.com/snesrev/sm/blob/main/BUILDING.md
When running, it runs an emulated version in the background and compares the ram state every frame. If it detects a mismatch, it saves a snapshot in saves/ and displays a counter on screen counting down from 300. Please submit these bug snapshots on discord so that they can be fixed.

Put sm.smc (sha1 hash da957f0d63d14cb441d215462904c4fa8519c613) in the root folder. When running, it will run both versions and compare frame by frame. If it detects a mismatch, it saves a snapshot in saves/ and displays a counter on screen counting down from 300.
## Building
You must self-build for now. Steps for 64-bit Windows:<br>
<s>(0) Download [Python](https://www.python.org/ftp/python/3.11.4/python-3.11.4-amd64.exe) and install with "Add to PATH" checked</s><br>
(1) Click the green button "Code > Download ZIP" on the github page and extract the ZIP<br>
(2) Place your USA rom named sm.sfc in that folder<br>
(3) Download [TCC](https://github.com/FitzRoyX/tinycc/releases/download/tcc_20230519/tcc_20230519.zip) and [SDL2](https://github.com/libsdl-org/SDL/releases/download/release-2.28.2/SDL2-devel-2.28.2-VC.zip) and extract each ZIP into the "third-party" subfolder<br>
<s>(4) Double click "extract_assets.bat" in the main dir. This will create sm_assets.dat.</s><br>
(5) Double-click "run_with_tcc.bat" in the main dir. This will create sm.exe and run it.<br>
(6) Configure with sm.ini in a text editor like notepad++<br>

For other platforms and compilers, see: https://github.com/snesrev/sm/blob/main/BUILDING.md
6 changes: 3 additions & 3 deletions run_with_tcc.bat
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
@echo off

set SDL2=third_party\SDL2-2.24.1
set SDL2=third_party\SDL2-2.28.2

IF NOT EXIST "third_party\tcc\tcc.exe" (
ECHO:
ECHO ERROR: src\third_party\tcc\tcc.exe doesn't exist. Please verify that you have put it in the right location.
ECHO Download it from https://github.com/FitzRoyX/tinycc/releases/download/tcc_20221020/tcc_20221020.zip
ECHO Download it from https://github.com/FitzRoyX/tinycc/releases/download/tcc_20230519/tcc_20230519.zip
ECHO It needs to be the 64-bit version.
ECHO:
PAUSE
Expand All @@ -17,7 +17,7 @@ IF NOT EXIST "third_party\tcc\tcc.exe" (
IF NOT EXIST "%SDL2%\lib\x64\SDL2.dll" (
ECHO:
ECHO ERROR: SDL is not unzipped properly into %SDL2%
ECHO Download it from https://github.com/libsdl-org/SDL/releases/download/release-2.24.1/SDL2-devel-2.24.1-VC.zip
ECHO Download it from https://github.com/libsdl-org/SDL/releases/download/release-2.28.2/SDL2-devel-2.28.2-VC.zip
ECHO:
PAUSE
EXIT /B 1
Expand Down