Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ivopc committed Jan 13, 2024
1 parent e5e946c commit 289459a
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
@@ -1,8 +1,35 @@
# Phaser 3 Universal LPC Character

## (Under development)
Character Spritesheet based on Universal-LPC-Spritesheet for Phaser 3.

It is provided as `Phaser.GameObjects.Sprite`, `Phaser.Physics.Arcade.Sprite` and `Phaser.Physics.Matter.Sprite` GameObjects. Also the animators, input behaviors and the entire spritesheet character variations will be included as a TypeScript Interfaces and methods handling.

## How to use

``` bash
# install dependencies
npm i
or
yarn

# start
npm run dev
or
yarn dev

# build
npm run build
or
yarn build


# generate characters spritesheet json map
npm run generate-spritesheet-map
or
yarn generate-spritesheet-map
```

### Licensing and Attribution (Credits)

This is based in original [Universal LPC Spritesheet Character Generator](https://github.com/Gaurav0/Universal-LPC-Spritesheet-Character-Generator) and [sanderfrenken's LPC Spritesheet Character Generator](https://github.com/sanderfrenken/Universal-LPC-Spritesheet-Character-Generator) using the awesome [LPC](https://lpc.opengameart.org/) game art assets.
Expand Down

0 comments on commit 289459a

Please sign in to comment.