2048-ts-engine/README.md

`2048-ts-engine` handles logic for 2048 game. Despite being written in Typescript, you can also use plain JS, if TS is not needed.

# Getting Started 🚀
`2048-ts-engine` handles logic for 2048 game. Despite being written in Typescript, you can also use plain JS, if TS is not needed.

## Installation
```
yarn add 2048-ts-engine
```

## How to use 
- The lib returns two main functions
  - `startGame` - simply starting the game
  - `move` 
    - evaluating move, calculating points, board coordination etc,
    - accepts these parameters 
  ```ts
  direction: Direction
  game: Game
  ```

Both these functions return all game related data (board coordinates, score, status etc.) which look like this:
```
{
  "score": 16,
  "board": [
    [ 0, 0, 4, 0 ],
    [ 0, 0, 0, 0 ],
    [ 2, 0, 0, 0 ],
    [ 4, 8, 0, 8 ]
  ],
  "gameStatus": "STARTED"
}
```

You will need to store the current state somewhere, since the engine only processes the game, and after every move, the current state of game is returned.


```js
import { startGame, move } from '2048-ts-engine';
import { Direction, Game, GameStatus } from '2048-ts-engine/src/types';

const newGame = startGame();
const gameProcessed = move(Direction.UP, newGame);
```

## Useful scripts

```bash
  # test game logic
  yarn test
```