Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/colormaticstudios/quality-godot-first-person-2

An actually good first person controller for the Godot Engine (version 2)
https://github.com/colormaticstudios/quality-godot-first-person-2

first-person first-person-camera first-person-view game-development gamedev godot godotengine open-source

Last synced: about 1 month ago
JSON representation

An actually good first person controller for the Godot Engine (version 2)

Awesome Lists containing this project

README 

        
# quality-godot-first-person-2

Actually good first person controller for the Godot Engine.  

MIT License (credit Colormatic Studios)



This first person controller was made because there aren't many first person controllers for Godot, and the ones that do exist are pretty bad.  

It is highly customizable and comes with many features, QOL, and clean code.



Some parts came from StayAtHomeDev's FPS tutorial. You can find that [here](https://www.youtube.com/playlist?list=PLEHvj4yeNfeF6s-UVs5Zx5TfNYmeCiYwf).



# Directions

Move with WASD, space to jump, shift to sprint, C to crouch.



**FEATURES:**

- Extremely configurable

- In-air momentum

- Motion smoothing

- FOV smoothing

- Movement animations

- Crouching

- Sprinting

- 2 crosshairs/reticles, one is animated (more to come?)

- Controller/GamePad support (enabled through code, see wiki)

- In-editor tools (enable editable children to use)



If you make a cool game with this addon, I would love to hear about it!



# Wiki

**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.



**How to add controller/GamePad support**  

- In the controls export group, there is a commented section at the end that says "Uncomment this if you want full controller support". Uncomment that block.

- Make a key map for each direction (left, right, up, down) and map them to your joystick.

- Write in these keymaps in the controls section of the player settings.

- In the `handle_head_rotation` function, there is another block of commented code that says the same thing. Uncomment that too.

- You should now be able to look around with the joystick. Make sure you add the other controls to the input map. (movement, jumping, crouching, sprinting, etc.)



**Slope/staircase:**   

Credit to @roberto-urbani23  

In the character inspector, you can uncheck Stop on Slope and set the max angle to 89 (for some reason, 90 will make the player stuck). Also Snap Length to 1 otherwise your character will not remain attached to stairs if you sprint while going downstairs.



**How to change settings:**  

Click on the character node and there should be settings in the "Feature Settings" group.



**How to add animations for a mesh:**  

- Create a function for your animation and attach it to `_physics_process` to call it every frame.

- Use `input_dir` as a boolean (it is actually a `Vector2`) to know if the player is walking.

- Use the `state` member variable to tell if the player is sprinting or crouching.

- Use the `is_on_floor` function to tell if the player is standing or falling.



**How to change reticles (crosshairs):**  

Change the "Default Reticle" setting to your reticle file.  

During runtime:  

Use the `change_reticle` function on the character.



**How to create a new reticle:**  

- Choose a reticle to base it off of.

- Open that reticle and save it as a new reticle.

- Remove the script from the reticle and create a new one. (for some reason you have to do this)

- Edit the reticle to your needs.

- Follow the "how to change reticles" directions to use it.



**How to use the editor tools:**  

- Enable editable children on the `CharacterBody` node

- Use the options in the Properties tab to change things

- These changes apply in runtime as well