Skip to content

Commit de2fdff

Browse files
update readme
1 parent f78a4e0 commit de2fdff

1 file changed

Lines changed: 18 additions & 20 deletions

File tree

docs/local_simulator_setup_instructions.md

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Local SeedSigner Simulator Setup
22

3-
This guide adds a method to setup SeedSigner testing locally through a simulator GUI for easy development.
3+
This guide adds a method to setup SeedSigner testing locally through a simulator GUI for easy development. You can either interact with the buttons at the window or use keyboard arrows, Enter, Numpad_1, Numpad_2, Numpad_3
44

5-
It was tested on macOS (26) using Homebrew and Python 3.14. With additional effort it would work on other operating systems and python version or it may still way directly I've not tested it as I don't own any other devices.
5+
Note: The has only been tested on macOS (26) using Homebrew and Python 3.14.
66

77
<img src="img/simulator.png" width=320 />
88

@@ -16,33 +16,33 @@ It was tested on macOS (26) using Homebrew and Python 3.14. With additional effo
1616

1717
### Installing system dependencies
1818

19-
SeedSigner’s simulator depends on native libraries for QR scanning and camera access.
19+
SeedSigner’s simulator depends on Python with `tkinter` support, native libraries for QR scanning and camera access.
20+
- `tkinter` is Python's built-in library for creating desktop GUI applications.
21+
- `pyzbar` library requires a backend to be running on the system called `zbar`.
2022

23+
#### MacOS (Homebrew)
2124
```bash
22-
brew install opencv zbar
25+
brew install python@3.14 # includes tkinter support
26+
brew install zbar
27+
```
28+
#### Linux
29+
```bash
30+
sudo apt-get install python3-tk
31+
sudo apt install libzbar0
2332
```
24-
25-
These provide:
26-
27-
- Camera capture backend (OpenCV)
28-
- QR decoding backend (zbar, used by `pyzbar`)
29-
30-
3133

3234
### Setting up dev environment
3335

34-
The GUI uses tkinter that usually bundles with python installation, but for any reason it is not present follow the guide to setup tkinter https://coderivers.org/blog/installing-tkinter-in-python
35-
3636
```bash
3737
git clone https://github.com/SeedSigner/seedsigner
3838

39-
python3.14 -m venv env
39+
python3 -m venv env
4040
source env/bin/activate
4141

4242
# should not fail loading tkinter
43-
python3.14 -m tkinter
43+
python3 -m tkinter
4444

45-
pip install -r requirements.txt
45+
pip install -r requirements-simulator.txt
4646
```
4747

4848
#### Camera Permissions (macOS Security)
@@ -54,7 +54,7 @@ OpenCV: not authorized to capture video
5454
OpenCV: camera failed to properly initialize
5555
```
5656

57-
#### Grant Camera Permission
57+
#### Grant Camera Permission (macOS)
5858

5959
Go to: System Settings → Privacy & Security → Camera
6060

@@ -73,10 +73,8 @@ tccutil reset Camera
7373

7474
### Running the Simulator
7575

76-
From the simulator directory:
77-
7876
```bash
79-
python src/gui.py
77+
python tools/run_emulator.py
8078
```
8179

8280
### Notes

0 commit comments

Comments
 (0)