Skip to content

Commit

Permalink
chore: update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
h2v9696 authored Sep 6, 2024
1 parent f491a91 commit b6f7b69
Showing 1 changed file with 8 additions and 12 deletions.
20 changes: 8 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

## Introduction
GAS is short for Gameplay Ability System, the ability system architecture from Unreal ([For more information](https://github.com/tranek/GASDocumentation)).\
And this is an implementation of GAS in Unity.\
In short, GAS can help you create a complicated attribute, ability, effect system for your game with ease.\
This is an implementation of GAS in Unity.\
In short, GAS can help you create a complicated attribute, ability, and effect system for your game with ease.\
It has been used in some projects and fully tested with Unity Test Framework but I'm still improving it so feel free to use and contribute.

## Next step
Expand All @@ -22,21 +22,17 @@ It has been used in some projects and fully tested with Unity Test Framework but

## Installation
This package require my [Unity Extension Core](https://github.com/h2v9696/UnityExtensionsCore) so install it via Unity Package Manager.\
Also its depend on this Utility package so make sure to install it.\
Also, it depends on this Utility package so make sure to install it.\
[Unity SerializeReferenceExtensions](https://github.com/mackysoft/Unity-SerializeReferenceExtensions?tab=readme-ov-file#-installation)

After that, add git address in Unity Package Manager: https://github.com/h2v9696/UnityGAS.git\
After that, add the git address in Unity Package Manager: https://github.com/h2v9696/UnityGAS.git \
Or you can use git to clone this repository, then copy the whole folder to your project.

## Usage
This package is basically same as GAS in Unreal Engine,\
so to understand this better you should take a look at [Unreal Engine's Document](https://github.com/tranek/GASDocumentation).\
These explanations assume you have a basic understanding of GAS and Unity's Scriptable Object (SO) structure.\
This package is the same as GAS in Unreal Engine, so to understand this better you should take a look at [Unreal Engine's Document](https://github.com/tranek/GASDocumentation).\
These explanations assume you understand GAS and Unity's Scriptable Object (SO) structure.\
But feel free to check out my guide first—I'll try to include as many reference links as possible.

### UML
This is overview of this packages, presented using flowcharts and simple UML diagrams.
--To be added--

## Components
--To be added--
This is an overview of this package.
![image](https://github.com/user-attachments/assets/a41006e0-da3f-42d8-b0e9-b209610be342)

0 comments on commit b6f7b69

Please sign in to comment.