You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+8-11Lines changed: 8 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,19 @@
2
2
3
3
Welcome to Subway Scholars, a gamified productivity application that transforms your study schedule into an engaging runner experience.
4
4
5
-
Take control of your focus time by automatically generating dynamic study sprints using AI, and conquer distractions with an OS-level blocker that forces you to answer academic quizzes if you try to open social media.
5
+
Take control of your focus time by automatically generating dynamic study sprints using AI, and conquer distractions with an OS-level blocker that forces you to answer academic quizzes if you try to slack off.
6
6
7
7
---
8
8
9
9
## Features
10
10
11
11
-**AI-Powered Missions**: Upload your `.ics` calendar file, course syllabus, or simply type your study goals. The AI integration automatically maps out your available time and generates focused study sprints.
12
12
-**Gamified Interface**: An arcade-inspired aesthetic with active mission banners and animated timers.
13
-
-**The Guard Blocker**: When an active mission is running, the Python backend continuously monitors your system for distractions (like YouTube or Instagram). If you open them, an un-closable overlay pops up on your screen.
13
+
-**Universal Global Blocker**: When an active mission is running, the Python backend continuously monitors *all* of your active OS windows. If you switch to an application (like YouTube or a video game), the AI evaluates if it is relevant to your sprint. If it determines you are getting distracted for more than 15 seconds, an un-closable overlay pops up on your screen.
14
14
-**AI Penalty Quizzes**: To unlock your screen from the blocker, you must correctly answer 3 AI-generated multiple-choice questions tailored to the specific subject you are currently studying.
15
-
-**Emergency Exit**: If you have a legitimate emergency, you can use the Emergency Exit button in the web app. It requires you to type a randomly generated safety phrase to break your focus streak and unlock the system immediately.
15
+
-**Sprint Management**: You can pause and resume your active sprints (e.g., for a 5, 10, 15, or 20-minute break), during which time the global blocker will safely disengage. Sprints will also automatically end upon completion, displaying a congratulatory message and migrating to your historical "Completed Quests" list.
16
+
-**User Profiles**: Create an account to log in and securely track your Total Points, completed sprints, and study history.
17
+
-**Emergency Exit**: If you have a legitimate emergency while blocked, you can use the Emergency Exit button in the web app. It requires you to type a randomly generated safety phrase to break your focus streak and unlock the system immediately.
16
18
17
19
---
18
20
@@ -39,7 +41,7 @@ To run Subway Scholars locally, you'll need:
Leave this terminal window open. The Python guard is now monitoring for API requests and system distractions.
64
66
65
67
### 2. Launch the Web App
66
-
Open your file explorer, navigate to `Subway-Scholars/app/`, and double-click `index.html` to open it in your browser.
68
+
Open your file explorer, navigate to `Subway-Scholars/app/`, and double-click `auth.html` to register an account or log in. From there, you will be redirected to the main hub.
67
69
68
70
### 3. Start a Mission
69
71
- Type what you want to study into the Mission Board or upload a calendar syllabus.
70
72
- Click **Generate Sprints**.
71
73
- Click on an active sprint card to begin your focus timer.
72
-
73
-
---
74
-
75
-
## Notes on the OS Blocker
76
-
- By default, the blocker looks for window titles containing "youtube" or "instagram". You can add more restricted apps to the `BLACKLIST` variable at the top of `bouncer/main.py`.
77
-
- The pop-up quiz will pause the OS monitoring for 15 seconds after a successful unlock, giving you enough time to close the distracting window before it catches you again.
74
+
- The Global Blocker will now continually assess whatever application you have focused against your active topic.
0 commit comments