diff --git a/README.md b/README.md index c3bb9f6..081f889 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # Interceptor-APS **Interceptor, the State of the Art APS (Active Protection System)** +Version A-2

Interaction-based Nondominant Terminal-Executable Revertible Central Electronic Pythonic Technological ORienter

@@ -36,35 +37,45 @@ On launch, Interceptor will display this in the console: ``` ================================================================================ -Interceptor APS (Active Protection System) +Interceptor APS (Active Protection System) ===== TESTMODE: False -------------------------------------------------------------------------------- Choose a cover app to open: -[1] Chrome (empty) -[2] Edge (empty) -[3] Adobe Illustrator (predetermined) -[4] Onenote (Identical) -[5] Enter a path (Not recommended) -[6] It has a name (NOTE) +[1] Chrome (1) +[2] Edge (1) +[3] Adobe Illustrator (2) +[4] Onenote (3) +[5] Enter a path (4) +[6] Specify Chrome Tab Number (5) +[7] Specify Window Name (6) + +[x] Help +[y] Set test mode -- Empty: window opens empty -- Predetermined: window opens with whatever was on it. - * Requires having it open in the first place -- Identical: a NEW window opens with what you had earlier/what you have now. -- Not recommended: Only use this if you know what you're doing. - * If you get the path wrong, the program will fail you at the most critical moment. -- NOTE: Probably the best way by far. - * Type the name of the window (partial names work, like note for OneNote) and it will pop up. Enter your option > ``` -Empty: Means that the program will be opened with an empty window, if the application startup settings are default. Otherwise, it will open as per the configuration in the individual app. - -Predetermined: Some applications open with what they already have. These applications require you to open the app and set it up to a desired state first, then leave it open in the background. - -Identical: These applications open with whatever they had before if closed, and a new instance of what they have now if already opened. It is not required to do anything but it is recommended to open the app, set it up to a desired page, then close it. - -Not Recommended: This refers to the Path function. It is not yet verified if double escapes are required for the path. - -NOTE: This option is the easiest way to bring an already existing window to the front. It requires the window to already be open, and that you know its name. Partial names and messy capitalization work in this case, like `note` for `OneNote` and `firefox` for `Firefox`. +Enter an option to begin, add more parameters if prompted, and enjoy your peace. +If you used help: + +``` +- (1): Opens a new, empty window of this program +- (2): Opens the window. You have to open the application first and set it up to the desired state to have it work. +- (3): Opens an identical but new window of what you already have. The program can be closed, but you must set it up to the desired state before closing it. +- (4): Enter a path to the program. This only opens the program and requires you to do research on the program behavior when opened. I am still verifying if you need to enter "\\" for each \. +- (5): Opens the specified chrome tab. This method is newly developed and is a bit slower to respond, but can precisely open any tab in chrome. +- (6): Specifies a window name. Partial names (wildcards) are default. +``` + +

Known Errors

+ +I was unable to finish this, but I will. Known errors include: + +Monitoring without paramters: It is possible to do this. Additionally, after using the Help function and Set Test Mode, the program automatically starts monitoring without a specified cover window. + +Test Mode: This is intended to trigger the cover immediately for test purposes. The test mode toggle is broken and it does not work, so the program is locked in `testmode = false` now. + +Unable to detect large grid: Unable to detect when teacher is looking at all of you. A known limitation for monitoring the Senso directory. + +I am also in the progress of turning the `main()` function into a `while True:` loop. If you encounter more problems, create an Issue.