summaryrefslogtreecommitdiff
path: root/README.md
blob: 6e7d4849e0a157edae40c6656f40e0292a5099e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
# Decky Framegen Plugin

This plugin swaps DLSS with FSR to enable upscaling and frame generation in games without built-in FSR support.

## Features

- Install and uninstall Framegen mod
- Check if Framegen mod path exists

## Installation

1. Clone the repository:
    ```bash
    git clone https://github.com/SteamDeckHomebrew/decky-plugin-template.git
    cd decky-plugin-template
    ```

2. Install dependencies:
    ```bash
    pnpm install
    ```

3. Build the plugin:
    ```bash
    pnpm run build
    ```

## Usage

### Frontend

The frontend code is located in [index.tsx](http://_vscodecontentref_/1). It uses the `@decky/ui` and `@decky/api` libraries to create the UI and interact with the backend.

### Backend

The backend code is located in [main.py](http://_vscodecontentref_/2). It handles the installation and uninstallation of the Framegen mod.

### Scripts

- [prepare.sh](http://_vscodecontentref_/3): Prepares the environment for the Framegen mod installation. It downloads necessary files and sets up the mod path. Located in [prepare.sh](http://_vscodecontentref_/4).

## Development

### Dependencies

This template relies on Node.js v16.14+ and `pnpm` (v9). Install `pnpm` using:
```bash
sudo npm i -g pnpm@9