Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
Adding instructions on how to install the package from the Unity Package Manager.
  • Loading branch information
S-LucasSerrano committed Jan 28, 2024
1 parent b583694 commit 66eeaf8
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 11 deletions.
6 changes: 0 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,6 @@
/[Ll]ogs/
/[Uu]ser[Ss]ettings/

# Meta of the Git files
LICENSE.meta
README.md.meta
package.json.meta


# MemoryCaptures can get excessive in size.
# They also could contain extremely sensitive data
/[Mm]emoryCaptures/
Expand Down
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# Camera Shaker
``2.1``

A simple and easy-to-use Unity component to add juice and game feel to your games. This component shakes the camera using, instead of just random directions, the direction extracted from a perlin noise map. Making each movement feel more connected to the next one, and the shake overall, more fiscal and organic.

It was made following the tips of this amazing talk by Squirrel Eiserloh: [Watch the youtube video](https://www.youtube.com/watch?v=tu-Qe66AvtY&list=PLBJR0H4rFtvNiYaPg23POOJRNl3oXZZJ0&index=4&t=295s).

This repository includes a Unity Package file (.unitypackage) and a sample project that lets you test out the possibilities that it offers. You only need to download the Unity Package (.unitypackage) to import it into your project.

See everything this component can do and how to use it on the documentation, here: [S-LucasSerrano/CameraShaker/wiki](https://github.com/S-LucasSerrano/CameraShaker/wiki#camera-shaker--by-s-lucas-serrano)

You can play with the sample project directly from your browser on the itch.io page of the asset: [See on Itch.io](https://lucasserrano.itch.io/camerashaker).


***
### Installation
How to add the package to your project:

If you have git installed on your computer, from Untiy go to ``Window`` -> ``Package Manager`` -> ``+`` (top left) -> ``Add from Git Url`` and paste the URL to the git repo or the specific release you want.


If you don't have git installed, just download the code from here by going to `<> Code` on the top right -> ``Download .zip``, and add it to your project.


***
### About me
My name is Sergio Lucas Serrano! I'm a technical designer with a lot of focus on game feel.
Check out my itch page to see my own games using this sweet camera shake!
Expand All @@ -21,8 +28,8 @@ Check out my itch page to see my own games using this sweet camera shake!
Or contact me at:
- [email protected]

***

***
### License
You can use and/or modify this software for free in any personal or commercial project you want. If you end up using this in your games, let me know!

Expand Down
7 changes: 7 additions & 0 deletions README.md.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "lucasserrano.camera-shaker",
"displayName": "Camera Shaker",
"version":"2.1.0",
"description": "Simple component to add juice and game feel.",
"description": "Simple component to add juice to your games.",
"author": {
"name" : "S. Lucas Serrano",
"email" : "[email protected]",
Expand Down
7 changes: 7 additions & 0 deletions package.json.meta

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 66eeaf8

Please sign in to comment.