Merge pull request #4 from TheOtterlord/v0.2.0

V0.2.0

Author: TheOtterlord

CHANGELOG.md

@@ -6,6 +6,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 
+## 0.2.0 Alpha
+
+The auto-updater is back! 
+I've also added a settings menu that over time will be populated with more options to customise DeckMaster.
+
+### Added
+
+- Basic settings menu
+- Ability to reset settings
+- Setting to change YGOPro path
+- In-app notifications API
+- New auto-updater
+- Default keybinding for settings (Ctrl+,)
+
+
 ## 0.1.2 Alpha
 
 A few fixes and improvements

ROADMAP.md

@@ -3,8 +3,8 @@
 This roadmap shows what needs to be completed before the initial full version (`1.0.0`). 
 Things may be added/removed over time if I change my mind about what should be in `1.0.0`. 
 
-- [ ] Settings menu
-- [ ] Keyboard shortcut API
+- [ ] Settings menu (WIP)
+- [x] Keyboard shortcut API
 - [ ] Undo/Redo system
 - [ ] Context menu when right click on deck or a card in deck
 - [ ] Combo Editor (using `.ycb` extension (**Y**u-Gi-Oh! **C**om**b**o))

css/master.css

@@ -266,3 +266,48 @@ header {
   border-radius: 4px;
   transition: background 0.4s;
 }
+
+.settings {
+  background-color: #242424;
+  box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2);
+  position: fixed;
+  top: 50%;
+  left: 50%;
+  transform: translate(-50%, -50%);
+  width: 50%;
+  min-height: 50%;
+  max-height: 80%;
+  overflow-y: scroll;
+  z-index: 10;
+}
+
+.settings h1 {
+  padding: 8px;
+}
+
+.settings .ir-flex-row, .settings .ir-flex-row .ir-flex {
+  margin: 8px;
+.notifications {
+  margin: 16px;
+  position: fixed;
+  bottom: 0;
+  right: 0;
+  z-index: 11;
+  width: 250px;
+  display: flex;
+  flex-direction: column-reverse;
+}
+
+.notifications div {
+  width: 100%;
+  background-color: #343434;
+  box-shadow: 0px 8px 16px 0px rgba(0,0,0,0.2);
+  margin: 16px 0;
+  padding: 8px;
+  animation: slide-in 1s linear;
+}
+
+@keyframes slide-in {
+  from {opacity: 0;}
+  to {opacity: 1;}
+}

docs/first.md

@@ -5,7 +5,8 @@ This screen is the setup, and allows you to optionally link YGOPro/EDOPro to the
 
 ## Linking YGOPro/EDOPro
 
-If you wish to link YGOPro/EDOPro to the app, click on the button and navigate to the application's folder.
+If you wish to link YGOPro/EDOPro to the app, click on the button and navigate to the application's folder. 
+You can change this later in settings. 
 
 > HINT: The folder is the one containing `YGOPro.exe` or `EDOPro.exe`
 

docs/install.md

@@ -1,7 +1,6 @@
 # Installation
 
 You can install DeckMaster's latest version via one of the installers, or by building it from the source code.
-Sadly, Mac users currently **must** build from source as I cannot compile for MacOS.
 
 > NOTE: auto-update is disabled. Please download new versions to install them when they are released. I will try to fix this as soon as possible. Watch the blog for updates: https://theotterholt.blogspot.com/
 
@@ -15,10 +14,10 @@ Sadly, Mac users currently **must** build from source as I cannot compile for Ma
 ## Windows Installer
 
 Head to the [download](https://github.com/TheOtterlord/deckmaster/releases/latest) page for the most recent version of **DeckMaster**.
-Download the `win-installer.exe` file and run it to install the app. 
+Download the `installer.exe` file and run it to install the app.
 
-You might be warned by Windows not to run the app. 
-This is because the app is unsigned. 
+You might be warned by Windows not to run the app.
+This is because the app is unsigned.
 Code signing can cost a lot of money, and for an individual developing free software, it doesn't make much sense to sign it.
 
 ![Microsoft Defender prevents unsigned apps from running without permission](assets/win-protect1.png)
@@ -27,14 +26,14 @@ To continue using the installer, just click `More info`, then `Run anyway`.
 If the installer does not work on your architecture, you can always [build from source](#build-from-source).
 
 
-## Linux Installer
+## Linux & macOS Installers
 
 Head to the [download](https://github.com/TheOtterlord/deckmaster/releases/latest) page for the most recent version of **DeckMaster**.
-Download the `linux-installer` with your platform's installer extension and run it to install the app. 
+Download the `linux-installer` with your platform's installer extension (or `installer.dmg` on macOS) and run it to install the app. 
 
-You can install the `rpm` build using something like `yum`. 
+You can install the `rpm` build using a supported package manager like `yum`. 
 
-You may be warned by your computer that the app is unknown and unsigned. 
+You may be warned by your computer that the app is unknown.
 This is because the app is not signed. 
 Code signing can cost a lot of money, and for an indifivual developing free software, it doesn't make much sense to sign my code.
 If the installer does not work, you can always [build from source](#build-from-source).
@@ -47,5 +46,5 @@ If you run into any problems, please open an [issue](https://github.com/TheOtter
 
 1. Install [NodeJS](https://nodejs.org)
 2. Download the [repository](https://github.com/TheOtterlord/deckmaster/archive/master.zip), and unzip it into an empty folder
-3. Run `npm install && npm install electron-builder` to download dependancies
-4. Run `npm run dev` to use the app, or run `npm run build` to package it for your platform
+3. Run `npm install` to download dependancies
+4. Run `npm run dev` to run the app

docs/keys.md

@@ -0,0 +1,8 @@
+# Keybindings
+
+This lists the default keybindings used by DeckMaster.
+
+- `Ctrl+F1` Opens the documentation in your default browser
+- `Ctrl+O` Opens a new deck
+- `Ctrl+S` Saves the current deck
+- `Ctrl+,` Opens the settings

docs/settings.md

@@ -0,0 +1,13 @@
+# Settings
+
+The settings meny can be accessed via `Help > Settings` or the `Ctrl+,` keybinding.
+
+## YGOPro/EDOPro Path
+
+This setting defines the path to the folder containing your YGOPro/EDOPro app.
+The folder should contain `YGOPro.exe` or `EDOPro.exe` along with folders like `pics` and `deck`.
+
+## Reset All Settings
+
+As the name states, this resets all of DeckMaster's settings.
+However, this will not delete any decks/combos you have created with DeckMaster.

index.html

@@ -10,6 +10,7 @@
   <link rel="stylesheet" href="css/master.css">
   <link rel="stylesheet" href="css/filter.css">
   <link rel="stylesheet" href="css/editor.css">
+  <link rel="stylesheet" href="css/iridium.css">
 </head>
 
 <body>
@@ -20,6 +21,7 @@
   <script src="js/hg_calc.js"></script>
   <script src="js/combowidget.js"></script>
   <script src="js/keybind.js"></script>
+  <script src="js/settings.js"></script>
   <script src="js/update.js"></script>
   <script src="js/main.js"></script>
 
@@ -55,6 +57,7 @@
           <a href="#" onclick="deckmaster.wiki()">User documentation</a>
           <a href="#" onclick="deckmaster.link('https://github.com/TheOtterlord/deckmaster/issues')">Report a bug</a>
           <a href="#" onclick="deckmaster.link('https://github.com/TheOtterlord/deckmaster')">GitHub</a>
+          <a href="#" onclick="open_settings()">Settings</a>
           <a href="#" onclick="checkForUpdates()">Check for updates</a>
           <a href="#" onclick="deckmaster.link('https://theotterlord.github.io/deckmaster/about')">About</a>
         </div>
@@ -288,6 +291,18 @@ <h2 style="padding: 4px;">Filter <span style="color:red;">(EXPERIMENTAL)</span><
     </div>
   </div>
 
+  <div class="settings" style="display: none;">
+    <h1>Settings</h1>
+    <div class="ir-flex-row">
+      <div class="ir-flex">YGOPro/EDOPro Path: </div>
+      <button class="ir-flex ygopro_connect" onclick="ygoprodeck.linkYGOPro()">No folder selected...</button>
+    </div>
+    <div class="ir-flex-row">
+      <button class="ir-flex ygopro_connect" onclick="deckmaster.reset_all()">Reset All Settings</button>
+      <button class="ir-flex ygopro_connect" onclick="close_settings()">Close Settings</button>
+    </div>
+  </div>
+
   <div class="intro" style="display:none;">
     <h2>Welcome</h2>
     <p>
@@ -297,13 +312,15 @@ <h2>Welcome</h2>
     </p>
     <p>
       To improve performance, DeckMaster is capable of linking to YGOPro/EDOPro to share the same deck/image storage.
-      If you would like to do this, please direct us to the app's folder using the button below.
-      If not, just click "Finish".
+      If you would like to do this, please direct us to the app's folder containing the YGOPro.exe or EDOPro.exe file using the button below.
+      If not, just click "Finish". You can change these preferences later in settings.
     </p>
     <button class="ygopro_connect" onclick="ygoprodeck.linkYGOPro()">No folder selected...</button>
     <br><br>
     <button onclick="deckmaster.setup()">Finish</button>
   </div>
+
+  <div class="notifications"></div>
 </body>
 
-</html>
+</html>

index.js

@@ -1,9 +1,12 @@
-const { app, BrowserWindow, Menu, MenuItem } = require('electron')
+const { app, BrowserWindow, ipcMain } = require('electron')
 const path = require('path')
 const url = require('url')
+const {autoUpdater} = require("electron-updater")
+
+let win;
 
 function createWindow () {
-  let win = new BrowserWindow({
+  win = new BrowserWindow({
 		icon:'favicon.ico',
 		show: false,
 		backgroundColor: '#202020',
@@ -20,7 +23,7 @@ function createWindow () {
       // when deprecated, remove `nodeIntegration: true` but keep this
       contextIsolation: false
 		}
-	});
+  });
 
   // open links in native browser
   win.webContents.on('new-window', function(e, url) {
@@ -34,14 +37,19 @@ function createWindow () {
 		pathname: index_path,
 		protocol: 'file:',
 		slashes: true
-  }));
+  }))
+  
+  ipcMain.on('update', () => {
+    autoUpdater.quitAndInstall();
+  });
 
   win.webContents.on("did-finish-load", () => {
     win.webContents.send("cmd", process.argv);
   });
 
   // Once loaded, show the screen
   win.once('ready-to-show', () => {
+    autoUpdater.checkForUpdatesAndNotify();
     win.maximize();
     win.show();
   });
@@ -68,3 +76,19 @@ app.on('activate', () => {
     createWindow()
   }
 })
+
+function sendStatusToWindow(text) {
+  win.webContents.send('message', text);
+}
+
+autoUpdater.on('update-downloaded', (info) => {
+  sendStatusToWindow('update-downloaded');
+});
+
+autoUpdater.on('update-available', (info) => {
+  sendStatusToWindow('update-available');
+})
+
+autoUpdater.on('download-progress', (progressObj) => {
+  sendStatusToWindow('progress:'+Math.round(progressObj.percent));
+})

js/api.js

@@ -1,13 +1,17 @@
 const { dialog } = require('electron').remote;
 
 const deckmaster = {
-  version: "v0.1.2",
+  version: "v0.2.0",
   notification: (title, text, onclick) => {
     const notification = new Notification(title, {
       body: text
     });
     notification.onclick = onclick;
   },
+  reset_all: () => {
+    localStorage.clear();
+    deckmaster.restart();
+  },
   setup: () => {
     localStorage.setItem("settings", JSON.stringify({
       "settingsVersion": "0.1.0"