Syntriax
/
Movement
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update Readme

This commit is contained in:
Syntriax 2022-11-16 21:50:54 +03:00
parent d73bf5308e
commit f11e7c5b6e
1 changed files with 14 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,13 +1,25 @@
# Movement (Work In Progress)
## Getting Started 2D (Quick)
## Dependencies
1. [ToggleState Module](https://git.syntriax.com/Syntriax/ToggleState)
2. [Trigger Module](https://git.syntriax.com/Syntriax/Trigger)
Make sure to clone these modules along with this one.
Or you can call ```git submodule init``` to get them automatically added (note that this method may cause conflicts if another module also imports one of these submodules too, only use if you are only using `Movement` module)
---
## Getting Started 2D
### Quick
1. Clone the module to a folder in your Assets folder
2. Add `MovementController` component to your Player `GameObject`
3. Add `GroundMovement1D` component to your Player `GameObject`
4. Connect your inputs to the `MovementController` ([Example with Input System](#input-system-example))
## Getting Started 2D (Longer)
### Longer
1. Clone the module to a folder in your Assets folder
2. Add `ToggleStateMonoBehaviour` component to your Player `GameObject`