# horntracker-client

> Unofficial horntracker client using undocumented api

Latest version **0.1.5** (published 2017-11-11) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install horntracker-client
pnpm add horntracker-client
yarn add horntracker-client
bun add horntracker-client
```

Provides the command `ht-cli`.

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.5 |
| Published | 2017-11-11 |
| First published | 2017-11-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Geno Roupsky |
| Maintainers | groupsky |

## Links

- npm: https://www.npmjs.com/package/horntracker-client
- Repository: https://github.com/groupsky/horntracker-client
- Homepage: https://github.com/groupsky/horntracker-client#readme
- Issues: https://github.com/groupsky/horntracker-client/issues
- npm.io page: https://npm.io/package/horntracker-client

## Dependencies (6)

- [yargs](https://npm.io/package/yargs.md) ^10.0.3
- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [request](https://npm.io/package/request.md) ^2.83.0
- [bluebird](https://npm.io/package/bluebird.md) ^3.5.1
- [json2csv](https://npm.io/package/json2csv.md) ^3.11.5
- [request-promise](https://npm.io/package/request-promise.md) ^4.2.2

## Recent versions

- 0.1.5 (latest) — 2017-11-11
- 0.1.4 — 2017-11-10
- 0.1.3 — 2017-11-10
- 0.1.2 — 2017-11-10
- 0.1.1 — 2017-11-09
- 0.1.0 — 2017-11-09

## README

# horntracker-client
Unofficial horntracker client using undocumented api

## Cli Usage

The cli provides several commands to extract various data. Most of them require a [setup](#vars) similar to the web ui.

### Population

Population command retrieves the mice population for specific setup. 
Most common use is to request for specific location and cheese

```
ht-cli pop --vars.location.bazar --vars.cheese.gilded
```

### Loot

Query what loot drops have been found given some conditions

```
ht-cli loot --vars.location.laboratory --vars.cheese.brie
```

### Most

Query what is the most used trap/base/cheese/location for some set of filter.

```
ht-cli most trap --vars.location.labyrinth
```

This could be used to find the locations where a particular mouse was most seen 
(this doesn't mean it has the highest attraction at that location, just that is was hunted mostly there)

```
ht-cli most location --vars.mouse.sandmouse
```

### Top trap setups

Get the top trap setups observed.

```
ht-cli top --vars.location.mopi --vars.cheese.ggc
```

### Vars

Vars are the different filters to be applied when executing the command. Most common ones are:

Type | Info | Example
-----|------|--------
Location | Specify the location to limit results | `ht-cli --vars.location.bazaar`
Weapon | Limit to hunts using specific trap | `ht-cli '--vars.weapon.sandstorm Monstrobot'`
Base | Limit by base | `ht-cli --vars.base.minotaur`
Cheese | Limit by cheese. There is support for some common cheese aliases like `sb`, 'msc', etc. | `ht-cli --vars.cheese.sb`
Charm | Limit by charm | `ht-cli --vars.charm.candy`
Mouse | Limit by mouse | `ht-cli --vars.mouse.steel`

Every filter that is available in the web ui, could be specified the same way.

Negating filter (i.e. instead of including records which satisfy the filter, exclude those records) is easy by using `--no-vars` instead of `--var`.


### Output

By default the output is `pretty-json`, which can be changed using the `-o` options to be just `json` or `csv` 


## Integrating in your own tools

The whole functionality is available as a node module, so you can just `require('horntracker-client')` and execute the same queries. 
Result is always a promise resolved with json.

## License

MIT

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