https://github.com/krypt0nn/neutralino-appimage-bundler
Bundle your Neutralino project in AppImage
https://github.com/krypt0nn/neutralino-appimage-bundler
Last synced: about 1 year ago
JSON representation
Bundle your Neutralino project in AppImage
- Host: GitHub
- URL: https://github.com/krypt0nn/neutralino-appimage-bundler
- Owner: krypt0nn
- License: mit
- Created: 2022-01-01T22:16:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-27T20:38:51.000Z (over 3 years ago)
- Last Synced: 2025-04-02T03:43:22.424Z (over 1 year ago)
- Language: TypeScript
- Size: 39.1 KB
- Stars: 8
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neutralino - AppImage Bundler - Bundle your Neutralino project in AppImage (Tools / For Neutralino)
README
🚀 Neutralino AppImage Bundler
Bundle your Neutralino project in AppImage
⚠️ Works only on Linux x64 systems
# Installation
With npm:
```sh
npm i --save-dev neutralino-appimage-bundler
```
With yarn:
```sh
yarn add -D neutralino-appimage-bundler
```
# Usage
You can, for example, create file named `build-appimage.js`, with this content:
```js
const path = require('path');
// Require bundler
const { Bundler } = require('neutralino-appimage-bundler');
// Create an object with some params
const bundler = new Bundler({
// .desktop file properties
desktop: {
// Name field
name: 'Aboba Project',
// Path to the icon
icon: path.join(__dirname, 'test/public/icons/64x64.png'),
// Categories (defult is Utilities)
categories: ['Game']
},
// Neutralino binary info
binary: {
// Name of the binary (cli.binaryName)
name: 'aboba-amogus',
// Dist folder path
dist: path.join(__dirname, 'test/dist')
},
// Some files or folders to copy inside of the the AppImage
copy: {
'public': path.join(__dirname, 'test/dist/aboba-amogus/public')
},
// Should AppImage contain Neutralino's dependencies or not
// If true, then AppImage will contain binary's shared libraries
includeLibraries: false,
// Path to the appimage to save
output: path.join(__dirname, 'el-passant.AppImage'),
/**
* (optional) If set to true, the AppImage will run only with root privileges
*/
sudo: false,
// Application version
version: '2.0.0'
});
// Bundle project
bundler.bundle();
```
And update your `package.json` scripts:
```json
{
"scripts": {
"bundle:appimage": "node build-appimage.js"
}
}
```
So you'll be able to run
```sh
yarn bundle:appimage
```
or
```sh
npm run bundle:appimage
```
Which will bundle your Neutralino application to the AppImage
Author: [Nikita Podvirnyy](https://github.com/krypt0nn)
Licensed under [MIT](LICENSE)