Skip to content

Commit 01ab462

Browse files
committed
Update Readme
1 parent c6b3b6a commit 01ab462

File tree

3 files changed

+22
-12
lines changed

3 files changed

+22
-12
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,33 +66,43 @@ To use the script, run it from the command line with various options:
6666

6767
- **Log Intervals**: The script logs data counts every second and provides a summary every 10 minutes, including the sampling rate and drift in seconds per hour.
6868

69-
## Applications
69+
## Applications
70+
To open another terminal and run an application, ensure the **LSL Stream** is running first.
7071

71-
### GUI
72+
### Installation
73+
Before running any application, install all dependencies with the following command:
74+
75+
```bash
76+
pip install -r app_requirements.txt
77+
```
78+
79+
### Available Applications
80+
81+
#### GUI
7282

7383
- `python gui.py`: Enable the real-time data plotting GUI.
7484

75-
### FORCE BALL GAME
85+
#### TUG OF WAR GAME
7686

77-
- `python game.py`: Enable a GUI to play game using EEG Signal.
87+
- `python game.py`: Enable a GUI to play tug of war game using EEG Signal.
7888

79-
### HEART RATE
89+
#### HEART RATE
8090

8191
- `python heartbeat_ecg.py`:Enable a GUI with real-time ECG and heart rate.
8292

83-
### EMG ENVELOPE
93+
#### EMG ENVELOPE
8494

8595
- `python emgenvelope.py`: Enable a GUI with real-time EMG & its Envelope.
8696

87-
### EOG
97+
#### EOG
8898

8999
- `python eog.py`: Enable a GUI with real-time EOG that detects the blinks and mark them with red dot.
90100

91-
### EEG
101+
#### EEG
92102

93103
- `python ffteeg.py`: Enable a GUI with real-time EEG data with its FFT.
94104

95-
### Keystroke
105+
#### Keystroke
96106

97107
- `python keystroke.py`: On running, a pop-up opens for connecting, and on pressing Start, blinks are detected to simulate spacebar key presses.
98108

game.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
# Screen dimensions
1717
WIDTH, HEIGHT = 800, 600
1818
screen = pygame.display.set_mode((WIDTH, HEIGHT))
19-
pygame.display.set_caption("Force Ball Game")
19+
pygame.display.set_caption("EEG Tug of War Game")
2020

2121
# Colors
2222
WHITE = (255, 255, 255)
@@ -50,7 +50,7 @@
5050
# Font settings
5151
font_size = 50
5252
font = pygame.font.Font(None, font_size)
53-
title_text = "Force Ball Game"
53+
title_text = "EEG Tug of War Game"
5454

5555
title_surface = font.render(title_text, True, WHITE)
5656
title_rect = title_surface.get_rect(center=(800 // 2, font_size)) # Center at the top middle

templates/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ <h1>Chords-Python Applications</h1>
6262
<button type="submit" name="app_name" value="game"
6363
class="{% if 'game' in running_apps %}running{% else %}not-running{% endif %}"
6464
{% if not lsl_started %}disabled{% endif %}>
65-
Force Ball Game
65+
EEG Tug of War Game
6666
</button>
6767
<button type="submit" name="app_name" value="gui"
6868
class="{% if 'gui' in running_apps %}running{% else %}not-running{% endif %}"

0 commit comments

Comments
 (0)