Create README.md

python_scripts/README.md

@@ -0,0 +1,39 @@
+# race_in_circles
+
+The `race_in_circles.py` script allows you to automate racing circular tracks using pyautogui and PS Remote Play. NOTE: The track MUST be circular. I think the script should work on any platform.
+
+## Instructions
+
+All you need to do is open PS Remote Play and then navigate to the race start screen for the track you want to automate. This is the screen with `Start`, `Settings`, and `Exit` buttons.
+
+Next, open a terminal with administrator privileges (I had to use administrator privileges, but you might not have to). Navigate to the directory containing this script and run it:
+
+```bash
+py race_in_circles.py
+```
+
+Voila! You are now racing in circles.
+
+By default this will race around a circular track with left turns for 200 seconds before navigating through the menus to restart the race. You can change the behavior by passing some command line arguments.
+
+- To change the side of the track you hug, you can pass the flag `--direction=DIRECTION`. By default you hug the `right` rail. You can also simply pass `-left` or `-l` or `-right` or `-r`.
+- You can change the duration with `--duration=DURATION`, where `DURATION` is the number of seconds that the race takes. You can also simply pass a number, like `200`. To get a sense for how long the race takes, start the script with a long duration, say `1000` seconds, and see how long it takes to navigate the course and then restart the script using the new duration (you should add some padding to account for collisions, maybe +10 seconds to be safe).
+
+The following command will automate a 120 second race where you hug the left hand rail of the course:
+
+```bash
+py race_in_circles.py --direction=left --duration=120
+```
+
+Another command that does the same thing:
+
+```bash
+py race_in_circles.py -left 120
+```
+
+## Notes
+
+Right now the script simply navigates through the menus for standard races and runs a race based on timing, meaning if you spin out or something the timing will likely be off.
+
+If you want to automate a different event, say a championship series, you can edit the script with new menu navigation commands. These are self explanatory in the script.
+