Skip to content

Latest commit

 

History

History
195 lines (99 loc) · 8.43 KB

README.md

File metadata and controls

195 lines (99 loc) · 8.43 KB

Repeet

A game experiment with React Native

Introduction

This project is an attempt to create a simple but thorough gaming experience.

Memory games can be really simple, from the player's perspective, but I've found it to be somewhat challenging after the first steps.

I hope you'll enjoy playing around with it, maybe one day downloading the app (soon). And if you want to know more about this project and other work I've done, check out my page at ericmarques.dev.

The Idea

The idea is simple: I created one of those memory games where the computer tells you a sequence, and you have to repeat it in order to move to the next level. As you need to repeat it, hence the name: Repeet.

The Tech

I'm basically using React Native with Expo, Typescript, Redux, Styled Components.

The Game

Here's the basic game timeline:

  • The player starts the game
  • The computer randomize a sequence of keys, twinkling them so the player can see it
  • The player now must hit the same sequence on the key pad, at the bottom
  • At each step, if the player gets the right key, the game expects the next one, so on and so forth
  • If the player hits the wrong key or takes too long and the time expires, the round will restart
  • The player may have 2 attempts (hard mode), 3 attempts (medium mode), or 5 attempts (easy mode)
  • By missing multiple times, if the player runs out of attempts, it's game over
  • As the player progresses, he/she will increase the score at each round
  • As the score gets higher, so does the speed, which will accelerate the whole game

At this moment, the game has two main views: the game itself (described above) and the configuration panel. On the configuration panel, the player may set three different configurations:

  • Sound: on, off
  • Difficulty: easy, medium, hard
  • Mode: default, advanced
  • Shuffle: on, off
  • Blindfolded: on, off

Each of those configuration will determine how the game will roll.

Sound

On

The whole app will play sounds as the user interacts with it by playing or clicking on the buttons.

Off

No sound will be played at all. This will also disable the blindfolded mode, as it would make no sense.

Difficulty

Easy

The game will start very slow, and the user will start with 5 attempts in total.

Medium

The game will start with regular speed, and the user will start with 3 attempts in total.

Hard

The game will start in a slightly higher speed, and the user will start with only 2 attempts in total.

Mode

Default

It's the default 4 keys board, and the computer will randomize a 4 keys sequence.

Advanced

It has 6 keys instead of 4, and the randomized sequence will contain 6 keys.

Shuffle

On

If the player wants to make the game even harder, it's possible to turn the shuffle mode on. With that, at each round, the computer keys order will be randomized to something different than the bottom key pad (the player's one). Therefore, the player will have to memorize the actual colors, and not their position.

Note: If the player turns this configuration on, it will automatically turn the blindfolded mode off, if it was previously on, as it would make no sense.

Off

When the shuffle mode is off, the top keys (the computer ones) will always remain in the same position.

Blindfolded

On

For those that really want to challenge themselves, how about playing without seeing the keys to tap? In this mode, players must play based on what they hear, as the computer key pad will be hidden, and the keys will have different sounds (musical notes). Any musicians out there?

Note: If the player turns this configuration on, it will automatically turn the shuffle mode off, if it was previously on, as it would make no sense.

Off

When the blindfolded mode is off, the top keys (the computer ones) will always remain visible, and the sounds will be all the same.

Sounds

There's also a configuration to enable/disable sounds, which won't affect the game flow, but it will play sounds accordingly. Thanks Zapsplat.com for the amazing sounds. The only sounds I made myself are the notes on the blindfolded mode.

Combining different configurations

The cool thing about all these different game mode is that you may combine them as you wish, giving the game a whole different difficulty. Default mode on easy? Piece of cake! How about shuffling it? Hum, a bit harder. What if you change it to medium or hard instead of easy? It's getting interesting, right? Could you make it even harder by change it to the advanced mode, with 6 keys? Yes sir! And last, but not least (and definitely my favorite), how about going blindfolded? Oh, this is madness!

Features

Countdown

There is a countdown indicator informing the player how many "time units" remain. This was an important decision as working with actual time (3 seconds, 2 seconds, etc) could get misleading as the game speed increases, as the user progresses.

Like many other points of the game, it also responds to what the player has set on the configuration panel. If it's the default mode, there will be 4 time units. If it's the advanced mode, there will be 6. To summarize, they are directly connected to the number of keys beind displayed.

Attempts Left

This indicator will tell the player how many attempts left are still available, and show when they're being lost (when the user loses a round).

Progress Bard

In order to give the player a progress feedback, as the right keys are being tapped, the progress bar shows how the player's got right, at a given moment.

Intro

Instead of going straight to the game after the user taps the initial button to start the game, a middle screen is shown, the Intro, so the player can get ready to start. It will countdown from 3 to 0, then the game will start.

Training

Only when on blindfolded mode, there will always be a intermediate training screen before starting the game. The idea is to give the player the opportunity to get to know the key sounds, before actually plaing.

Modals

The user may exit the game in two situations: by clicking on the back button at the top left and choosing the "yes" option on the Exit Modal, or by declining to play another match on the Game Over modal. If the player selects not to exit, or play again, the game will be displayed again.

Multi Language

The game supports English and Portuguese at the moment. It uses the device's language, therefore there's no configuration in-app to change it. To implement that I used i18next and react-i18next

Other Tech Features

PubSub

The main logic of how things should respond to events is controlled by the Conductor object, which is a singleton of the EventManager class. It uses an internal PubSub structure I created. Every component that needs to respond to an event will register itself with the Conductor.on() method. The Conductor will emit events according to the logical sequence as the game goes, and those components will react to those events. When a component is unmounted, it unregisters itself from the Conductor.

React Hooks

At the component/React level, the main logic is orchestrated by the useGame hook, along with other hooks that manage the Redux Store and Components states.

Redux / redux-persist

The main state of the game is kept inside the Redux Store, and each domain has its own. Some of them will be persisted, even when the game is closed (such as the configuration ones). This way, when the player comes back, the previous configuration will still be there, persisted.

In order to manipulate the state, I'm dispatching action, with action creators, and selecting the state pieces with reselect's createSelector.

Sounds

I'm currently using Expo-AV to control the sounds.

Styled Components

Styled Components are being used in order to keep the code clean, reusable, neat.

Typescript

It would be way harder to get this working without type checking. Thanks, TS!

Test

I'm using Jest for my unit tests. Pretty straightforward.

Linting

Basically I'm relying on airbnb, prettier and typescript to get my code linted.