# scoring-gateway-cli

> Le Scoring Gateway CLI est un projet permettant de lancer n'importe quelle application du projet scoring gateway. Depuis ce projet vous pouvez lancer facilement le sender, le receiver ou le streamdeck avec les paramètres de lancement qui vous conviennent.

Latest version **0.3.0** (published 2020-11-25) · ISC license · 0 weekly downloads

## Install

```sh
npm install scoring-gateway-cli
pnpm add scoring-gateway-cli
yarn add scoring-gateway-cli
bun add scoring-gateway-cli
```

Provides the command `scoring-gateway-cli`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2020-11-25 |
| First published | 2020-11-25 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Clément TOLOIS |
| Maintainers | clement.t |

## Links

- npm: https://www.npmjs.com/package/scoring-gateway-cli
- npm.io page: https://npm.io/package/scoring-gateway-cli

## Dependencies (4)

- [yargs](https://npm.io/package/yargs.md) ^16.1.0
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [single-line-log](https://npm.io/package/single-line-log.md) ^1.1.2
- [@emg-digital/scoring-gateway](https://npm.io/package/@emg-digital/scoring-gateway.md) ^1.4.0

## Recent versions

- 0.3.0 (latest) — 2020-11-25

## README

# SCORING GATEWAY CLI

Le Scoring Gateway CLI est un projet permettant de lancer n'importe quelle application du projet scoring gateway. Depuis ce projet vous pouvez lancer facilement le sender, le receiver ou le streamdeck avec les paramètres de lancement qui vous conviennent.

- [Architecture du projet](#Architecture-du-projet-build)
- [Arguments de lancement](#Arguments-de-lancement)
    - [Sender](#Sender)
    - [Receiver](#Receiver)
    - [Streamdeck](#Streamdeck)

## Architecture du projet build

Pour fonctionner correctement l'excutable doit être placé relativement avec les dépendances suivantes. De plus l'executable doit être lancé avec des arguments, nous conseillons d'utiliser un ficher .bat pour lancer le scoring-gateway-cli avec les paramètres que vous souhaitez.

```
•
├── scoring-gateway-cli.exe
├── common // ref to streamdeck images
│   └── assets
│       └── img
├── node_modules // ref to non-builded modules
│   ├── @serialport
│   ├── elgato-stream-deck
│   ├── node-hid
│   └── sharp
├── config1.bat // optional bat file1
└── config2.bat // optional bat file2
```

## Arguments de lancement

Chaque application du projet scoring-gateway-cli est executable seule ou en parallèle d'une ou des autres applications du projet. Il suffit de renseigner les bons arguments. Les listes ci-dessous décrivents tous les arguments utilisables avec un exemple.

Les arguments peuvent être utilisés dans un fichier .bat. Par exemple comme ceci.

```
.\scoring-gateway-cli.exe --receiver=1 --receiverPort=9999
```

### Sender

|Argument|Description|Valeurs|Exemple|
|---|---|---|---|
|sender|démarrer le sender|0 / 1|--sender=1|
|senderMethod|type de communication|COM / HID / Socket / UDP / TCP / developerProviders | --senderMethod=Socket |
|senderPortCOM|port com si communication en port com| COMX | --senderPortCOM=COM1 |
|senderSocketPort|socket port si communication socket| XXXX | --senderSocketPort=8080 |
|senderUDPPort|udp port si communication udp| XXXX | --senderUDPPort="8081" |
|senderTCPPort|tcp port si communication tcp|XXXX|--senderTCPPort=4001
|senderPortAddress|adresse si communication udp| XXX.XXX.XXX.XXX | --senderPortAddress="127.0.0.1" |
|senderProvider|type de table| Bodet / SwissTiming / Handvision / StreamDeck / tangodelta-handball | --senderProvider=StreamDeck |
|senderRemoteHost|adresse du receiver| XXX.XXX.XXX.XXX:XXXX | --senderRemoteHost="http://127.0.0.1:9999/" |
|senderRemoteSiteName|nom d'identification du match| abc. | --senderRemoteSiteName="My custom match" |

### Receiver

|Argument|Description|Valeurs|Exemple|
|---|---|---|---|
|receiver|démarrer le receiver|0 / 1|--receiver=1|
|receiverPort|port du receiver| XXXX | --receiverPort=9999 |

### Streamdeck

|Argument|Description|Valeurs|Exemple|
|---|---|---|---|
|streamdeck|démarrer le streamdeck|0 / 1|--streamdeck=1|
|streamdeckPort|port de controle du streamdeck| XXXX | --streamdeckPort=8082 |
|streamdeckAddr|adresse du sender| XXX.XXX.XXX.XXX:XXXX | --streamdeckAddr="http://127.0.0.1:8080" |
|streamdeckReferee|mode arbitre|0 / 1|--streamdeckReferee=0|
|streamdeckProd|mode production|0 / 1|--streamdeckReferee=1|

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