Skip to content

Commit fa4b023

Browse files
committed
Update readme
1 parent 1e3d169 commit fa4b023

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

+10-11
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,29 @@
11
# SplitNX
22
LiveSplit Server plugin for autosplitting on the Nintendo Switch!
33

4-
Simply `make dist` and add the files within the dist folder to your SD card. Must run with CFW (Use Atmosphere or Kosmos or it will probably not work).
4+
Simply `make` and then move the SplitNX.ovl file to your `switch/.overlays` directory on your SD card. Make sure to install Tesla as well, you can find instructions [here](https://gbatemp.net/threads/tesla-the-nintendo-switch-overlay-menu.557362/).
5+
56
Includes both basic autosplitting from memory and manual splitting with controller.
6-
All controls require you to hold all 4 shoulder buttons then press:
7+
All controls require you to hold ZR + R (ZL and L must not be pressed as well!), and then press:
78
A - Split/Start
8-
B - Undo Split
9+
Y - Undo Split
910
X - Skip Split
10-
Y - Reset
11+
Minus - Go back to options screen
12+
Plus - Toggle the GUI for LiveSplit time/split name
1113

1214
The autosplitting is read in from `/split/splitter.txt` on your SD card which has the following format:
1315

1416
First line: IP of computer
1517

16-
Second line: Port of LiveSplit Server
18+
Second line: Port of LiveSplit Server (typically 16384)
1719

1820
Every line after that will correspond to a memory autosplit corresponding with the index of the split in LiveSplit (so the 3rd line will describe autosplitting for the first split, and so on):
1921

20-
[Offset Address from Heap start] [operator] [size] [value]
22+
[Memory region type i.e. `heap` or `main`] [Offset Address from Heap start] [operator] [size in bits, multiple of 8] [value to compare with]
2123

2224
Example:
23-
`0x61BC93B6 >= u32 1001` will check whether or not the unsigned 32 bit integer at HEAP + 0x61BC93B6 is greater or equal to the value of 1001. If so it will split for that split index.
24-
25-
26-
This is super rough, just wanted to get something working for now, and I may or may not improve it later. If anyone wants to improve it then by all means go for it. Would be great to get it to hook into the already implemented AutoSplitters for LiveSplit but I have no clue how to do that.
25+
`heap 0x61BC93B6 >= 32 1001` will check whether or not the 32 bit integer at HEAP + 0x61BC93B6 is greater or equal to the value of 1001. If so it will split for that split index.
2726

2827
Any questions feel free to ask.
2928

30-
Example of it running: https://youtu.be/K0eXAhT2AB4
29+
Example of it running: https://youtu.be/8Q5mv84v8-g

0 commit comments

Comments
 (0)