{"id":9535287,"url":"https://github.com/frokk/Neu-AppImage","last_synced_at":"2025-08-23T22:31:08.888Z","repository":{"id":106283517,"uuid":"460601340","full_name":"frokk/Neu-AppImage","owner":"frokk","description":"Package Neutralino Application Into AppImage Format","archived":false,"fork":false,"pushed_at":"2022-02-25T12:20:18.000Z","size":3997,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-08-23T18:16:51.284Z","etag":null,"topics":["appimage","appimage-builder","neutralinojs"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/neu-appimage","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/frokk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-17T20:42:20.000Z","updated_at":"2023-10-11T19:59:26.000Z","dependencies_parsed_at":"2024-05-13T00:49:42.386Z","dependency_job_id":null,"html_url":"https://github.com/frokk/Neu-AppImage","commit_stats":null,"previous_names":["frokk/neu-appimage"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frokk%2FNeu-AppImage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frokk%2FNeu-AppImage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frokk%2FNeu-AppImage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/frokk%2FNeu-AppImage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/frokk","download_url":"https://codeload.github.com/frokk/Neu-AppImage/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":217404460,"owners_count":16171827,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["appimage","appimage-builder","neutralinojs"],"created_at":"2024-05-12T23:51:34.863Z","updated_at":"2024-08-28T20:30:59.908Z","avatar_url":"https://github.com/frokk.png","language":"TypeScript","readme":"# Neu-AppImage\nPackage Neutralino Application Into AppImage Format\n\n---\n\n## From the Command Line\n\nRunning Neu AppImage from the command line has this basic form:\n\n```bash\nnpx neu-appimage --exe \u003cmain-executable\u003e --res \u003cresource.neu-file\u003e --program-name \u003cprogram-name\u003e --description \u003cdescription\u003e --icon \u003cpng-512x512-icon\u003e --categories \u003ccategories\u003e --arch \u003carchitecture\u003e --out-dir \u003coutput-directory\u003e [Optional Arguments]\n```\n\nYou can directly build your AppImage from command line, available options are:\n\n```html\n     NAME            TYPE      OPTIONAL         DESCRIPTION\n--exe              \u003cstring\u003e      NO        Path To The Main Executable\n--res              \u003cstring\u003e      NO        Path To The \"resource.neu\" File\n--files            \u003cstring\u003e      NO        Path To Other Files To Include (seprated by comma, example: file1,file2,file3)\n--program-name     \u003cstring\u003e      NO        Name Of The Program\n--generic-name     \u003cstring\u003e      YES       Generic Name Of The Program\n--description      \u003cstring\u003e      NO        Description Of The Program\n--icon             \u003cstring\u003e      NO        Path To The Program Icon\n--version          \u003cstring\u003e      YES       Program Version (ex - 1.0.2-stable or 3.5)\n--categories       \u003cstring\u003e      NO        Category Of The Program (Seprated By Comma if multiple, example: cat1,cat2)\n--working-dir      \u003cstring\u003e      YES       The working directory to run the program in\n--arch             \u003cstring\u003e      NO        Program Architecture (x64 or x32)\n--out-dir          \u003cstring\u003e      NO        Path to directory to save AppImage in\n--log                            YES       Log the output of AppImage Tool.\n--list-categories                YES       List Available Categories.\n-V, --version                    YES       Output the version number\n-h, --help                       YES       Display help for command\n```\n\n---\n\n## API\n\n```javascript\nconst { AppImage, STATUS_CODE } = require('neu-appimage');\n```\n\n### `new AppImage(executable, resource, files, outdir, options)`\n\n`executable` is the path to the Main Neutralino Generated Binary.\n\n`resource` is the path to the `resource.neu` file Generated by Neutralino.\n\n`files` is an Array of Strings containing Path To Files To Be Included in AppImage.\n\n`outdir` is a String Path to the directory in which to save the AppImage To.\n\n`options` is an object that can contain following fields:\n\n* `programName` - Name of the program (ex - `\"FireFox\"`).\n* `genericName` - Generic Name of the program (ex - `\"Web Browser\"`).\n* `description` - Description of the program (ex - `\"Free and open-source web browser\"`).\n* `icon` - Path to the icon file (`.png`) in 512x512 or 256x256 resolution (ex - `\"/path/to/icon.png\"`).\n* `version` - Version of your program (ex - 0.3.9-beta or 1.3).\n* `categories` - Array of Strings Containing Category of the program (ex - `[\"Utility\", \"Network\"]`).\n* These are the available `categories`\n    - Audio\n    - Video\n    - AudioVideo\n    - Development\n    - Education\n    - Game\n    - Graphics\n    - Network\n    - Office\n    - Science\n    - Settings\n    - System\n    - Utility\n* `workingDir` - The working directory to run the program in (ex - `\"~/\"`).\n* `arch` - Architecture of your program which the AppImage will inherit (only `x86_64` \u0026 `i386` are supported currently) (ex - `\"x86_64\"`).\n* `showAppImgToolOutput` - if true, output of the [AppImage Tool](https://github.com/AppImage/AppImageKit) will be showed on console (can be useful for debugging if command fails) (ex - `false`).\n\n### `myAppImageInstance.build()`\nBuilds the AppImage \u0026 returns Object containing information related to Build\n\n`code` - Return Code is `STATUS_CODE.SUCCESS` if AppImage Was Created Successfully else it can return:\n* `STATUS_CODE.PATH_NOT_FOUND` - If a File/Folder doesn't Exist.\n* `STATUS_CODE.UNSUPPORTED_OS_ARCHITECTURE` - If the machine running the code is not `x64` or `x32` Bit.\n* `STATUS_CODE.UNSUPPORTED_ARCHITECTURE` - If the `arch` property in `options` is not `x64` or `x32`.\n* `STATUS_CODE.UNSUPPORTED_OS` - If the machine running the code is not Linux.\n* `STATUS_CODE.UNKNOWN` - If the error is Unknown.\n\n`text` - Path to the generated AppImage if successfully created one, else Description of the Error Occured.\n\n---\n\n## Found Bugs?\n\nYou can report bugs/issues [Here](https://github.com/DEVLOPRR/Neu-AppImage/issues/new/choose)\n\n---\n\n# Thanks\n","funding_links":[],"categories":["Tools"],"sub_categories":["For Neutralino"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrokk%2FNeu-AppImage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffrokk%2FNeu-AppImage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffrokk%2FNeu-AppImage/lists"}