# node-tk5

> Node.js GSTK5 API

Latest version **0.1.10** (published 2016-04-08) · 0 weekly downloads

## Install

```sh
npm install node-tk5
pnpm add node-tk5
yarn add node-tk5
bun add node-tk5
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; low quality score; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.10 |
| Published | 2016-04-08 |
| First published | 2016-02-04 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 1 |
| Maintainers | nodetk5 |

## Links

- npm: https://www.npmjs.com/package/node-tk5
- Repository: https://github.com/nodetk5/node-tk5
- Homepage: https://github.com/nodetk5/node-tk5#readme
- Issues: https://github.com/nodetk5/node-tk5/issues
- npm.io page: https://npm.io/package/node-tk5

## Dependencies (2)

- [nan](https://npm.io/package/nan.md) ^2.1.0
- [prebuild](https://npm.io/package/prebuild.md) ^2.7.1

## Recent versions

- 0.1.10 (latest) — 2016-04-08
- 0.1.9 — 2016-03-24
- 0.1.8 — 2016-03-21
- 0.1.7 — 2016-02-19
- 0.1.6 — 2016-02-04

## README

#node-tk5
Node API wrapping tk5

###Install
npm install node-tk5

--

To build this library, following components are needed:

* Visual Studio 2015 with c++ installed

* Python 2.7

* Python environment variable PYTHON={python-dir including exe}


Install (npm):
`npm install "git+https://bitbucket.org/chyronhego_se/node-tk5.git" --msvs_version=2015`

###Example code

```
#!javascript

var TitleManager = require('node-tk5').TitleManager;

var tm = new TitleManager();
var client = tm.getClient();

client.setServerAddress('127.0.0.1');
client.connect();
tm.setProject('myProject');

var cl = tm.createCommandList();
cl.loadScene('myScene.gse', 'myScene');
cl.set('node', 'Attribute', 'MyData');
var title = tm.createTitle('')
title.execute(cl);

```


Almost all of the api is the same as TK5, only difference is how events are signaled. The TitleManager object emits all possible events.

```
#!javascript

tm.on('disconnect', function() {});
tm.on('command', function(cmd) {});
tm.on('message', function(msg) {});
tm.on('pickResult', function(pickXml) {});
tm.on('zoneStateChanged', function(zoneName, state) {});
```

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