From f11e7c5b6e4ebd47cf4bc58a37a53f309b5aba84 Mon Sep 17 00:00:00 2001 From: Syntriax Date: Wed, 16 Nov 2022 21:50:54 +0300 Subject: [PATCH] Update Readme --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6061776..95f638c 100644 --- a/README.md +++ b/README.md @@ -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`