-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #104 from deadlykam/features-readme
Features readme
- Loading branch information
Showing
2 changed files
with
108 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2020 Syed Shaiyan Kamran Waliullah | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,87 @@ | ||
| Unity Version - 2019.3.15f1 | ||
| <p align="center"><img src="https://imgur.com/f26jBTU.png"></p> | ||
|
|
||
| # JumpRace3D | ||
|
|
||
| ### Introduction of the game: | ||
| This is a mobile game where the player races with other AI by jump on floating stages. | ||
|
|
||
| ## Gameplay: | ||
| The main objective is to get to the final floating stage which is green in colour and looks different from other stages. On the way there will be other AI racers that will try to reach the final stage before the player. The AI racers can be killed by colliding with them or by breaking some stages. The player dies when falling into the water or colliding with the big floating windmill fan obstacle. There is a booster pick up which helps the player to travel further. Once the player reachs the final stage a new random stage will be generated. | ||
|
|
||
| ## Table of Contents: | ||
| - [Prerequisites](#prerequisites) | ||
| - [Controls](#controls) | ||
| - [Stage](#stage) | ||
| - [UML](#uml) | ||
| - [Character UML](#1-character-uml-this-structure-shows-how-the-game-characters-functionalities-are-handled) | ||
| - [Platform UML](#2-platform-uml-this-structure-shows-how-the-games-platform-system-funtions) | ||
| - [Menu UML](#3-menu-uml-this-structure-shows-how-the-games-menu-system-functions) | ||
| - [UI UML](#4-ui-element-uml-this-structure-shows-how-the-games-ui-element-system-functions) | ||
| - [Versioning](#versioning) | ||
| - [Authors](#authors) | ||
| - [License](#license) | ||
|
|
||
| ## Prerequisites | ||
| #### Unity Game Engine | ||
| Unity version of the build is **2019.3.15f1**. Install Unity game engine from version **2019.3.15f1** or above. Install [Unity Hub (recommended)](https://store.unity.com/download?ref=personal) and add Unity version **2019.3.15f1**. Once installed then open the latest stable build. | ||
| *** | ||
| ## Controls | ||
| 1. Unity Editor: Press and hold the left mouse button to move the player forward. Press and hold the left mouse button and move the mouse in x-axis to rotate the player. | ||
|
|
||
| 2. Android: Press and hold the screen to move the player forward. Swipe left or right to rotate the player left or right respectively. | ||
| *** | ||
| ## Stage | ||
| The **[StageGenerator](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Obstacles/StageGenerator.cs)** is responsible for generating a stage. Every stage is randomly generated so no two stages are alike. Everytime before a stage starts it generates a new random stage. Below are previews showing how the stages are being generated. | ||
|
|
||
|  | ||
|
|
||
|  | ||
| *** | ||
| ## UML | ||
| Sharing some UML diagram to show the hierarchy of some classes and system and a brief description. | ||
|
|
||
| ##### 1. Character UML: This structure shows how the game character's functionalities are handled. | ||
| <img src="https://imgur.com/4byzjvQ.png" alt="Character UML"> | ||
|
|
||
| - **[BasicCharacter](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Characters/BasicCharacter.cs):** Handles the movement, rotation, jumping, falling and auto rotation functions of a character. | ||
| - **[BasicAnimation](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Characters/BasicAnimation.cs):** Handles all the animation functions of a character. Also enables/disables the ragdool. | ||
| - **[Player](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Characters/Player/Player.cs):** Makes the player character move forward or rotate by taking input from the user. | ||
| - **[Enemy](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Characters/NPC/Enemy.cs):** Makes the enemy character move towards the next stage and also rotates the enemy to face the next stage. Colliding with the player kills the enemy character. | ||
|
|
||
| ##### 2. Platform UML: This structure shows how the game's platform system funtions. | ||
| <img src="https://imgur.com/kkjLamS.png" alt="Platform UML"> | ||
|
|
||
| - **[BasicStage](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Obstacles/BasicStage.cs):** This class sets the type of particle effect to show for the platform when the methods **void StageAction()** or **void StageAction(bool)** are called. | ||
| - **[BouncyStageLong](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Obstacles/BouncyStageLong.cs):** This class starts the hide countdown process of the platform. Once the countdown process is done the platform is hidden and disabled from the game world. The method **void StageAction()** starts the countdown process and calls the parent's virtual method as well. | ||
| - **[BouncyStage](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Obstacles/BouncyStage.cs):** This class handles the animation of the platform. It also shows/hides the booster pickup of a platform and stores the 3D text when the platform is activated. The method **void StageAction()** plays the animation of the platform if the property **bool \_hasAnimation** is true and calls the parent's virtual method as well. | ||
| - **[BouncyStageMove](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Obstacles/BouncyStageMove.cs):** This class moves the platform sideways within a limit. The method **void StageAction()** calls the parent's virtual method. | ||
| - **[BouncyStageBreakable](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/Obstacles/BouncyStageBreakable.cs):** This class starts the breaking up process of a platform. The method **void StageAction()** instantly starts the breaking process of the platform and calls the parent's virtual method. The method **void StageAction(bool)** checks if the platform's break up process should be activated or not depending on the **bool** value and also calls the parent's virtual method. | ||
|
|
||
| ##### 3. Menu UML: This structure shows how the game's menu system functions. | ||
| <img src="https://imgur.com/8adDLE5.png" alt="Platform UML"> | ||
|
|
||
| - **[BasicUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/BasicUI.cs):** This class shows the menu by calling the method **void ShowUI()** and hides the menu by calling the method **void HideUI()**. It shows/hides menus by activating/deactivating the Canvases stored in the field **Canvas[] \_canvases**. | ||
| - **[EndScreenUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/EndScreenUI.cs):** This class shows the end menu which is the final result of the race. The menu is shown by calling the parent's virtual method **void ShowUI()** and hidden by calling the method **void HideUI()** which resets the end menu and calls parent's virtual method. | ||
| - **[MoveUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/MoveUI.cs):** This class slides in/out a menu. The menu is slid in when the method **void ShowUI()** is called, this also calls the parent's virtual method. The menu is hidden when the method **void HideUI()** is called but the parent's virtual method is not called from here. This is done so that once the slide out effect is done only then will the menu be hidden. | ||
| - **[PlayerUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/PlayerUI.cs):** This class shows the current race position of the player and other racers. It also shows how far the player is in the race. The parent's virtual method **void ShowUI()** shows the player menu and the parent's virtual method **void HideUI()** hides the player menu. | ||
|
|
||
| ##### 4. UI Element UML: This structure shows how the game's UI element system functions. | ||
| <img src="https://imgur.com/3ZUewpW.png" alt="Platform UML"> | ||
|
|
||
| - **[BasicUIEffect](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/BasicUIEffect.cs):** This class calculates and stores the accurate value of Time.deltaTime. The value is stored in the field **float \_fps** and accessed by the property **float fps**. This value is used by the child classes to get accurate calculations. | ||
| - **[ToggleUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/ToggleUI.cs):** This class shows and hides an UI element in a given time interval. The class uses parent's **float fps** value to calculate the time change. | ||
| - **[BasicUISpeedEffect](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/BasicUISpeedEffect.cs):** This class calculates and stores the step value which is needed by the child classes for lerpnig. The step value is stored in the field **float \_step** and accessed by the property **float step**. The accurate calculation of the step value is done by using the parent's field **float fps** value. | ||
| - **[TextSizeUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/TextSizeUI.cs):** This class continuously changes the size of a text UI element. The class uses the parent's **float step** property to lerp between the minimum(**float \_sizeMin**) and maximum(**float \_sizeMax**) size of the text. | ||
| - **[PopupUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/PopupUI.cs):** This class gives a popup effect to an UI element. The class uses the parent's **float step** property to change the size of the element once by lerping which is from minimum to maximum to minimum and then hide. | ||
| - **[SideMoveUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/SideMoveUI.cs):** This class moves an UI element from side to side. The class uses the parent's **float step** property to lerp the UI from the left target(**Transform \_leftTarget**) to the right target(**Trnasform \_rightTarget**). This gives a nice smooth effect of the movement. | ||
| - **[LoadUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/LoadUI.cs):** This class moves the UI element towards its final destination which means it is moved only in one direction. The class uses the parent's **float step** property to lerp the UI from target1(parent's **Transform leftTarget**) to target2(parent's **Transform rightTarget**). | ||
| - **[SizeUI](https://github.com/deadlykam/JumpRace3D/blob/features-readme/Assets/JumpRace3D/Scripts/UIs/SizeUI.cs):** This class changes the size of an UI element continuously. The class uses the parent's **float step** property to lerp between the minimum size(**float \_minSize**) and the maximum size(**float \_maxSize**). | ||
| *** | ||
| ## Versioning | ||
| The project uses [Semantic Versioning](https://semver.org/). Available versions can be seen in [tags on this repository](https://github.com/deadlykam/LastTry/releases). | ||
| *** | ||
| ## Authors | ||
| - Syed Shaiyan Kamran Waliullah \- [DeadlyKam](https://github.com/deadlykam) | ||
| *** | ||
| ## License | ||
| This project is licensed under the MIT License - see the [LICENSE.md](LICENSE) file for details. |