Generate beautiful DMG-images for your OS X applications.
npm install appdmg-tfGenerate beautiful DMG-images for your OS X applications.
``sh`
npm install -g appdmg
`sh`
appdmg
- json-path: Path to the JSON Specification filedmg-path
- : Path at which to place the final DMG
To produce a test DMG to your desktop, run the following command:
`sh`
appdmg test/assets/appdmg.json ~/Desktop/test.dmg
The JSON input for the image follows a simple structure. All paths are relative to
the JSON file's path.
`json`
{
"title": "Test Application",
"icon": "test-app.icns",
"background": "test-background.png",
"contents": [
{ "x": 448, "y": 344, "type": "link", "path": "/Applications" },
{ "x": 192, "y": 344, "type": "file", "path": "TestApp.app" }
]
}
+ title (string, required) - The title of the produced DMG, which will be shown when mountedicon
+ (string, optional) - Path to your icon, which will be shown when mountedbackground
+ (string, optional) - Path to your backgroundbackground-color
+ (string, optional) - Background color (accepts css colors)icon-size
+ (number, optional) - Size of all the icons inside the DMGwindow
+ (object, optional) - Window optionsposition
+ (object, optional) - Position when openedx
+ (number, required) - X position relative to bottom of the screeny
+ (number, required) - Y position relative to bottom of the screensize
+ (object, optional) - Window sizewidth
+ (number, required) - Window widthheight
+ (number, required) - Window heightformat
+ (enum[string], optional) - Disk image formatUDRW
+ - UDIF read/write imageUDRO
+ - UDIF read-only imageUDCO
+ - UDIF ADC-compressed imageUDZO
+ - UDIF zlib-compressed imageUDBZ
+ - UDIF bzip2-compressed image (OS X 10.4+ only)ULFO
+ - UDIF lzfse-compressed image (OS X 10.11+ only)contents
+ (array[object], required) - This is the contents of your DMG.x
+ (number, required) - X position relative to icon centery
+ (number, required) - Y position relative to icon centertype
+ (enum[string], required)link
+ - Creates a link to the specified targetfile
+ - Adds a file to the DMGposition
+ - Positions a present filepath
+ (string, required) - Path to the filename
+ (string, optional) - Name of the file within the DMG
0.1.x used a different JSON format. This format is still supported but
deprecated, please update your json.
Finder can display retina backgrounds if packaged correctly into a .tiff
file. will do this for you automatically if it can find a file@2x
with the same name as the background appended with .
E.g. if the json contains "background": "TestBkg.png" then add a fileTestBkg@2x.png
with the name into the same folder.
The application can also be called from within
another javascript file, example:
`javascript
var appdmg = require('appdmg');
var ee = appdmg({ source: 'test/appdmg.json', target: 'test.dmg' });
ee.on('progress', function (info) {
// info.current is the current step
// info.total is the total number of steps
// info.type is on of 'step-begin', 'step-end'
// 'step-begin'
// info.title is the title of the current step
// 'step-end'
// info.status is one of 'ok', 'skip', 'fail'
});
ee.on('finish', function () {
// There now is a test.dmg file
});
ee.on('error', function (err) {
// An error occurred
});
`
You can also pass in the specification directly instead of reading it from a file. basepath should be a path which will be used to resolve other paths in the specification.
`javascript`
var ee = appdmg({
target: 'test.dmg',
basepath: __dirname,
specification: {
"title": "Test Title",
// ...
}
});
Currently the only supported os is Mac OS X.
Track the status of this here: https://github.com/LinusU/node-appdmg/issues/14
By default hidden files will show for users with com.apple.finder AppleShowAllFiles
set to . This can be worked around by moving all hidden files outside the initial"type": "position"
window size (using ), this has the side-effect of enabling a scrollbar.
Files to usually move:
- .background
-
-
-
* create-dmg, a Bash script
* dmgbuild, a Python version