From 439d1f3af9c450f9f3d5dfb099ef281b9fadd6a0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Maciej=20=C5=BBelazo?= Date: Sun, 11 Feb 2024 10:17:10 +0100 Subject: [PATCH] Add solutions to problems that may occur in different cases in readme While working with ecctrl I spent some time to figure out solution for these problems. There may be more and users will spend less time if the problems will be named in readme --- readme.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/readme.md b/readme.md index ae7b23f..13926d0 100644 --- a/readme.md +++ b/readme.md @@ -451,6 +451,32 @@ If you would like to quickly set up a first-person mode, you can modify these pr > ``` +### Popular problems and their solutions + +#### 1. Scene doesn't load and I get EcctrlAnimation component error + +Check if you filled essential animations, which are: + +```js +const animationSet = { + idle: "yourAnimationName", + walk: "yourAnimationName", + run: "yourAnimationName", + jump: "yourAnimationName", + jumpIdle: "yourAnimationName", + jumpLand: "yourAnimationName", + fall: "yourAnimationName", +} +``` + +#### 2. Animations play only once + +If you fill different properties of animationSet with the same name of animations, those will play only once. Try using different animations. + +#### 3. Character falls through the terrain + +Try to use different collider for the terrain mesh. + ## Contributions I appreciate your interest in this project! If you have any feedback, suggestions, or resources related to the controller, please feel free to share.