# yuka

> JavaScript Game AI library

Latest version **0.7.8** (published 2022-09-17) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 43/100 (D)** — status: abandoned.

Positive: has types package; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.7.8 |
| Published | 2022-09-17 |
| First published | 2019-11-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/yuka) |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 1007 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1466 |
| Author | Mugen87 |
| Maintainers | mugen87 |
| Keywords | javascript, ai |

## Links

- npm: https://www.npmjs.com/package/yuka
- Repository: https://github.com/Mugen87/yuka
- Homepage: https://mugen87.github.io/yuka
- Issues: https://github.com/Mugen87/yuka/issues
- npm.io page: https://npm.io/package/yuka

## Alternatives

- [@expo/fingerprint](https://npm.io/package/@expo/fingerprint.md) — 6.2M weekly downloads
- [@azure/monitor-opentelemetry-exporter](https://npm.io/package/@azure/monitor-opentelemetry-exporter.md) — 850.0K weekly downloads
- [@azure/monitor-opentelemetry](https://npm.io/package/@azure/monitor-opentelemetry.md) — 624.0K weekly downloads
- [@posthog/ai](https://npm.io/package/@posthog/ai.md) — 423.3K weekly downloads
- [fakefilter](https://npm.io/package/fakefilter.md) — 63.9K weekly downloads

## Recent versions

- 0.7.8 (latest) — 2022-09-17
- 0.7.7 — 2022-01-02
- 0.7.6 — 2021-05-05
- 0.7.5 — 2021-05-04
- 0.7.4 — 2021-05-03
- 0.7.3 — 2021-02-17
- 0.7.2 — 2021-02-16
- 0.7.1 — 2021-01-21
- 0.7.0 — 2021-01-19
- 0.6.0 — 2021-01-03
- 0.5.0 — 2021-01-03
- 0.4.0 — 2021-01-03
- 0.3.10 — 2021-01-03
- 0.3.9 — 2020-12-26
- 0.3.8 — 2020-10-06
- … 13 more at https://npm.io/package/yuka/versions

## README

# Yuka &middot; [![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Mugen87/yuka/blob/master/LICENSE) [![NPM Package](https://img.shields.io/npm/v/yuka.svg)](https://www.npmjs.com/package/yuka) [![Coverage Status](https://coveralls.io/repos/github/Mugen87/yuka/badge.svg?branch=master)](https://coveralls.io/github/Mugen87/yuka?branch=master) [![Language grade: JavaScript](https://img.shields.io/lgtm/grade/javascript/g/Mugen87/yuka.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Mugen87/yuka/context:javascript)

Yuka is a JavaScript library for developing Game AI.

* **Autonomous Agent Design:** Yuka provides a basic game entity concept and classes for state-driven and goal-driven agent design.
* **Steering:** Use the build-in vehicle model and steering behaviors in order to develop moving game entities.
* **Navigation:** Graph classes, search algorithms and a navigation mesh implementation enables advanced path finding.
* **Perception:** Create game entities with a short-term memory and a vision component.
* **Trigger:** Use triggers to generate dynamic actions in your game.
* **Fuzzy Logic:** Make your game entities smarter with Yuka's fuzzy inference system.
* **JSON:** Save and load the current state of your game by using a serialization/deserialization API based on JSON.

Yuka is a standalone library and independent of a particular 3D engine.

## Documentation

You can find the Yuka documentation [on the website](https://mugen87.github.io/yuka/docs/).

## Examples

We have several examples [on the website](https://mugen87.github.io/yuka/examples/). If you download the repository and execute `npm install && npm start` in the main directory, you can start a local server and check out the examples on your computer.

## Chat

There is a [Discord server](https://discord.gg/MhnFwYM) if you want to chat about Yuka and game AI related topics.

## Resources

We recommend the following books in order to get familiar with most of Yuka's concepts:

[Programming Game AI by Example](https://www.amazon.com/Programming-Example-Wordware-Developers-Library/dp/1556220782) by Mat Buckland

[3D Math Primer for Graphics and Game Development](https://www.amazon.com/Math-Primer-Graphics-Game-Development/dp/1568817231/) by Fletcher Dunn and Ian Parberry

### License

Yuka is [MIT licensed](./LICENSE).

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