https://github.com/alexsobiek/positron
Node framework for unpacking, patching, and re-packing electron applications
https://github.com/alexsobiek/positron
electron
Last synced: 4 months ago
JSON representation
Node framework for unpacking, patching, and re-packing electron applications
- Host: GitHub
- URL: https://github.com/alexsobiek/positron
- Owner: alexsobiek
- License: mit
- Created: 2021-06-08T17:27:47.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-06-09T07:00:15.000Z (almost 4 years ago)
- Last Synced: 2024-12-28T13:43:24.224Z (5 months ago)
- Topics: electron
- Language: JavaScript
- Homepage:
- Size: 24.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Positron
Node framework for unpacking, patching, and re-packing [electron](https://www.electronjs.org) applications
## Usage
Packaged Electron apps store their JavaScript source code in `.asar` packages
([more info](https://github.com/electron/asar)). This framework will read those asar packages, output the JavaScript
source to a pre-defined directory and any changes made to those files can be used to generate patch files. Those patch
files can then be stored and applied to the source later on which can then be used to re-package the source for the
electron app.
### Installation
```
npm i https://github.com/alexsobiek/positron
```
### Usage
#### Getting Started
```javascript
const asarPackage = path.join(__dirname, "app.asar") // Where our asar package is located
const sourceDir = path.join(__dirname, "source"); // Where we should dump contents of our asar package
const patchDir = path.join(__dirname, "patches"); // Where we should create and read patches from
const positron = new Positron(asarPackage, sourceDir, patchDir); // Create new Positron instance
```
#### Unpackaging
```javascript
positron.unpackage();
```
#### Create Patches
```javascript
positron.makePatches();
```
#### Apply Patches
```javascript
positron.applyPatches();
```
#### Package new asar
```javascript
positron.package();
```
# Disclaimer
If you are unpacking and patching a closed-source application, it is very likely you are breaking a license or
agreement. Publishing modified applications or patch files are typically prohibited. The purpose of this project is for
proof of concept and to create local modifications of electron apps. Developers of this project are not responsible
should our software lead you to violate an agreement or license.