You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51-1
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,19 @@
1
1
# smw
2
+
A reimplementation of Super Mario World.
2
3
3
4
Our discord server is: https://discord.gg/AJJbJAzNNJ
4
5
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
6
17
7
18
You must self-build for now. Easy method on 64-bit Windows (no terminal or big downloads):<br>
8
19
(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
17
28
18
29
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.
19
30
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 |
0 commit comments