katools

A set of tools to help you focus on what matters most by taking care of the repetitive work.

Guide

Follow the steps mentioned on this blog post to get started (might be a bit outdated, but still works the same).

Usage

npx katools COMMAND

or

$ npm install -g katools
$ katools COMMAND
running command...
$ katools (--version)
katools/1.3.0 linux-x64 node-v20.19.3
$ katools --help [COMMAND]
USAGE
  $ katools COMMAND
...

Commands

• katools component NAME
• katools entity NAME
• katools help [COMMAND]
• katools init
• katools plugin NAME
• katools prebuilt [TYPE] [NAME]
• katools scene NAME

katools component NAME

Adds a new component to the project

USAGE
  $ katools component NAME [-j] [-d <value>] [-s <value>]

ARGUMENTS
  NAME  name of component

FLAGS
  -d, --dir=<value>     [default: components] directory to create the component in
  -j, --javascript      uses JavaScript instead of TypeScript
  -s, --subDir=<value>  subdirectory to create the component in

DESCRIPTION
  Adds a new component to the project

EXAMPLES
  $ katools component movement

See code: src/commands/component.ts

katools entity NAME

Adds a new entity to project

USAGE
  $ katools entity NAME [-j] [-d <value>] [-s <value>]

ARGUMENTS
  NAME  name of entity

FLAGS
  -d, --dir=<value>     [default: entities] directory to create the entity in
  -j, --javascript      uses JavaScript instead of TypeScript
  -s, --subDir=<value>  subdirectory to create the entity in

DESCRIPTION
  Adds a new entity to project

EXAMPLES
  $ katools entity player

See code: src/commands/entity.ts

katools help [COMMAND]

Display help for katools.

USAGE
  $ katools help [COMMAND...] [-n]

ARGUMENTS
  COMMAND...  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for katools.

See code: @oclif/plugin-help

katools init

Initializes a new KAPLAY project.

USAGE
  $ katools init [-j] [-n <value>] [-s]

FLAGS
  -j, --javascript    uses JavaScript instead of TypeScript
  -n, --name=<value>  [default: katools] name of your game.
  -s, --skip          skip prompts and use default values.

DESCRIPTION
  Initializes a new KAPLAY project.

EXAMPLES
  $ katools init

See code: src/commands/init.ts

katools plugin NAME

adds a new plugin to the project

USAGE
  $ katools plugin NAME [-j]

ARGUMENTS
  NAME  name of plugin

FLAGS
  -j, --javascript  uses JavaScript instead of TypeScript

DESCRIPTION
  adds a new plugin to the project

EXAMPLES
  $ katools plugin score

See code: src/commands/plugin.ts

katools prebuilt [TYPE] [NAME]

Adds a prebuilt tool to the project.

USAGE
  $ katools prebuilt [TYPE] [NAME] [-j] [-l]

ARGUMENTS
  TYPE  (component|entity|plugin|scene) type of prebuilt tool.
  NAME  name of the prebuilt tool.

FLAGS
  -j, --javascript  uses JavaScript instead of TypeScript
  -l, --list        list all available prebuilt tools

DESCRIPTION
  Adds a prebuilt tool to the project.

EXAMPLES
  $ katools prebuilt topDownMovement

See code: src/commands/prebuilt.ts

katools scene NAME

adds a scene to the project

USAGE
  $ katools scene NAME [-j]

ARGUMENTS
  NAME  name of scene

FLAGS
  -j, --javascript  uses JavaScript instead of TypeScript

DESCRIPTION
  adds a scene to the project

EXAMPLES
  $ katools scene game

See code: src/commands/scene.ts