Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
MegaPiggy committed Oct 2, 2023
1 parent e06bb50 commit a2080dc
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
## Camera Shake
This mod adds some camera shakage to various parts of the game.
(Can also be used by other mods to add their own camera shakes?)

![Camera Shake](https://raw.githubusercontent.com/MegaPiggy/SBtT.CameraShake/main/CameraShakeThumbnail.png)

## Settings
Explosions - ship reactor, meteors/falling chunks, and a "bigger explosion."

Environment - sand funnel, island fling, the "large ship," and fishies.
Environment - sand funnel, island fling, "large ship" events, and fishies.

Ship - Hearthian and Nomai ship shakes.

Expand All @@ -17,7 +16,11 @@ Scout - shake from firing scout.

Jetpack Boost - off by default, as is too much shaking and makes other shakes not stand out. But you can turn it up if you want to vomit.

## For Other Modders
To add camera shakes to your own mod, copy the [ICameraShaker](https://github.com/MegaPiggy/SBtT.CameraShake/tree/main/CameraShake) script to your mod project.
It contains functions for different types of shakes, and properties to access the values for the settings above.

## Credits
- MegaPiggy - current programmer
- [Streetlights Behind the Trees](https://github.com/StreetlightsBehindTheTrees) - initial programmer
- [Streetlights Behind the Trees](https://www.youtube.com/@Sapphire12367) - programmer until v1.0.1
- [gasgiant/Jump Trajectory](https://github.com/gasgiant/Camera-Shake) - the actual Camera Shaker code (modified for the mod)

0 comments on commit a2080dc

Please sign in to comment.