Update Readme
This commit is contained in:
		
							
								
								
									
										14
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										14
									
								
								README.md
									
									
									
									
									
								
							@@ -12,14 +12,24 @@ Or you can call ```git submodule init``` to get them automatically added (note t
 | 
			
		||||
 | 
			
		||||
## Getting Started 2D
 | 
			
		||||
 | 
			
		||||
### Quick
 | 
			
		||||
### Automaticaly
 | 
			
		||||
#### Custom The Editor
 | 
			
		||||
 | 
			
		||||
1. Find the button on the Unity Editor's top panel named `Syntriax`, Under `Modules/Movement` open the window `Definition Creator`
 | 
			
		||||
3. You can find two buttons for both `Quick` and `Longer` presets, or you can define your own, then press `Create` button
 | 
			
		||||
4. Add `MovementDefinitionApplier` component to your Player `GameObject`
 | 
			
		||||
5. Put the name of the definition you created in the first step to `Startup Definition Name` field
 | 
			
		||||
    - You can also call `MovementDefinitionApplier.LoadDefinition` method manually to load them via anoher script.
 | 
			
		||||
 | 
			
		||||
### Manually
 | 
			
		||||
#### 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))
 | 
			
		||||
 | 
			
		||||
### Longer
 | 
			
		||||
#### Longer
 | 
			
		||||
 | 
			
		||||
1. Clone the module to a folder in your Assets folder
 | 
			
		||||
2. Add `ToggleStateMonoBehaviour` component to your Player `GameObject`
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user