From 8397b8ff4007f2a7d6d80db8cde58c943d560ac0 Mon Sep 17 00:00:00 2001 From: pbentes Date: Sun, 1 Sep 2024 23:50:57 +0100 Subject: [PATCH] Added a readme --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e2582dc --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Source Engine Movement + +A godot 4 implementation of the quake and source engine style of movement built around a state machine. + +This implementation utilizes an architecture which separates systems from the actors who use them. So, for instance, the player actor uses the state machine and the locomotion systems for handling player control but these same systems can be reused by an NPC actor. + +As of yet I'm aiming to implement the main movement mechanics from CS2 + +## Project structure + +- The levels folder contains playable levels and currently contains only a devtest level; + +- The modules folder contains the actors and systems folders; + + - The actors folder contains the player actor; + + - The systems folder contains the locomotion and the state machine systems; + +- The script_templates folder currently contains only a template for quickly creating a state script. + +## Features + +- [x] Running +- [x] Walking +- [x] Crouching +- [x] Airborne +- [ ] Ladder \ No newline at end of file