Skip to content

Commit d4c4f4c

Browse files
committed
adding build instructions
1 parent 9456cba commit d4c4f4c

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Lets you easily load a ROM onto your sd2snes by using usb2snes! Great for Rando runners, and especially great for MSU-1 users.
44

5+
## Building it yourself
6+
7+
Install pyinstaller so you can build the exe, which is a packaged python distribution (no dependancy on python) - `pip install pyinstaller`
8+
Install the required packages, hopefully requirements.txt is complete - `pip install -r requirements.txt`
9+
Build the project - `pyinstaller --onefile src/romloader.py`
10+
11+
Usable executable should be in the build directory.
12+
513
## Usage
614

715
Put romloader.exe in a place that is likely not to change. Copy romloader.yaml to the same directory as your romloader.exe if you want to customize the behavior. Have Windows open the .sfc or .smc file with romloader.exe!
@@ -108,27 +116,27 @@ rules:
108116
109117
## Troubleshooting
110118
111-
Problem: RomLoader hangs without any input
119+
**Problem**: RomLoader hangs without any input
112120
113-
Solutions:
121+
**Solution**:
114122
1. try restaring usb2snes.exe
115123
2. power off and back on your sd2snes
116124
3. load a game that doesn't use MSU-1 or a special chip via the sd2snes menu
117125
118126
Basically RomLoader is having trouble interacting with the usb2snes.
119127
120128
121-
Problem: MSU-1 music doesn't play as expected.
129+
**Problem**: MSU-1 music doesn't play as expected.
122130
123-
Solutions: In my testing, I've noticed that sometimes the music won't load
131+
**Solution**: In my testing, I've noticed that sometimes the music won't load
124132
correctly if another game is currently running, especially other MSU-1 or
125133
special chip games. Try resetting to the sd2snes menu first before loading
126134
your game.
127135
128136
129-
Problem: MSU-1 music freezes and plays a really loud sound while RomLoader is
137+
**Problem**: MSU-1 music freezes and plays a really loud sound while RomLoader is
130138
copying the ROM to the SD card.
131139
132-
Solution: This is a current limitation of MSU-1 and usb2snes. If this is
140+
**Solution**: This is a current limitation of MSU-1 and usb2snes. If this is
133141
annoying (especially if streaming), go to the sd2snes menu first before loading
134142
a ROM.

0 commit comments

Comments
 (0)