k4us-share/README.md

Assets from K4us

# K4us Share

## Khmer Chess Font Family

![Khmer Chess Font](./font/exported/KhmerChessFont.PNG "Khmer Chess Font")

## Khmer Chess Font SVG helper

Khmer Chess Font has been using through `k4us-share` in [Khmer Chess Board](https://github.com/K4us/khmer-chess-board.js)

A Typescript and Node.js base helpers for getting Khmer Chess SVG.

usage:

```bash
$ npm i k4us-share
```

Typescript

```typescript
import {
    kingSVG,
    queenSVG,
    generalSVG,
    horseSVG,
    boatSVG,
    fishSVG,
    transformFishSVG,
    moveAudio,
    captureAudio,
    checkAudio,
} from 'k4us-share';
```

Node.js

```javascript
const {
    kingSVG,
    queenSVG,
    generalSVG,
    horseSVG,
    boatSVG,
    fishSVG,
    transformFishSVG,
    moveAudio,
    captureAudio,
    checkAudio,
} = require('k4us-share');
```

```html
<script src="k4us-share/dist/k4us-share.umd.js"></script>

```

## Licence

MIT