asc/MaterialDeck
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

v1.5.2_pre

Browse Source
This commit is contained in:
Cristian Deenen
2023-10-05 23:17:56 +02:00
parent 2cfa8c3ac9
commit 9242cf4978
13 changed files with 269 additions and 299 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
templates/deviceConfig.html
View File

@@ -1,18 +0,0 @@
<form autocomplete="off" onsubmit="event.preventDefault()">
<table style="width:100%; min-width:400px">
<tr>
<th class='materialDeck_devConf_columnLabel'>{{localize "MaterialDeck.Name"}}</th>
<th class='materialDeck_devConf_columnLabel'>{{localize "MaterialDeck.Type"}}</th>
<th class='materialDeck_devConf_columnId'>{{localize "MaterialDeck.Id"}}</th>
<th class='materialDeck_devConf_columnCB'>{{localize "MaterialDeck.Perm.ENABLE.ENABLE.label"}}</th>
</tr>
{{#each devices as |d|}}
<tr>
<td class='materialDeck_devConf_columnLabel'>{{d.name}}</td>
<td class='materialDeck_devConf_columnLabel'>{{d.type}}</td>
<td class='materialDeck_devConf_columnId'><input type="text" value={{d.id}} disabled></td>
<td class='materialDeck_devConf_columnCB'><input type="checkbox" name="enable" id="materialDeck_devConf_{{d.id}}" {{checked d.en}}></td>
</tr>
{{/each}}
</table>
</form>

36
templates/downloadUtility.html
View File

@@ -13,9 +13,9 @@
<tr>
<td class='materialDeck_dlUtil_columnLabel'>{{localize "MaterialDeck.DownloadUtility.module"}}</td>
<td class='materialDeck_dlUtil_columnVersion'>{{localModuleVersion}}</td>
<td class='materialDeck_dlUtil_columnVersion'>v{{versions.module.current}}</td>
<td class='materialDeck_dlUtil_columnVersion'></td>
<td class='materialDeck_dlUtil_columnVersion' id='materialDeck_dlUtil_masterModuleVersion'>{{masterModuleVersion}}</td>
<td class='materialDeck_dlUtil_columnVersion'>{{releases.module.version}}</td>
<td class='materialDeck_dlUtil_columnOS'></td>
<td class='materialDeck_dlUtil_columnButton'><button type="button" class='materialDeck_dlUtil_button' style="visibility:hidden">
<i class="fas fa-download"></i>
@@ -25,9 +25,9 @@
<tr>
<td class='materialDeck_dlUtil_columnLabel'>{{localize "MaterialDeck.DownloadUtility.SDplugin"}}</td>
<td class='materialDeck_dlUtil_columnVersion'>{{localSdVersion}}</td>
<td class='materialDeck_dlUtil_columnVersion'>{{minimumSdVersion}}</td>
<td class='materialDeck_dlUtil_columnVersion' id='materialDeck_dlUtil_masterSdVersion'>{{masterSdVersion}}</td>
<td class='materialDeck_dlUtil_columnVersion'>v{{versions.plugin.current}}</td>
<td class='materialDeck_dlUtil_columnVersion'>v{{versions.plugin.minimum}}</td>
<td class='materialDeck_dlUtil_columnVersion'>{{releases.plugin.version}}</td>
<td class='materialDeck_dlUtil_columnOS'></td>
<td class='materialDeck_dlUtil_columnButton'>
<button type="button" class='materialDeck_dlUtil_button' id='materialDeck_dlUtil_downloadSd' {{#if sdDlDisable}}disabled{{/if}}>
@@ -38,20 +38,22 @@
<tr>
<td class='materialDeck_dlUtil_columnLabel'>{{localize "MaterialDeck.DownloadUtility.MSserver"}}</td>
<td class='materialDeck_dlUtil_columnVersion'>{{localMsVersion}}</td>
<td class='materialDeck_dlUtil_columnVersion'>{{minimumMsVersion}}</td>
<td class='materialDeck_dlUtil_columnVersion' id='materialDeck_dlUtil_masterMsVersion'>{{masterMsVersion}}</td>
<td class='materialDeck_dlUtil_columnVersion'>v{{versions.materialCompanion.current}}</td>
<td class='materialDeck_dlUtil_columnVersion'>v{{versions.materialCompanion.minimum}}</td>
<td class='materialDeck_dlUtil_columnVersion'>{{releases.materialCompanion.version}}</td>
<td class='materialDeck_dlUtil_columnOS'>
<select id="materialDeck_dlUtil_os" default="" {{#if msDlDisable}}disabled{{/if}}>
<option value="win32-x64">{{localize "MaterialDeck.DownloadUtility.Windows"}}</option>
<option value="macos-x64">{{localize "MaterialDeck.DownloadUtility.MacosIntel"}}</option>
<option value="macos-arm64">{{localize "MaterialDeck.DownloadUtility.MacosM1"}}</option>
<option value="macos-x64.dmg">{{localize "MaterialDeck.DownloadUtility.MacosIntel"}} - dmg</option>
<option value="macos-x64.zip">{{localize "MaterialDeck.DownloadUtility.MacosIntel"}} - zip</option>
<option value="macos-arm64.dmg">{{localize "MaterialDeck.DownloadUtility.MacosM1"}} - dmg</option>
<option value="macos-arm64.zip">{{localize "MaterialDeck.DownloadUtility.MacosM1"}} - zip</option>
<option value="linux-x64">{{localize "MaterialDeck.DownloadUtility.Linux"}}</option>
<option value="source">{{localize "MaterialDeck.DownloadUtility.Source"}}</option>
</select>
</td>
<td class='materialDeck_dlUtil_columnButton'>
<button type="button" class='materialDeck_dlUtil_button' id='materialDeck_dlUtil_downloadMs' {{#if msDlDisable}}disabled{{/if}}>
<button type="button" class='materialDeck_dlUtil_button' id='materialDeck_dlUtil_downloadMc' {{#if msDlDisable}}disabled{{/if}}>
<i class="fas fa-download"></i>
</button>
</td>
@@ -66,11 +68,11 @@
<th class='materialDeck_dlUtil_columnButton'>{{localize "MaterialDeck.DownloadUtility.Download"}}</th>
</tr>
<div id='profileContents'>
{{#each profiles as |p|}}
{{#each releases.plugin.profiles as |p|}}
<tr>
<td>{{p.label}}</td>
<td>{{p.name}}</td>
<td class='materialDeck_dlUtil_columnButton'>
<button type="button" class='materialDeck_dlUtil_button' id='materialDeck_dlUtil_dlProfile-{{p.id}}' name='downloadProfile' {{#if ../profileDlDisable}}disabled{{/if}}>
<button type="button" class='materialDeck_dlUtil_button' id='materialDeck_dlUtil_dlProfile-{{p.name}}' name='downloadProfile'>
<i class="fas fa-download"></i>
</button>
</td>
@@ -78,10 +80,4 @@
{{/each}}
</div>
</table>
<button type="button" id='materialDeck_dlUtil_refresh'>
<i class="fas fa-redo"></i>
{{localize "MaterialDeck.DownloadUtility.Refresh"}}
</button>
</form>

74
templates/helpMenu.html
View File

@@ -12,7 +12,7 @@
}
</script>
<div style="width:1200px">
<div style="width:1200px; height:700px">
<h1 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/down.png" class="materialDeck_helpMenu_expandableIcon" style="width:20px">Introduction</h1>
<div class="">
@@ -24,15 +24,15 @@
between the combat tracker, soundboard, or any other (custom) configuration.<br>
<br>
Material Deck is a very large module with tons of features and ways of customizing your experience. This menu will only cover the basics to get you started,
the full documentation can be found on <a href="https://github.com/CDeenen/MaterialDeck/wiki">Github</a>. Please also check the <a href="https://github.com/CDeenen/MaterialDeck/wiki/FAQ">FAQ</a> which answers some common questions, including some basic troubleshooting.<br>
the full documentation can be found on <a href="https://github.com/MaterialFoundry/MaterialDeck/wiki">Github</a>. Please also check the <a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/FAQ">FAQ</a> which answers some common questions, including some basic troubleshooting.<br>
</div>
<h1 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:20px">Latest Releases</h1>
<div class="materialDeck_helpMenu_collapsed">
<a href="https://github.com/CDeenen/MaterialDeck/releases">Module</a><br>
<a href="https://github.com/CDeenen/MaterialDeck_SD/releases">Stream Deck</a><br>
<a href="https://github.com/CDeenen/MaterialServer/releases">Server</a><br>
You can use the download utility in the module settings to download the Stream Deck plugin, Stream Deck profiles and Material Server.
<a href="https://github.com/MaterialFoundry/MaterialDeck/releases">Module</a><br>
<a href="https://github.com/MaterialFoundry/MaterialDeck_SD/releases">Stream Deck</a><br>
<a href="https://github.com/MaterialFoundry/MaterialCompanion/releases">Material Companion</a><br>
You can use the download utility in the module settings to download the Stream Deck plugin, Stream Deck profiles and Material Companion.
</div>
<h1 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:20px">Getting Started</h1>
@@ -57,7 +57,7 @@
<h3>Manually</h3>
<ol>
<li>Download the latest plugin file using the download utility in the module settings, or download it (com.cdeenen.materialdeck.streamDeckPlugin) from <a href="https://github.com/CDeenen/MaterialDeck_SD/releases">here</a></li>
<li>Download the latest plugin file using the download utility in the module settings, or download it (com.cdeenen.materialdeck.streamDeckPlugin) from <a href="https://github.com/MaterialFoundry/MaterialDeck_SD/releases">here</a></li>
<li>Double-click the file, this should open the Stream Deck software</li>
<li>Press 'Install' in the pop-up</li>
</ol>
@@ -67,22 +67,22 @@
<div class="materialDeck_helpMenu_collapsed">
You can create your own profile, but it is recommended to start with one of the pre-made profiles. Currently, there is a profile for the normal and XL Stream Deck variants.
<ol>
<li>Download the latest plugin file using the download utility in the module settings, or download one (ending with .streamDeckProfile) from <a href="https://github.com/CDeenen/MaterialDeck_SD/releases">here</a></li>
<li>Download the latest plugin file using the download utility in the module settings, or download one (ending with .streamDeckProfile) from <a href="https://github.com/MaterialFoundry/MaterialDeck_SD/releases">here</a></li>
<li>Double-click the file, this should load the profile into the Stream Deck software</li>
</ol>
</div>
<h2 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:15px">Downloading and Starting Material Server</h2>
<h2 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:15px">Downloading and Starting Material Companion</h2>
<div class="materialDeck_helpMenu_collapsed">
Material Server acts as a bridge application, bridging the communication between the Stream Deck and Material Deck.
Material Companion acts as a bridge application, bridging the communication between the Stream Deck and Material Deck.
<ol>
<li>Download the latest version for your operating system <a href="https://github.com/CDeenen/MaterialServer/releases">here</a> or through the download utility</li>
<li>Download the latest version for your operating system <a href="https://github.com/MaterialFoundry/MaterialCompanion/releases">here</a> or through the download utility</li>
<li>Extract the archive</li>
<li>Run 'materialserver.exe' (Windows) or 'materialserver' (MacOS and Linux)</li>
<li>Run 'MaterialCompanion.exe' (Windows) or 'MaterialCompanion' (MacOS and Linux)</li>
</ol>
<b>You need to always have Material Server running when you want to use Material Deck</b><br>
<b>You need to always have Material Companion running when you want to use Material Deck</b><br>
<br>
<a href="https://github.com/CDeenen/MaterialServer/wiki">Material Server documentation</a>
<a href="https://github.com/MaterialFoundry/MaterialCompanion/wiki">Material Companion documentation</a>
</div>
</div>
@@ -103,15 +103,15 @@
Below the buttons you will find the following settings:
<ul>
<li><b>Enable Module</b> - Ticking this box enabled the module for the client</li>
<li><b>Material Server Address</b> - Fill in the address of Material Server (usually if you run it on the same computer as
<li><b>Material Companion Address</b> - Fill in the address of Material Companion (usually if you run it on the same computer as
you're using for Foundry, this can be localhost:3001). This is not necessarily the IP address of Foundry! It is the IP
address of the computer that's running Material Server. The default value will work for 99% of people, only change it if
you know what you're doing. More info on Material Server can be found <a href="https://github.com/CDeenen/MaterialServer/blob/master/README.md">here</a></li>
address of the computer that's running Material Companion. The default value will work for 99% of people, only change it if
you know what you're doing. More info on Material Companion can be found <a href="https://github.com/MaterialFoundry/MaterialCompanion/blob/master/README.md">here</a></li>
<li><b>Image Cache Size</b> - Sets the amount of images to store in the image cache. The image cache will locally store all images sent to the Stream Deck.
This improves the update speed, but increases memory usage.</li>
<li><b>Image Brightness</b> - Sets the brightness of the default white images for better readibility of the text. If Image Cache Size is large, it'll take a while for
the new brightness setting to be applied. A refresh will give instantaneous results.</li>
<li><b>Number of Connection Warnings</b> - Sets the number of times you will get a warning when Material Deck cannot connect to Material Server. Will be unlimited if set to 0.</li>
<li><b>Number of Connection Warnings</b> - Sets the number of times you will get a warning when Material Deck cannot connect to Material Companion. Will be unlimited if set to 0.</li>
</ul>
<BR CLEAR="right" />
@@ -131,12 +131,10 @@
<h2 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:15px">Download Utility</h2>
<div class="materialDeck_helpMenu_collapsed">
<img src="modules/MaterialDeck/wiki/img/DownloadUtility.png" align="right" HSPACE="5" width="350">
The download utility allows you to easily check the current version of the Stream Deck plugin and Material Server, and gives you the option to download the latest version.<br>
Please note that the current version of Material Server is at the moment not supported.<br>
The download utility allows you to easily check the current version of the Stream Deck plugin and Material Companion, and gives you the option to download the latest version.<br>
Please note that the current version of Material Companion is at the moment not supported.<br>
<br>
At the bottom you can also download the default profiles from <a href="https://github.com/CDeenen/MaterialDeck_SD/releases">Github</a><div class=""></div><br>
<br>
The refresh button at the bottom refreshes the page in case there was a connection issue.
At the bottom you can also download the default profiles from <a href="https://github.com/MaterialFoundry/MaterialDeck_SD/releases">Github</a>.<div class=""></div><br>
<BR CLEAR="right" />
</div>
@@ -144,7 +142,7 @@
<h2 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:15px">Playlist Configuration</h2>
<div class="materialDeck_helpMenu_collapsed">
<img src="modules/MaterialDeck/wiki/img/PlaylistConfig.png" align="right" HSPACE="5" width="350">
The playlist configuration screen configures the playlists that you control using the <a href="https://github.com/CDeenen/MaterialDeck/wiki/Playlist-Action">Playlist action</a>.<br>
The playlist configuration screen configures the playlists that you control using the <a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Playlist-Action">Playlist action</a>.<br>
There are 2 sections: 'Settings', and 'Playlists'.
<h3><b>Settings</b></h3>
@@ -174,7 +172,7 @@
<h2 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:15px">Macro Configuration</h2>
<div class="materialDeck_helpMenu_collapsed">
The Macro Configuration screen is to configure the macroboard for the <a href="https://github.com/CDeenen/MaterialDeck/wiki/Macro-Action">Macro action</a>.<br>
The Macro Configuration screen is to configure the macroboard for the <a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Macro-Action">Macro action</a>.<br>
<br>
The screen is divided into 32 boxes, each labeled 'Macro #', where each represents a single macro and its settings. This screen will be refered to as a page.
By pressing the arrows at the top right and top left, you can go to the next or previous page. There is no limit to the amount of pages you can add, but if you
@@ -206,7 +204,7 @@
<h2 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:15px">Soundboard Configuration</h2>
<div class="materialDeck_helpMenu_collapsed">
The Soundboard Configuration screen is used to configure the soundboard for the <a href="https://github.com/CDeenen/MaterialDeck/wiki/Soundboard-Action">Soundboard action</a>.<br>
The Soundboard Configuration screen is used to configure the soundboard for the <a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Soundboard-Action">Soundboard action</a>.<br>
<br>
Similar to the Macro Configuration screen, the screen is divided into boxes, each labeled 'Sound #', where each represents a single sound and its settings. This screen will be refered to as a page.
By pressing the arrows at the top right and top left, you can go to the next or previous page. There is no limit to the amount of pages you can add, but if you
@@ -223,7 +221,7 @@
For example, if you have the sounds 'Thunder.wav', 'Thunder2.wav' and 'Thunder3.wav' in the folder 'Assets', you could fill in the following: 'Assets/Thunder*', which
will play one of the three sounds randomly when you press the button on the Stream Deck.</li>
<li><b>Icon</b> - Here you can select an icon that will be displayed on the SD button if 'Display Icon' is selected in the property inspector.
Please read <a href="https://github.com/CDeenen/MaterialDeck/wiki/Getting-Started#important-notes-on-foundry-assigned-text-and-icons">these</a> notes on rules regarding icon selection.</li>
Please read <a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Getting-Started#important-notes-on-foundry-assigned-text-and-icons">these</a> notes on rules regarding icon selection.</li>
<li><b>On</b> - Clicking the colored box you'll be presented with a color picker. This sets the color of the ring that's shown on the button when the sound is playing.</li>
<li><b>Off</b> - Clicking the colored box you'll be presented with a color picker. This sets the color of the ring that's shown on the button when the sound is not playing.</li>
<li><b>Playback</b> - This sets the playback mode, you can select from:
@@ -254,31 +252,31 @@
<h1 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:20px">Customization</h1>
<div class="materialDeck_helpMenu_collapsed">
Material Deck is extremely flexible, but most of this flexibility must be performed in the Stream Deck software.<br>
Some basic instructions on using the software can be found <a href="https://github.com/CDeenen/MaterialDeck/wiki/Getting-Started#basic-stream-deck-setup-instructions">here</a>.<br>
Some basic instructions on using the software can be found <a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Getting-Started#basic-stream-deck-setup-instructions">here</a>.<br>
<br>
Some of the things you can change are:
<ul>
<li><b>Button location</b> - You can drag buttons around into any order you want</li>
<li><b>Changing button text and icon</b> - All the text and icons on the Stream Deck can be customized, see <a href="https://github.com/CDeenen/MaterialDeck/wiki/Getting-Started#changing-the-button-text-and-icon">here</a></li>
<li><b>Changing button text and icon</b> - All the text and icons on the Stream Deck can be customized, see <a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Getting-Started#changing-the-button-text-and-icon">here</a></li>
<li><b>Customize the behavior of buttons</b> - See below</li>
</ul>
All the buttons have many settings to fine-tune your experience. Due to the large amount of things you can change, they will not be discussed here, instead you can read about it at the following links:
<ul>
<li><a href="https://github.com/CDeenen/MaterialDeck/wiki/Combat-Tracker-Action">Combat Tracker Action</a></li>
<li><a href="https://github.com/CDeenen/MaterialDeck/wiki/External-Modules">External Modules</a></li>
<li><a href="https://github.com/CDeenen/MaterialDeck/wiki/Macro-Action">Macro Action</a></li>
<li><a href="https://github.com/CDeenen/MaterialDeck/wiki/Other-Actions">Other Actions</a></li>
<li><a href="https://github.com/CDeenen/MaterialDeck/wiki/Playlist-Action">Playlist Action</a></li>
<li><a href="https://github.com/CDeenen/MaterialDeck/wiki/Scene-Action">Scene Action</a></li>
<li><a href="https://github.com/CDeenen/MaterialDeck/wiki/Soundboard-Action">Soundboard Action</a></li>
<li><a href="https://github.com/CDeenen/MaterialDeck/wiki/Token-Action">Token Action</a></li>
<li><a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Combat-Tracker-Action">Combat Tracker Action</a></li>
<li><a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/External-Modules">External Modules</a></li>
<li><a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Macro-Action">Macro Action</a></li>
<li><a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Other-Actions">Other Actions</a></li>
<li><a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Playlist-Action">Playlist Action</a></li>
<li><a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Scene-Action">Scene Action</a></li>
<li><a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Soundboard-Action">Soundboard Action</a></li>
<li><a href="https://github.com/MaterialFoundry/MaterialDeck/wiki/Token-Action">Token Action</a></li>
</ul>
</div>
<h1 class="materialDeck_helpMenu_expandable"><img src="modules/MaterialDeck/img/right.png" class="materialDeck_helpMenu_expandableIcon" style="width:20px">Feedback & Credits</h1>
<div class="materialDeck_helpMenu_collapsed">
If you have any suggestions or bugs to report, feel free to create an issue, contact me on Discord (Cris#6864), or send me an email: cdeenen@outlook.com.<br>
If you have any suggestions or bugs to report, feel free to create an issue, contact me on Discord (Cris#6864), or send me an email: info@materialfoundry.nl.<br>
<br>
<b>Author:</b> Cristian Deenen (Cris#6864 on Discord)<br>
<br>