diff --git a/Docs/CharacterStateMachine.pdf b/Docs/CharacterStateMachine.pdf index 4abf895..1e2f04b 100644 Binary files a/Docs/CharacterStateMachine.pdf and b/Docs/CharacterStateMachine.pdf differ diff --git a/README.md b/README.md index 67085bf..165522c 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,30 @@ -# SampleProject (FightingGame) -It is a sample project to show my coding approaches and knowledge, also some architectures (and patterns) which I've used. +# Sample Project (Fighting Game) +It is a sample project to show a part of my coding approaches and knowledge, also some architectures (and patterns) which I've been using here. You can check the project docs [here](https://github.com/ATHellboy/SampleProject-FightingGame/tree/master/Docs). -I didn't make custom character controller for characters and I used Unity Physics and Rigidbody because of time. +I didn't make custom character controller for characters and I used Unity Physics and Rigidbody because of time but it supports slopes. -There are some things which are good to check them out besides my coding knowledge. They are: +There are some stuff that are good to be checked besides my coding knowledge. They are: -* Combat system which you can check out its brief doc [here](https://github.com/ATHellboy/SampleProject-FightingGame/blob/master/Docs/CombatSystem.pdf). +* Combat system with doc [here](https://github.com/ATHellboy/SampleProject-FightingGame/blob/master/Docs/CombatSystem.pdf). -* Message Bus system (WIP). There is no doc for it yet but I used it in the project massively and there is an UnitTest for it (More update in future). This message bus system is built upon [UniRx](https://github.com/neuecc/UniRx). +* Object Pooling system with doc [here](https://github.com/ATHellboy/SampleProject-FightingGame/blob/master/Docs/ObjectPoolingSystem.pdf). -* Object Pooling system. It is good to check out its brief doc [here](https://github.com/ATHellboy/SampleProject-FightingGame/blob/master/Docs/ObjectPoolingSystem.pdf). - -* ScriptableObjectDropdown attribute. There is a separate repository for it which you can check it out [here](https://github.com/ATHellboy/ScriptableObjectDropdown). Also ScriptableObjectMultiSelectDropdown attribute which I didn't use it in the project but you can check it out [here](https://github.com/ATHellboy/ScriptableObjectMultiSelectDropdown). +* ScriptableObjectDropdown attribute. it has a separate repository that you can check it out [here](https://github.com/ATHellboy/ScriptableObjectDropdown). Also ScriptableObjectMultiSelectDropdown attribute which I didn't use in this project is [here](https://github.com/ATHellboy/ScriptableObjectMultiSelectDropdown). * It is not a big deal but don't forget to check my State Machine too. Its brief doc is [here](https://github.com/ATHellboy/SampleProject-FightingGame/blob/master/Docs/StateMachine.pdf). -I love IOC and DI so I used [Extenject](https://github.com/svermeulen/Extenject) (Zenject) by the great man, [Steve](https://github.com/svermeulen) in this project. +I used [VContainer](https://github.com/hadashiA/VContainer) for DI and [MessagePipe](https://github.com/Cysharp/MessagePipe) for the event system (Besides Unity built-in events). On previous implementation, I used [Extenject](https://github.com/Mathijs-Bakker/Extenject). + +# Controls +Player One | Movement : WASD | Jump : Space | Attack : B | Powerup : N | Switch Character : M + +Player Two | Movement: Arrow Keys | Jump : 0 | Attack : 1 | Powerup : 2 | Switch Character : 3 + +Bunny Complex Attack : Attack Button (In Air) + +Kitty Complex Attack: Attack Button (After Double Jump) # MIT License