Code Monkey home page Code Monkey logo

enhancedstat's Introduction

โœจ Enhanced Stat for Godot 4.1

Godot Version License: MIT Static Badge


๐Ÿ” Table of Contents


๐Ÿ“– Overview

Enhanced Stat is an addon suite for Godot 4.1, designed to provide an intuitive and powerful way to manage stats in games such as Health, Mana, Speed, and Attack Damage. This addon is part of the Enhanced suite aimed to make your Godot development faster, cleaner, and more enjoyable!


๐Ÿ“ฆ Installation

  1. Clone or download the repository.
  2. Copy the enhanced_stat folder inside your project's addons directory.
  3. Enable the addon by going to Project -> Project Settings -> Plugins and activating the "Enhanced Stat" plugin.

๐Ÿš€ Features

๐Ÿ“ˆ Stats

  • Reactive Programming: Stats are reactive, and changes can be listened to in real-time.
  • Computed Stats: Type safe basic stats.
  • Aggregated Stats: Create new stats based on existing stats, automatically updating when dependencies change.
  • Bind Mechanism: Allows easy binding of stats to in game nodes.
  • Modifiers: Flexible modification of stats through addition, multiplication, or other custom methods.
  • Listeners: Events to notify game logic of stats changes.

โšก Status Effects

  • Component-based: Reusable components that can be combined to create complex status effects.
  • Modifiers: Attachable to stats to create temporary or permanent changes.
  • Vfx: Add vfxs or nodes while the status effect is active.

๐Ÿ’ป Editor Friendly

  • Editor Inspector: Use the editor to configure the stats and status effects for your game.

๐Ÿ”— Dependencies

  • Enhanced Common: This addon depends on the enhanced_common addon for various utilities and common functionalities. Make sure to also have this addon installed and enabled.

๐Ÿ“ Project Architecture

Here is an overview of the project's file hierarchy:

- enhanced_stat
    +---addons
        +---enhanced_common
        +---enhanced_stat
            +---icons
            +---scenes
                +---editor
                    +---stats
                        +---bind
                        +---listeners
                        +---modifier
            +---scripts
                +---editor
                    +---stats
                        +---bind
                        +---listeners
                        +---modifier
                +---core
                    +---stats
                        +---bind
                        +---listeners
                        +---modifier
                        +---stat
                    +---status_effects
                        +---components

๐Ÿ“— Usage

Check the documentation for tutorials, API references, and examples to get started. Usage is straightforward and can easily be integrated into your existing Godot project.


๐Ÿ“ Documentation

Further documentation is available in the docs directory. You can also check the inline comments for a more detailed understanding of specific methods and functionalities.


๐Ÿป Contributing

Contributions are very welcome! Feel free to open issues or submit pull requests.


๐Ÿ“„ License

This project is licensed under the terms of the MIT license. See LICENSE for details. This project uses icons from icons8. If you fancy those lovely icons, please check out their website.


Made with โค๏ธ for the Godot community. Happy coding! ๐Ÿ˜„

enhancedstat's People

Contributors

abab-bk avatar pieking1215 avatar zennyth avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.