Skip to content

Commit

Permalink
Update Readme & build script
Browse files Browse the repository at this point in the history
  • Loading branch information
Alamantus committed Apr 15, 2021
1 parent 048cae0 commit 4733078
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ node_modules/
*.dl
*.dlz
releases/
*.log
package-lock.json
.DS_Store
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Right click on the grid to select the type of node to create:
- **Branch** - A switch/case list for previously set variables. Click the `+`
to add more cases and the `-` to remove (from the bottom).
- **Set** - Name and set a variable.
- **Node** - ??? This is identical to Text, so I'm not sure why it's here.
- **Node** - Does nothing but behaves like Text. Best to just ignore it.

After creating a node, click and drag from the green semicircle of the node to
another node's red semicircle to connect them. You can change which node an
Expand All @@ -52,6 +52,43 @@ arrow.

Click the X anywhere you see it to delete the attached thing.

Building Releases
-----------------

You can build executable files for all major operating systems using:

```
npm run build
```

The files are output to `releases` when it's done.

You can also install to individual operating systems using the following:

```
npm run build-win
npm run build-lin
npm run build-mac
```

**NOTE:** This uses pretty old versions of everything, and for some reason `[email protected]`
refuses to work with NodeJS versions in the double digits. Use a [Node Version Manager](https://npm.github.io/installation-setup-docs/installing/using-a-node-version-manager.html)
and use Node v8.x with this project.

**ALSO:** If you're using MacOS to build Windows releases, reconsider. If you still
want to do it, you'll need to [install Wine](https://www.davidbaumgold.com/tutorials/wine-mac/)
and check out [this comment](https://github.com/electron/node-rcedit/issues/51#issuecomment-546234084)
for how to get the icon editor to work since MacOS Catalina and up don't have 32-bit capability.

### Why are the dependencies so out of date?

Because this project was originally just a fork of the original project to get it working
in Electron and nothing more. At this point, trying to update all the dependencies
and get everything working again with the new versions would simply not be worth the effort.

If you feel called to upgrade everything, feel free to fork and send a pull request my way.
I'll merge it as soon as I can if it works!

The MIT License
---------------

Expand Down
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "dialogger",
"main": "app.js",
"description": "A simple cross-platform dialogue graph editor.",
"version": "1.1.0",
"version": "1.1.1",
"author": "Robbie Antenesse <[email protected]>",
"contributors": [
{
Expand All @@ -13,7 +13,10 @@
],
"scripts": {
"start": "electron .",
"build": "electron-packager . Dialogger --all"
"build": "npm run build-win && npm run build-lin && npm run build-mac",
"build-win": "electron-packager . Dialogger --platform=win32 --arch=all --icon=images/dialogger.ico --out=./releases --overwrite --prune",
"build-lin": "electron-packager . Dialogger --platform=linux --arch=all --icon=images/dialogger.png --out=./releases --overwrite --prune",
"build-mac": "electron-packager . Dialogger --platform=darwin --arch=all --icon=images/dialogger.icns --out=./releases --overwrite --prune"
},
"repository": {
"type": "git",
Expand Down

0 comments on commit 4733078

Please sign in to comment.