From 6c52c9d33f5dc56184ae8ce3b6554a665cbf4317 Mon Sep 17 00:00:00 2001 From: dryice10 <107770614+dryice10@users.noreply.github.com> Date: Tue, 27 Feb 2024 16:22:38 -0700 Subject: [PATCH] Update README.md Forgot to update readme. Included videos and better formatting. --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2ea7814..b47c94a 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,23 @@ # OpenGhosts -Record and playback Jak's position. Saves to a file so you can share with your friends! +Record and playback Jak's position. Saves to a text file so you can share with your friends! -Will crash if not in debug mode. Press Alt -> Click Debug Mode -> Reboot now. +Save path: %AppData%\OpenGOAL\jak1\settings\ghost.gc -If the mod doesn't start automatically, run: -(gmenu-1) +### Recording and playing back player movement. +https://github.com/dryice10/openghosts/assets/107770614/b7b4b95e-9815-450f-8ba7-2fe3dce4457f + +### Useful for visualizing and practicing against longer stretches of movement. + +https://github.com/dryice10/openghosts/assets/107770614/c638c47c-e22d-4d3b-87ca-129f79f1aace + +> [!IMPORTANT] +> This mod requires OpenGoal to run in debug mode, and will crash otherwise. Press Alt -> Click Debug Mode -> Reboot now. +> If the mod doesn't start automatically, use the REPL to run: +> (gmenu-1) -Ghosts are saved to: -%AppData%\OpenGOAL\jak1\settings\ghost.gc The mod file is here: goal_src\jak1\engine\mods\openghosts.gc -The Ghosts folder contains example ghosts, you can rename one and put it in the right folder to race against it. \ No newline at end of file +The Ghosts folder contains example ghosts, you can rename one to ghost.gc and put it in your settings folder to race against it.