Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Forgot to update readme. Included videos and better formatting.
  • Loading branch information
dryice10 authored Feb 27, 2024
1 parent d1b8db6 commit 6c52c9d
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
The Ghosts folder contains example ghosts, you can rename one to ghost.gc and put it in your settings folder to race against it.

0 comments on commit 6c52c9d

Please sign in to comment.