Ecosyste.ms: Awesome

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

https://github.com/Phazorknight/Cogito

Immersive Sim Template Project for GODOT 4
https://github.com/Phazorknight/Cogito

Last synced: 28 days ago
JSON representation

Immersive Sim Template Project for GODOT 4

Lists

README

        

![COGITO_banner](docs/Cogito_capsule_202402_jpg.jpg)
# COGITO
[![GodotEngine](https://img.shields.io/badge/Godot_4.2.1_stable-blue?logo=godotengine&logoColor=white)](https://godotengine.org/) [![COGITO](https://img.shields.io/badge/beta_202405-35A1D7?label=COGITO&labelColor=0E887A)](https://github.com/Phazorknight/Cogito)
beta 202405.10

## What is it?
COGITO is a first Person Immersive Sim Template Project for Godot Engine 4.
In comparison to other first person assets out there, which focus mostly on shooter mechanics, COGITO focuses on
providing a framework for creating interactable objects and items.

COGITO is made by [Philip Drobar](https://www.philipdrobar.com) with help from [these contributors](https://github.com/Phazorknight/Cogito/graphs/contributors).

## Principles of this template
The structure of this template always tries to adhere to the following principles:
- **Complete**: When you download COGITO and press play, you get a functioning project out of the box. Game menu, save slot select, options and a playable level are all included.
- **Versatile**: Wether your game is set in the future, the past or the present, use melee, projectile or no weapons at all, have low poly, stylized or realistic graphics, the template will have features for you.
- **Modular**: Do not want to use a feature? You will be able to hide it, ignore it or strip it out without breaking COGITO. At the same time, COGITO is designed to be extendable with your own custom features or other add-ons.
- **Approachable**: While there will always be a learning curve, we strive to make COGTIO approachable and intuitive to use, so it doesn't get in your way of making your game.

## Current Features
- First person player controller with:
- Sprinting, jumping, crouching, sliding, stairs handling, ladder handling
- Fully customizable attributes like Health, Stamina, Visibility (for stealth) - Component-based, so easy to add your own.
- Lots of exposed properties to tweak to your liking (speeds, headbob, fall damage, bunnyhop, etc.)
- Easy-to-use dynamic footstep sound system
- Inventory System
- Flexible resource-based inventories
- Inventory UI separate from inventory logic
- Examples for multiple item types (consumables, keys, ammo, weapons, combinable Items)
- Base class to easily add your custom item types
- Interaction System
- Component-based interactions makes it easy to turn your own objects interactive quickly and customize existing ones
- Examples for interactive objects like doors, drawers, carryables, turn-wheels, elevators, readable objects, keypads
- Systemic Properties
- Give objects properties like "FLAMMABLE" or "WET" and they will interact with each other depending on their state and properties.
- For example FLAMMABLE objects can be ignited by objects that are actively on fire. Can be extinguished by objects that are WET.
- Straight forward system to add your own properties and behaviours, all handled in one script. Also easy to just ignore.
- Quest System
- Save and Load System as well as scene persistency
- Full gamepad support!
- Fully featured Demo Scene
- Set up like a game level including a variety of objects, weapons and quests
- In-game helper documents that explain how objects in the scene were set up

> [!IMPORTANT]
> COGITO is still under active develompent. While some features are pretty much set, others might change soon. Use at your own risk and check Issues and Discussion pages for more information.

## [Documentation](docs/documentation.md)

## Videos
**(OLD) Video giving an overview of features: [COGITO Overview](https://www.youtube.com/watch?v=LYBo1_Qfru0)**

[![COGITO Sliding door from scratch](docs/cog_tut_sliding_door.jpg)](https://youtu.be/rLBSxqjXlWY)
[![COGITO Wieldables Overview](docs/cog_tut_wieldables.jpg)](https://www.youtube.com/watch?v=9TK4Tw48nKQ)

## Thanks and Contributions
- AC-Arcana: added DynamicFootstepSystem
- pcbeard: Performance tweaks and bugfixes.
- FailSpy: improved input handling as well as UI and Player Controller quality-of-life fixes.
- kk1201: improving Lightzone component.

- Player controller is based on Like475's First Person Controller Advanced: https://github.com/Like475/fpc-godot
- Menus are based on SavoVuksan's EasyMenus (also see this link for documentation): https://github.com/SavoVuksan/EasyMenus
- Inventory system was helped by following DevLogLogan on Youtube: https://www.youtube.com/watch?v=V79YabQZC1s
- InputHelper by Nathan Hoad (also see this link for documentation): https://github.com/nathanhoad/godot_input_helper
- QuickAudio by Bryce Dixon (https://github.com/BtheDestroyer/Godot_QuickAudio)
- Stairs handling based on GodotStairs by elvisish (https://github.com/elvisish/GodotStairs)
- Cogito Quest System based on shomykohai's Godot 4 quest system.

## License and Credits
- This add-on is published under the MIT license.
- You can use this add-on in your projects, personal or commercial, as long as you credit us (mostly cause I'd love to see what people use it for!)
- About the game assets under the COGITO/assets folder:
- 3D models are by Kenney (https://www.kenney.nl/) or made by me.
- Audio is either by Kenney or from freesound.org used under CC0 or MIT license
- Water feature sound is by poyekhali from freesound.org used under CC3.0 license.
- Cloud HDR (kloofendal_48d_partly_cloudy_puresky)2k.hdr by Greg Zaal, used under CC0.
- All other included assets either made by me or one of the contributors, published under MIT.