Skip to content

Commit a86600f

Browse files
authored
Sbb3 (#238)
* Update Controller-sys-botbase.md * Update ControllerList.md * Update README.md * Update Controller-sys-botbase.md * Update Controller-sys-botbase.md * Update Controller-sys-botbase.md
1 parent c76009c commit a86600f

File tree

3 files changed

+30
-31
lines changed

3 files changed

+30
-31
lines changed

Wiki/SetupGuide/ControllerList.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This is a full list of controllers that we currently support.
77
| <img src="Images/ControllerSetup-ESP32-S3.jpg" width="200"> | ESP32-S3 | Wired Pro Controller (3rd Party) | [Guide (Windows)](Controllers/Controller-ESP32-S3.md) |
88
| <img src="Images/ControllerSetup-ESP32-WROOM.jpg" width="200"> | ESP32-WROOM | Wireless Pro Controller<br>Left Joycon<br>Right Joycon | [Guide (Windows)](Controllers/Controller-ESP32-WROOM.md)<br>[Guide (Mac)](Controllers/Controller-ESP32-WROOM-MacOS.md) |
99
| <img src="Images/ControllerSetup-Leonardo.jpg" width="200"> | Arduino Uno R3<br>Arduino Leonardo<br>Teensy 2.0<br>Teensy++ 2.0<br>Pro Micro | Wired Pro Controller (3rd Party) | [Arduino Uno R3](Controllers/Controller-ArduinoUnoR3.md)<br>[Arduino Leonardo](Controllers/Controller-ArduinoLeonardo.md)<br>[Teensy(++) 2.0 (Mini-Grabbers)](Controllers/Controller-Teensy2-MiniGrabbers.md)<br>[Teensy(++) 2.0 (Hammer Headers)](Controllers/Controller-Teensy2-HammerHeaders.md)<br>[Pro Micro (Mini-Grabbers)](Controllers/Controller-ProMicro-MiniGrabber.md)<br>[Pro Micro (Hammer Headers)](Controllers/Controller-ProMicro-HammerHeaders.md) |
10-
| <img src="Images/ControllerSetup-sbb.jpg" width="200"> | sys-botbase 2/3 | Wired Pro Controller | [sys-botbase 2](Controllers/Controller-sys-botbase.md)<br>sys-botbase 3 (under development) |
10+
| <img src="Images/ControllerSetup-sbb.jpg" width="200"> | sys-botbase 2/3 | Wired Pro Controller | [sys-botbase](Controllers/Controller-sys-botbase.md) |
1111

1212

1313

Wiki/SetupGuide/Controllers/Controller-sys-botbase.md

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Controller Setup: sys-botbase
22

3+
***Update August 9, 2025: This guide has been updated for sys-botbase 3 (sbb3).***
4+
35
This sys-botbase setup is intended for experienced CFW (custom firmware) Switch users who want to try out our computer-control (CC) programs without buying all the additional hardware that is needed.
46

57
If you do not have CFW (and are thus starting from scratch), we [recommend going back](../README.md#the-controller-the-computers-hands) and choosing one of the other controller options as they are more reliable than this option. You do not need CFW or sys-botbase to run CC programs. Likewise, the CC programs only use sys-botbase for its controller. It does not touch any of its "hacking" features like reading and modifying game memory.
@@ -33,11 +35,20 @@ Make sure you have everything else setup so that it looks like this:
3335

3436
If not, you should go back to the [general setup guide](../README.md) and start over.
3537

36-
### Step 1: Install sys-botbase and ldn-mitm
38+
### Step 1: Install ldn_mitm
39+
40+
1. Download and unzip ld-mitm: https://github.com/Lusamine/ldn_mitm/releases/latest
41+
2. Copy the contents into the root of your SD card.
42+
43+
### Step 2: Install sys-botbase 3 (sbb3)
44+
45+
1. Download and unzip sbb3: https://github.com/PokemonAutomation/sys-botbase-cpp/releases/latest
46+
2. Copy the contents into the root of your SD card.
3747

38-
If you are reading this, you probably already have these setup. If not, [here's the guide](https://github.com/kwsch/SysBot.NET/wiki/Bot-Startup-Details).
48+
Note that this is sys-botbase 3. This is an improved rewrite of the original sys-botbase that has additional features required by CC to achieve maximum performance and stability.
49+
sbb3 is backwards compatible with the official sys-botbase (sbb2) aside from the removal of the ACNH features. So you should be able to still use all your existing programs that rely on sbb2.
3950

40-
### Step 2: Navigate your Switch to where it will accept a new controller.
51+
### Step 3: Navigate your Switch to where it will accept a new controller.
4152

4253
sys-botbase will create a virtual wired controller that behaves like a real controller. So it can only connect if your Switch is ready for it.
4354

@@ -48,18 +59,18 @@ Places where the Switch will accept a new controller:
4859

4960
<img src="../Images/GripMenu.png">
5061

51-
### Step 3: Connect to the Switch
62+
### Step 4: Connect to the Switch
5263

5364
1. At the top for the "Controller" option, click the dropdown and select `TCP: sys-botbase` .
54-
2. Enter the IP address and port of your Switch. (e.g. `192.168.1.123:6000`)
65+
2. Enter the IP address and port of your Switch. (e.g. `192.168.1.123:6000`) The port is always 6000 for all versions of sbb to date.
5566

5667
If everything worked correctly, it will look like this:
5768

5869
<img src="../Images/ControllerSetup-sbb-Connected-Labled.png">
5970

6071
If not, see [troubleshooting](#troubleshooting).
6172

62-
### Step 4: Test the connection
73+
### Step 5: Test the connection
6374

6475
You can control your Switch from the keyboard. Click on the video display to activate the keyboard controls. Then try pressing some buttons. You can view the keyboard -> controller mapping by clicking on the "keyboard layout" at the bottom left corner of the program.
6576

@@ -69,7 +80,7 @@ The default layout is the standard WASD setup for FPS games on the most common Q
6980

7081
<img src="../Images/ControllerSetup-sbb-Controls.png">
7182

72-
### Step 5: You are done!
83+
### Step 6: You are done!
7384

7485
If keyboard commands are working (along with video and audio), you are done!
7586

@@ -100,7 +111,7 @@ These are standard network connection issues. Common causes:
100111
- Local connection is enabled and ldn-mitm is not enabled. This will block the network connection.
101112
- You have dual-band wifi where your Switch is connected to one band while your computer is connected to the other.
102113

103-
Sometimes, an older connection does not shutdown properly causing new connections to fail (i.e. a zombie state). You can try undocking your Switch and going in/out of a game several times, similarly with airplane mode. Otherwise, you may need to reboot the Switch.
114+
If all else fails, try undocking your Switch and going in/out of a game several times, similarly with airplane mode. Otherwise, you may need to reboot the Switch.
104115

105116

106117
### Connected, but keyboard commands don't work.
@@ -115,11 +126,7 @@ Most programs will block keyboard inputs if the program is running. So if you ha
115126

116127
The response time is how long it takes to round-trip from your computer to sys-botbase and back. It will always be longer than a ping due to overhead within sys-botbase and/or Atmosphere.
117128

118-
It should be less than 5ms, but can occasionally spike to over 100ms during periods of high traffic. This is normal. But if it stays above 50ms, you will have difficulty running many of the programs. So you will want to fix this. (usually by improving your network connection)
119-
120-
Sometimes the Switch will get into a temporary slow state where this response time stays very high (> 100ms). This can usually be cleared by rebooting the Switch.
121-
122-
Overall, this is not great and is why sys-botbase is less reliable than the other (microcontroller) options which are usually <1ms latency.
129+
High reponse time used to be a huge problem with sys-botbase 2.4. But starting from sys-botbase 3.0, it is less of an issue since it can buffer commands to retain timing precision.
123130

124131
### "Last Ack: xxx seconds ago"
125132

@@ -132,17 +139,9 @@ This means the Switch has stopped responding to the computer's commands. The mos
132139

133140
<img src="../Images/ControllerSetup-sbb-TickPrecise.png">
134141

135-
sys-botbase lacks the timing precision that the Arduino can achieve. Therefore programs that require precise controller timings will not run reliably over sys-botbase and are therefore blocked from running. (we don't want people to file bugs when they run the program and it breaks)
136-
137-
The programs on the sidebar are color-coded on what controllers they can run on:
138-
- **Blue:** Runs on all controllers with no issues.
139-
- **Green:** Runs on all controllers, but will have degraded performance/reliability on imprecise controllers (such as sys-botbase).
140-
- **Purple:** Only runs on precise controllers. (will not run on sys-botbase)
141-
- **Red:** Specialized programs that only run on specific controllers. (will not run on sys-botbase)
142-
143-
Thus sys-botbase can only run blue and green programs. For everything else, you will need to use one of the [microcontroller setups](README.md#the-controller-the-computers-hands).
142+
If you are seeing this message, it means you are running sys-botbase 2.x. This version of sys-botbase lacks the timing precision needed to run many of our programs.
144143

145-
If you are a sysmodule developer and are interested in fixing sys-botbase, please hit us up in [Discord](https://discord.com/channels/695809740428673034/709201831066206268) to discuss. We think we know what the problem is and we have ideas on how to fix it. But we have neither the expertise nor the developer bandwidth to do it ourselves.
144+
Please upgrade to sys-botbase 3.0 or later.
146145

147146

148147
### Multi-Switch programs don't work.
@@ -154,11 +153,6 @@ There is no general solution to this. For some programs, you may be able to work
154153
Using ethernet instead of wireless does not solve this problem as local communication mode will kill this as well.
155154

156155

157-
### usb-botbase
158-
159-
usb-botbase is (generally) not an option because it requires the same USB port that is needed for the HDMI output.
160-
161-
162156

163157

164158

@@ -185,3 +179,7 @@ usb-botbase is (generally) not an option because it requires the same USB port t
185179

186180

187181

182+
183+
184+
185+

Wiki/SetupGuide/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,8 +100,8 @@ We currently support 3 different types of controllers. So take your pick on whic
100100
| **Supported Microcontrollers:**<br>ESP32-WROOM-32<br><br><br><br><br> | **Supported Microcontrollers:**<br>ESP32-S3<br>Arduino Uno R3<br>Arduino Leonardo<br>Teensy 2.0 / Teensy++ 2.0<br>Pro Micro | **Supported Microcontrollers:**<br>None required.<br><br><br><br><br> |
101101
| Currently does not work on Switch 2. | Works on Switch 2. | Does not work on Switch 2 due to lack of CFW. |
102102
| Cheapest and easiest to setup for the average user. | More expensive. Also easy to setup if you pick ESP32-S3. Others are harder to setup. | Requires a hacked Switch running custom firmware (CFW). |
103-
| Can run LGPE programs.<br>Cannot run Sword/Shield day-skippers.<br>Runs all other programs.* | Cannot run LGPE programs.<br>Runs all other programs.* | Cannot run LGPE programs.<br>Runs most other programs.*<br>Cannot run programs that require timing precision. |
104-
| Fast and reliable for most programs. | Fastest and most reliable. Best for high-speed programs (date-spam exploits, FCE). | Runs most programs well. Slow and unreliable for high-speed programs. |
103+
| Can run LGPE programs.<br>Cannot run Sword/Shield day-skippers.<br>Runs all other programs.* | Cannot run LGPE programs.<br>Runs all other programs.* | sbb3: Identical to wired controllers.<br>sbb2: Cannot run programs that require timing precision. |
104+
| Fast and reliable for most programs. | Fastest and most reliable. Best for high-speed programs (date-spam exploits, FCE). | sbb3: Identical to wired controllers.<br>sbb2: Runs most programs well. Slow and unreliable for high-speed programs. |
105105
| Not recommended for remote access.<br>Not recommended for high density setups due to wireless interference. | Very good for remote access.<br>Very good for high density setups. | Not recommended for remote access. |
106106
| Recommended for all users including beginners. | Recommended for users who want maximum performance and reliability. | Recommended for regular CFW users who want to try CC programs with minimal investment. |
107107

@@ -193,3 +193,4 @@ Here are some misc. tips/tricks, and other hidden features of the CC programs!
193193

194194

195195

196+

0 commit comments

Comments
 (0)