poki v0.0.8

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
  • Installation
• Usage
  • using poki cli
  • using poki as library
• Game Commands
  • pokedex
  • catch
  • battle
  • profile
• Api Reference

Getting Started

To run Poki, ensure that you have Node.js >=10. Install node.js from here.

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

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

Using Poki as a Library

curretly you cant use poki as a library.

back to top

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

options

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

back to top

catch

under development

back to top

battle

under development back to top

profile

under development

back to top

Api Reference

under development

back to top