# ninjia

**Repository Path**: Zeiion/ninjia

## Basic Information

- **Project Name**: ninjia
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: CC-BY-4.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-05
- **Last Updated**: 2023-12-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
<img src="./public/logo.svg#gh-light-mode-only" width="250" />
<img src="./public/logo_white.svg#gh-dark-mode-only" width="250" />
</p>

<h1 align="center">Ninjia</h1>

<p align="center">
  <img alt="ThreeJS version" src="https://img.shields.io/badge/threejs-v153-d5a814" />
  <img alt="Vue version" src="https://img.shields.io/badge/vue-v3.2-24e064" />
  <img alt="GitHub" src="https://gitee.com/Zeiion/Ninjia" />
</p>

<p align="center">
    <a>
        <b>Try it out!</b>
    </a>
</p>

## An endless slashing rush

<p>Ninjia is an endless game made with <a href="https://github.com/mrdoob/three.js" target="_blank">three.js</a> and <a href="https://github.com/vuejs/core" target="_blank">Vue</a></p>

<img alt="Ninjia gameplay" src="./public/readme_loop.webp"/>

## How to play

- Slash obstacles with your sword using hand gestures
- Some obstacles can only be slashed from one direction
- Game ends when your health drops to zero
- Play and get coins to unlock new skins & trails & skills

## Installation

1. Clone repository to your local machine
2. Open terminal and `cd` into repository folder
3. Run `npm install`
4. Run `vite` or `npm run dev`

## Used technologies

- <a href="https://github.com/mrdoob/three.js" target="_blank">three.js</a> - 3D library
- <a href="https://github.com/vuejs/core" target="_blank">Vue</a> - Frontend framework
- <a href="https://github.com/vitejs/vite" target="_blank">Vite</a> - Build tool
- <a href="https://github.com/vuetifyjs/vuetify" target="_blank">Vuetify</a> - UI library
- <a href="https://github.com/pmndrs/cannon-es" target="_blank">cannon-es</a> - 3D physics engine
- <a href="https://github.com/samalexander/three-csg-ts" target="_blank">three-csg-ts</a> - ThreeJS CSG library
- <a href="https://github.com/creativelifeform/three-nebula" target="_blank">three-nebula</a> - ThreeJS particle system
- <a href="https://github.com/mkkellogg/TrailRendererJS" target="_blank">TrailRendererJS</a> - object trail effect (rewritten to TypeScript)

## TODO

- [ ] Optimize game logic
- [ ] Add gesture recognition
- [ ] Add shopping system
- [ ] Add ranking system
- [ ] Add sound effects & background music
- [ ] Add tutorial
- [ ] Add more skills & mechanisms