Fix many problems with the README

This commit is contained in:
Colormatic
2023-12-02 15:19:47 -08:00
committed by GitHub
parent 4207b61075
commit 93bb50b9fa

View File

@ -22,13 +22,15 @@ Move with WASD, space to jump, shift to sprint, C to crouch.
If you make a cool game with this addon, I would love to hear about it! If you make a cool game with this addon, I would love to hear about it!
# Wiki # Wiki
To start out, you should probably remap all of the movement keys to your own control set. **To start out**, you should probably remap all of the movement keys to your own control set.
You can make this a super basic controller by just disabling everything You can make this a super basic controller by just disabling everything.
**How to change settings** **How to change settings:**
Click on the character node and there should be settings in the "Feature Settings" group
Click on the character node and there should be settings in the "Feature Settings" group.
**How to add animations for a mesh:** **How to add animations for a mesh:**
In the `_physics_process` function, add a line to check whether you are walking or aren't walking. You can do this by checking whether `input_dir` is true or false. Optionally, set the animation speed to `speed / base_speed`. This will make it so when the player is walking, your animation speed is 1. If the player is sprinting, your animation goes up and if the player is crouching your animation speed goes down. In the `_physics_process` function, add a line to check whether you are walking or aren't walking. You can do this by checking whether `input_dir` is true or false. Optionally, set the animation speed to `speed / base_speed`. This will make it so when the player is walking, your animation speed is 1. If the player is sprinting, your animation goes up and if the player is crouching your animation speed goes down.
In the `toggle_sprint` function, add a line at the end where if `is_sprinting` is true, your animation is set to sprint. In the `toggle_sprint` function, add a line at the end where if `is_sprinting` is true, your animation is set to sprint.
@ -37,7 +39,7 @@ In the `toggle_crouch` function, add a line where if `is_crouching` is true, you
To check if the player is in the air, add a line in the `_physics_process` function where it says `if not is_on_floor():`set your animation to falling/in the air. Add an else statement to change it to the normal state. To check if the player is in the air, add a line in the `_physics_process` function where it says `if not is_on_floor():`set your animation to falling/in the air. Add an else statement to change it to the normal state.
**How to change reticles (crosshairs)** **How to change reticles (crosshairs):**
- Find the folder at `res://addons/fpc/reticles` - Find the folder at `res://addons/fpc/reticles`
- Pick one and add it to the `UserInterface` node in the character scene. You may need to right click on the character and enable "Editable Children". - Pick one and add it to the `UserInterface` node in the character scene. You may need to right click on the character and enable "Editable Children".
- Set the Character value to your character node (it's under the Nodes group) - Set the Character value to your character node (it's under the Nodes group)