Skip to content

Commit

Permalink
README, package name update
Browse files Browse the repository at this point in the history
  • Loading branch information
flegald committed Jul 27, 2022
1 parent 0b8a06c commit bc7177d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 30 deletions.
43 changes: 15 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,22 @@
## Electron + TypeScript + React
# GZDeck

Boilerplate for a project using Electron, React and Typescript.

## Installation

Use a package manager of your choice (npm, yarn, etc.) in order to install all dependencies

```bash
yarn
```
A Mod Launcher for GZDoom flatpak version, specifically targeting the Steam Deck

## Usage

Just run `start` script.

```bash
yarn start
```

## Packaging

To generate the project package based on the OS you're running on, just run:

```bash
yarn package
```

## Contributing
---
**Currently in pre-pre-alpha!!**

Pull requests are always welcome 😃.

## License
* Install GZDoom via Discovery Store
* Run GZDoom one time
* Put all IWAD files into `~/.var/app/org.zdoom.GZDoom/.config/gzdoom`
* Put all Mods into `~/.var/app/org.zdoom.GZDoom/.config/gzdoom/mods`
* Download GZDeck's latest release from repository
* Extract ZIP and place extracted folder somewhere safe.
* Open Steam and add non-steam game
* Browse to extracted directory and add the file `gzdeck`
* If unable to add executable through Steam (it may not see inside the folder) use [this plugin](https://github.com/suchmememanyskill/steam-deck-addons/tree/main/Dolphin-rightclick-addtosteam) by [suchmememanykill](https://github.com/suchmememanyskill)
* In Steam's launch arguments you need to add `--no-sandbox`

[MIT](https://choosealicense.com/licenses/mit/)
Controller Support is not implemented, you can use touch or mouse/touchpad
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,8 @@
"config": {
"forge": {
"packagerConfig": {
"name": "Electron starter",
"executableName": "electron-starter",
"name": "GZDeck",
"executableName": "gzdeck",
"icon": "assets/icon",
"extraResource": [
"assets"
Expand Down

0 comments on commit bc7177d

Please sign in to comment.