Skip to content

Commit 747df5a

Browse files
authored
Update README.md
1 parent dfe1c4f commit 747df5a

File tree

1 file changed

+51
-1
lines changed

1 file changed

+51
-1
lines changed

Diff for: README.md

+51-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,19 @@
11
# smw
2+
A reimplementation of Super Mario World.
23

34
Our discord server is: https://discord.gg/AJJbJAzNNJ
45

5-
Early version. It has bugs and the code is messy.
6+
## About
7+
8+
This is a reverse engineered clone of Super Mario World.
9+
10+
It reimplements all parts of the original game and a bunch of mods added by Lunar Magic. The game is playable from start to end.
11+
12+
You need a copy of the ROM to extract game resources (levels, images). Then once that's done, the ROM is no longer needed.
13+
14+
It uses the PPU and DSP implementation from [LakeSnes](https://github.com/elzo-d/LakeSnes), but with lots of speed optimizations.
15+
16+
## Building
617

718
You must self-build for now. Easy method on 64-bit Windows (no terminal or big downloads):<br>
819
(1) Download [Python](https://www.python.org/ftp/python/3.11.4/python-3.11.4-amd64.exe) if you don't have it and install with "Add to PATH" checked<br>
@@ -17,3 +28,42 @@ For other platforms and compilers, see: https://github.com/snesrev/smw/blob/main
1728

1829
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.
1930

31+
## Usage and controls
32+
33+
The game supports snapshots. The joypad input history is also saved in the snapshot. It's thus possible to replay a playthrough in turbo mode to verify that the game behaves correctly.
34+
35+
| Button | Key |
36+
| ------ | ----------- |
37+
| Up | Up arrow |
38+
| Down | Down arrow |
39+
| Left | Left arrow |
40+
| Right | Right arrow |
41+
| Start | Enter |
42+
| Select | Right shift |
43+
| A | X |
44+
| B | Z |
45+
| X | S |
46+
| Y | A |
47+
| L | C |
48+
| R | V |
49+
50+
The keys can be reconfigured in smw.ini
51+
52+
Additionally, the following commands are available:
53+
54+
| Key | Action |
55+
| --- | --------------------- |
56+
| Tab | Turbo mode |
57+
| P | Pause (with dim) |
58+
| Shift+P | Pause (without dim) |
59+
| Ctrl+Up | Increase window size |
60+
| Ctrl+Down | Decrease window size |
61+
| T | Toggle replay turbo mode |
62+
| K | Clear all input history from the joypad log |
63+
| L | Stop replaying a shapshot |
64+
| R | Toggle between fast and slow renderer |
65+
| F | Display renderer performance |
66+
| F1-F10 | Load snapshot |
67+
| Alt+Enter | Toggle Fullscreen |
68+
| Shift+F1-F10 | Save snapshot |
69+
| Ctrl+F1-F10 | Replay the snapshot |

0 commit comments

Comments
 (0)