# nengi-geckos-client-adapter

> geckos.io client network adapter for nengi v2

Latest version **0.1.0** (published 2023-07-01) · ISC license · 0 weekly downloads

## Install

```sh
npm install nengi-geckos-client-adapter
pnpm add nengi-geckos-client-adapter
yarn add nengi-geckos-client-adapter
bun add nengi-geckos-client-adapter
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2023-07-01 |
| First published | 2023-07-01 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Stas Kardash |
| Maintainers | realpeha |
| Keywords | nengi, agapter, geckos, webrtc, udp |

## Links

- npm: https://www.npmjs.com/package/nengi-geckos-client-adapter
- Repository: https://github.com/RealPeha/nengi-geckos-client-adapter
- Homepage: https://github.com/RealPeha/nengi-geckos-client-adapter#readme
- Issues: https://github.com/RealPeha/nengi-geckos-client-adapter/issues
- npm.io page: https://npm.io/package/nengi-geckos-client-adapter

## Dependencies (1)

- [@geckos.io/client](https://npm.io/package/@geckos.io/client.md) ^2.3.1

## Recent versions

- 0.1.0 (latest) — 2023-07-01

## README

# [geckos.io](https://github.com/geckosio/geckos.io) client network adapter for nengi v2

> **Warning**
> This adapter is written and tested only on nengi v2.0.0-alpha.133, this is an unstable version, the api of which may change in the future

### Install

```bash
npm i nengi-geckos-client-adapter
```

### Usage

#### Client-side

```ts
import { Client, Context } from "nengi";
import { GeckosClientAdapter } from "nengi-geckos-client-adapter";

const serverTickRate = 20;
const ctx = new Context();
// <...>
const client = new Client(ctx, GeckosClientAdapter, serverTickRate);

await client.connect("http://localhost:9001");
```

Or if you want to pass additional options to the geckos.io client use an alternative connection method:

```ts
const geckosOptions = {};
await(client.adapter as GeckosClientAdapter).connect(
  "http://localhost:9001",
  {}, // handshake
  geckosOptions
);
```

All available client options is described here https://github.com/geckosio/geckos.io#client-1

#### Server-side

For server-side you need [nengi-geckos-server-adapter](https://github.com/RealPeha/nengi-geckos-server-adapter)

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