# utk-render

> FiveM Realtime GameView for HTML

Latest version **1.0.2** (published 2023-10-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install utk-render
pnpm add utk-render
yarn add utk-render
bun add utk-render
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2023-10-12 |
| First published | 2023-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | felipecoder |
| Maintainers | felipecoder |
| Keywords | FiveM, cfx.re |

## Links

- npm: https://www.npmjs.com/package/utk-render
- Repository: https://github.com/felipecoder/utk_render_npm
- Homepage: https://github.com/felipecoder/utk_render_npm#readme
- Issues: https://github.com/felipecoder/utk_render_npm/issues
- npm.io page: https://npm.io/package/utk-render

## Recent versions

- 1.0.2 (latest) — 2023-10-12
- 1.0.1 — 2023-10-12
- 1.0.0 — 2023-10-12

## README

# utk-render-npm
utk-render-npm is an npm library adapted from the original [utk-render](https://github.com/utkuali/utk_render) code

## Installation

```
npm  i utk-render
```

## Usage

```js
import { GameRender } from 'utk-render'
const gamerender = new GameRender()
```

## Handling Screenshot Uploads

To handle screenshot upload requests you can use this php code: https://github.com/melihozkara/fivem-php-img-uploader

### Functions

#### Request Screenshot

Takes a screenshot and uploads it to the defined url

- Async method:

    ```js
    async function takeScreenshot() {
        let resp = await gamerender.requestScreenshot("www.exampleupload.com", "files[]");
        console.log("resp", resp);
    }
    ```

- Normal method:

    ```js
    gamerender.requestScreenshot("www.exampleupload.com", "files[]").then((resp) => {
        console.log("resp", resp);
    })
    ```

#### Render GameView to a canvas element

Can be used for a lot of stuff: video calls, video record, live stream ...

- Start canvas render

    ```js
    const canvas = document.getElementById("videocall-canvas");

    gamerender.renderToTarget(canvas);
    ```

- Stop canvas render

    ```js
    gamerender.stop();
    ```

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