# empty-epsilon-js

> Empty Epsilon Javascript driver

Latest version **2.0.1** (published 2021-07-01) · AGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install empty-epsilon-js
pnpm add empty-epsilon-js
yarn add empty-epsilon-js
bun add empty-epsilon-js
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2021-07-01 |
| First published | 2017-12-30 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 82.2 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| Author | Amir Arad |
| Maintainers | amir-arad |
| Keywords | empty epsilon |

## Links

- npm: https://www.npmjs.com/package/empty-epsilon-js
- Repository: https://github.com/CommaSword/empty-epsilon-js
- Homepage: https://github.com/CommaSword/empty-epsilon-js#readme
- Issues: https://github.com/CommaSword/empty-epsilon-js/issues
- npm.io page: https://npm.io/package/empty-epsilon-js

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^0.21.1
- [tslib](https://npm.io/package/tslib.md) 2.3.0
- [string-template](https://npm.io/package/string-template.md) ^1.0.0

## Recent versions

- 2.0.1 (latest) — 2021-07-01
- 2.0.0 — 2019-09-18
- 1.1.0 — 2019-09-18
- 1.0.2 — 2018-01-30
- 1.0.1 — 2018-01-30
- 1.0.0 — 2017-12-30

## README

# Empty Epsilon javascript driver
Empty Epsilon API for javascript.

This library helps connecting to an empty epsilon game server with an open HTTP API. 

It offers a low level javascript API, as well as a tool to automatically start and stop an EmptyEpsilon server, designed for automatic tests.

## API
(TBD)

### context
This driver was extracted from  [Daedalus](https://github.com/CommaSword/Daedalus/). This had a major affect on early design choices, test coverage etc. 

## Developer documentation

Suggestions and contributions are welcomed!

### how to build
Follow the instructions in the [developer documentation](./resources/entries/daedalus-developer.md)

run `npm run build` to build this project.

### how to test

To test this project we use the provided server manager. In order to configure it to the local environment, there is a `empty-epsilon-config.json` file at the project root. 
Simply modify the `runServer`, `killServer`, and `serverAddress` fields according to your local setup, so that the tests can correctly manage a game server's lifecycle.
 
after configuring `empty-epsilon-config.json`, run `npm test` to build and test this project.

Tests are still WIP.

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