https://github.com/eve-ning/monkeydance

24h Unity Game Jam
https://github.com/eve-ning/monkeydance

Last synced: 13 days ago
JSON representation

24h Unity Game Jam

• Host: GitHub
• URL: https://github.com/eve-ning/monkeydance
• Owner: Eve-ning
• License: mpl-2.0
• Created: 2021-11-04T13:19:56.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2021-11-05T16:01:18.000Z (about 3 years ago)
• Last Synced: 2024-10-27T18:25:11.094Z (2 months ago)
• Language: C#
• Size: 3.2 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# [![monkeydance](Images/banner.png)](https://dev-evening.itch.io/monkeydance)

## [**Play Here on itch.io**](https://dev-evening.itch.io/monkeydance)

Created in a 24h for a school mini-project.

Play simply using arrow keys.

Inspired by **monkeytype**

## Screenshots

![Gameplay Image](Images/gameplay.png)

![Results Image](Images/result.png)

## Known Bugs

- Some arrows don't visually if the player presses too fast.

# Documentation

## Introduction

This is a simple one-scene single-player local game. 

Heavily inspired by [monkeytype](https://monkeytype.com/), using arrows instead of letters.

Done in Unity, exported to WebGL and uploaded to [itch.io](https://itch.io/).

## Methodology

The overview is simple, track inputs from `Input.__Arrow`, check them and run the appropriate functions.

There are a few notable features

- Animations

- Coroutines

- Prefab Generation & Layout

- Code Formatting

### Animations

The animations are simply animation clips triggered via script.

Take a look at the script that makes the current arrow state successful

```cs

private IEnumerator SetArrowGood()

{

    CurrentArrow().GetComponent().SetTrigger("Good");

    // ...

    yield break;

}

```

By setting the **bool trigger** of the `Animator`, we run the animation of the arrow.

One could run a separate coroutine that **LERPs** the animation, see `GameManager.DeleteFirstArrowRowAnim`

### Coroutines

The game runs heavily on Coroutines as animations run asynchronously for a smooth gameplay.

For example, the Key Per Second (KPS) Tracker

```cs

private IEnumerator AddKpsThread()

{

    Kps += 1;

    StartCoroutine(AddScore());

    yield return new WaitForSeconds(1);

    Kps -= 1;

}

```

Notice how the accumulation of `Coroutine` threads simulate a KPS system.

A bug is due to this though, I'll leave it as it's not vital.

### Prefab Generation & Layout

The prefab arrows generated are laid out in a wrap-around grid.

e.g.

```

Hierarchy

- Play Area (Grid Layout)

  - Arrow 1

  - Arrow 2

  - ...

  - Arrow 16

Wraps as 2x8

OOOOOOOO

OOOOOOOO

Wraps as 4x4

OOOO

OOOO

OOOO

OOOO

```

This saves a lot of finnicky layout issues

### Code Layout

I like coding, especially making it clean.

There are a few tricks you may observe from the code

- `partial` file splitting

- **Properties** `get` `set`. See `GameManager.Score.Score`

  - By setting the Score property, you also set the Score Text. This is an excellent code pattern.

- Automatic Old Arrow trimming. See `GameManager.CheckArrowRow`

- Manual Animation LERPing. See: `GameManager.DeleteFirstArrowRowAnim`

- Enum Classes. See: `Arrow.EDirection` / `GameManager.Timer.GameState`.