Skip to content

Commit

Permalink
chore: Build formats (#15)
Browse files Browse the repository at this point in the history
Adds more build formats and info in the README

* [feat] adding build:windows command
* [fix] typo
* [feat] adding build:linux command
* [docs] adding enduser documentation to explain how to install Viper
* [feat] building several Linux packages on build:linux
* [fix] typo on build command
* minor corrections

Co-authored-by: 0neGal <mail@0negal.com>
  • Loading branch information
Alystrasz and 0neGal committed Dec 31, 2021
1 parent ba82a7e commit cd0a935
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 4 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,26 @@ This'll launch it with the Electron build installed by `npm`.

Additionally, if you really want to, you can build Viper with `npm run build` and it'll then build the Windows installer and AppImage, however the whole build process and everything related to it is still being worked on which is why we don't have official releases yet.

## Install

(this will be relevant once we start to publish releases)

Downloads are available on the [releases page](https://github.com/0neGal/viper/releases/latest).

Please note that some versions will (*[soon™](https://github.com/0neGal/viper/tree/auto-updates)*) update themselves automatically when a new release is available (just like Origin or Steam) and some will NOT, so choose it accordingly. Only the AppImage and Windows Setup/Installer can auto-update.

**Windows:** `Viper Setup [x.y.z].exe` (auto-updates, and is recommanded), `Viper [x.y.z].exe` (single executable, no fuss)

**Linux:** `.AppImage` (auto-updates), `.deb`, `.rpm`, `.snap`, `.tar.gz`

## What can it do specifically?

Currently Viper is capable of:

* Updating/Installing Northstar
* Launching Vanilla and or Northstar
* Manage Mods (Soon, see **mod-support** branch)
* Auto-Update itself (Soon, see **auto-updater** branch)
* Manage Mods (Soon, see [**mod-support**](https://github.com/0neGal/viper/tree/mod-support) branch)
* Auto-Update itself (Soon, see [**auto-updater**](https://github.com/0neGal/viper/tree/auto-updates) branch)
* Be pretty!

Besides this I've been considering adding some easy to use VPK modding tools so everybody can have fun with VPK modding even if you don't know how to do it the traditional way. However that is not at the top of the todo list right now.
Expand Down
17 changes: 15 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,32 @@
"installerIcon": "icon.ico",
"uninstallerIcon": "icon.ico",
"installerHeaderIcon": "icon.ico"
},
"linux": {
"icon": "512x512.png",
"category": "Game",
"target": [
"AppImage",
"snap",
"deb",
"rpm",
"tar.gz"
]
}
},
"scripts": {
"start": "npx electron src/index.js",
"debug": "npx electron src/index.js --debug",
"man": "npx marked-man docs/viper.1.md > docs/viper.1",
"build": "npx electron-builder --win nsis --linux appimage"
"build": "npx electron-builder --win nsis --win portable --linux",
"build:windows": "npx electron-builder --win nsis --win portable",
"build:linux": "npx electron-builder --linux"
},
"repository": {
"type": "git",
"url": "git+https://github.com/0neGal/viper.git"
},
"author": "0neGal",
"author": "0neGal <mail@0negal.com>",
"license": "GPL-3.0-or-later",
"bugs": {
"url": "https://github.com/0neGal/viper/issues"
Expand Down

0 comments on commit cd0a935

Please sign in to comment.