# poki

> Poki

Latest version **0.0.8** (published 2021-05-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install poki
pnpm add poki
yarn add poki
bun add poki
```

Provides the command `poki`.

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.8 |
| Published | 2021-05-04 |
| First published | 2021-04-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 14 |
| Unpacked size | 86.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Souvik De |
| Maintainers | souvik210899 |

## Links

- npm: https://www.npmjs.com/package/poki
- Homepage: https://github.com/Souvikns/Poki#readme
- npm.io page: https://npm.io/package/poki

## Dependencies (14)

- [ink](https://npm.io/package/ink.md) ^3.0.8
- [meow](https://npm.io/package/meow.md) ^9.0.0
- [react](https://npm.io/package/react.md) ^17.0.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [ink-link](https://npm.io/package/ink-link.md) ^2.0.0
- [tsyringe](https://npm.io/package/tsyringe.md) ^4.5.0
- [commander](https://npm.io/package/commander.md) ^7.2.0
- [@types/node](https://npm.io/package/@types/node.md) ^14.14.41
- [ink-big-text](https://npm.io/package/ink-big-text.md) ^1.2.0
- [ink-gradient](https://npm.io/package/ink-gradient.md) ^2.0.0
- [ink-text-input](https://npm.io/package/ink-text-input.md) ^4.0.1
- [ink-select-input](https://npm.io/package/ink-select-input.md) ^4.2.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [@types/ink-select-input](https://npm.io/package/@types/ink-select-input.md) ^3.0.0

## Recent versions

- 0.0.8 (latest) — 2021-05-04
- 0.0.7 — 2021-04-30
- 0.0.6 — 2021-04-30
- 0.0.5 — 2021-04-30
- 0.0.4 — 2021-04-30
- 0.0.3 — 2021-04-30
- 0.0.2 — 2021-04-30
- 0.0.1 — 2021-04-30

## README

<h1 align="center">
Poki
<br> <br>
<p align="center">
<img src="https://github.com/Souvikns/Poki/blob/main/static/pokeball.svg"  width="100">
</p>

<p align="center">
 <a href="https://github.com/Souvikns/Poki/blob/main/LICENSE"><img alt="GitHub license" src="https://img.shields.io/github/license/Souvikns/Poki"></a>

<a href="https://github.com/Souvikns/Poki/pulls">
<img src="https://img.shields.io/badge/PRs-open-green">
</a>
<a href="https://deepscan.io/dashboard#view=project&tid=8580&pid=16849&bid=368882"><img src="https://deepscan.io/api/teams/8580/projects/16849/branches/368882/badge/grade.svg" alt="DeepScan grade"></a>
<a href="https://github.com/Tech-Phantoms/pokemon-cli-game/actions/workflows/node.js.yml">
<img src="https://github.com/Tech-Phantoms/pokemon-cli-game/actions/workflows/node.js.yml/badge.svg" alt="Node.js CI">
</a>

<a href="https://codecov.io/gh/Souvikns/Poki">
        <img src="https://codecov.io/gh/Souvikns/Poki/branch/main/graph/badge.svg?token=FYklvhHRMn"/>
 </a>

<img alt="npm" src="https://img.shields.io/npm/dw/poki">

</p>
</h1>

> Work in progress

## Poki

Poki is a command-line pokemon game, heavily influenced by pokemon red. We will
also seperate the game logic so that it could be used as a library.

## Table of Contents

- [Getting Started](#getting-started)
  - [Installation](#installation)
- [Usage](#usage)
  - [using poki cli](#using-poki-cli)
  - [using poki as library](#using-poki-as-a-library)
- [Game Commands](#game-commands)
  - [`pokedex`](#pokedex)
  - [`catch`](#catch)
  - [`battle`](#battle)
  - [`profile`](#profile)
- [Api Reference](#api-reference)

## Getting Started

To run Poki, ensure that you have Node.js >=10.
[Install node.js from here.](https://nodejs.org/en/)

### Installation

The easiest way to install Poki is using NPM. If you have Node.js installed, it
is most likely that you have NPM installed as well

```
$ npm install -g poki
```

This installs Poki globally on your system allowing you to run it from anywhere.
If you want to install it locally, Just remove the -g flag.

[back to top](#table-of-contents)

## Usage

### Using Poki CLI

You can play the game using the CLI. If you have installed poki globally open
any terminal of your liking and check the command list

```
$ poki --help
```

<img src="https://github.com/Souvikns/Poki/blob/main/static/ss.PNG" width="650" />

### Using Poki as a Library

> curretly you cant use poki as a library.

[back to top](#table-of-contents)

## Game Commands

### `pokedex`

Use this command to get information about pokemons currently in the game. This
command prints 10 pokemons at a time, you can use `arrow keys` to navigate and
`enter` to select.

To access the search bar press `s` then start typing the pokemon name you want
search

<img src="https://github.com/Souvikns/Poki/blob/main/static/searchbar.PNG" width="300" />

#### options

- `-p, --pokemon <name>` pass in the pokemon name to search
- `-h, --help` display help for command

[back to top](#table-of-contents)

### `catch`

> under development

[back to top](#table-of-contents)

### `battle`

> under development [back to top](#table-of-contents)

### `profile`

> under development

[back to top](#table-of-contents)

## Api Reference

> under development

[back to top](#table-of-contents)

---
_Source: https://npm.io/package/poki · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._