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

Updated FAQ (markdown)

CDeenen
2021-01-15 11:21:42 +01:00
parent cda0c6cd19
commit 456b7cf0af
1 changed files with 30 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
FAQ.md

@@ -1,21 +1,35 @@
Material Deck is a big and complex module, and requires some setup. If you have any issues, please make sure you've thoroughly read and followed the [installation instructions](https://github.com/CDeenen/MaterialDeck/wiki/Installation) and [module settings instructions](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup).<br> Material Deck is a big and complex module, and requires some setup. If you have any issues, please make sure you've thoroughly read and followed the [installation instructions](https://github.com/CDeenen/MaterialDeck/wiki/Installation) and [module settings instructions](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup).<br>
* [I've installed the module, server and Stream Deck plugin, why doesn't it do anything?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#ive-installed-the-module-server-and-stream-deck-plugin-why-doesnt-it-do-anything) * [What Stream Deck variants are supported?](what-stream-deck-variants-are-supported)
* [What game systems are supported?](what-game-systems-are-supported)
* [Could you add support for [game system]?](could
* [Does Material Deck work on Windows/OSX/Linus?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#does-material-deck-work-on-windowsosxlinus)
* [Does Material Deck work with hosting services such as the Forge?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#does-material-deck-work-with-hosting-services-such-as-the-forge) * [Does Material Deck work with hosting services such as the Forge?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#does-material-deck-work-with-hosting-services-such-as-the-forge)
* [My server is secure (using SSL), will Material Deck work?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#my-server-is-secure-using-ssl-will-material-deck-work) * [My server is secure (using SSL), will Material Deck work?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#my-server-is-secure-using-ssl-will-material-deck-work)
* [How do I know if my server is secure?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#how-do-i-know-if-my-server-is-secure) * [How do I know if my server is secure?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#how-do-i-know-if-my-server-is-secure)
* [I've installed the module, server and Stream Deck plugin, why doesn't it do anything?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#ive-installed-the-module-server-and-stream-deck-plugin-why-doesnt-it-do-anything)
* [I get the error that Material Deck cannot connect to Material Server](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#i-get-the-error-that-material-deck-cannot-connect-to-material-server) * [I get the error that Material Deck cannot connect to Material Server](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#i-get-the-error-that-material-deck-cannot-connect-to-material-server)
* [Does Material Deck work on Windows/OSX/Linus?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#does-material-deck-work-on-windowsosxlinus)
* [Material Server won't run and/or gives an error](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#material-server-wont-run-andor-gives-an-error) * [Material Server won't run and/or gives an error](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#material-server-wont-run-andor-gives-an-error)
* [Is there any way I can support your work?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#is-there-any-way-i-can-support-your-work) * [Is there any way I can support your work?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#is-there-any-way-i-can-support-your-work)
# Frequently Asked Questions # Frequently Asked Questions
## I've installed the module, server and Stream Deck plugin, why doesn't it do anything? ## What Stream Deck variants are supported?
Is Material Server running?<br> All of them, including the mobile version!
Is the Stream Deck application running?<br>
Did you either create or install a Stream Deck [plugin](https://github.com/CDeenen/MaterialDeck/wiki/Installation#installing-the-stream-deck-profile-optional)?<br> ## Could you add support for [game system]?
Did you enable the module in 'Manage Modules'?<br> Sure! Please [contact me](https://github.com/CDeenen/MaterialDeck#feedback).
Did you enable the module in the [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup)?
## Could you add support for [module]?
That depends on the module and what you want Material Deck to do. Please [contact me](https://github.com/CDeenen/MaterialDeck#feedback).
## Does Material Deck work on Windows/OSX/Linus?
#### Windows
As far as I know, there are no reported issues with Windows 10
#### OSX
Some users have reported issues. [This](https://github.com/CDeenen/MaterialDeck/issues/43) might solve your issue, otherwise, please [contact me](https://github.com/CDeenen/MaterialDeck#feedback).
#### Linux
Elgato hasn't released an official Stream Deck application for Linux, however there is [streamdeck_ui](https://timothycrosley.com/project-7-streamdeck_ui). There is at least one user who has succesfully used that.
## Does Material Deck work with hosting services such as the Forge? ## Does Material Deck work with hosting services such as the Forge?
Yes it does! Please see below for information on connecting to secured servers. Yes it does! Please see below for information on connecting to secured servers.
@@ -33,24 +47,23 @@ To check:<br>
Access Foundry from a browser. For most (or all) browsers: On the left of the address bar you'll either see a closed lock (server is secure), a lock with a red line through it (server is not secure), or the text 'not secure' (server is not secure).<br> Access Foundry from a browser. For most (or all) browsers: On the left of the address bar you'll either see a closed lock (server is secure), a lock with a red line through it (server is not secure), or the text 'not secure' (server is not secure).<br>
Alternatively, look at the url (invitation link). If it starts with 'http://' it is not secure, if it starts with 'https://' it is secure. Alternatively, look at the url (invitation link). If it starts with 'http://' it is not secure, if it starts with 'https://' it is secure.
## I've installed the module, server and Stream Deck plugin, why doesn't it do anything?
Is Material Server running?<br>
Is the Stream Deck application running?<br>
Did you either create or install a Stream Deck [plugin](https://github.com/CDeenen/MaterialDeck/wiki/Installation#installing-the-stream-deck-profile-optional)?<br>
Did you enable the module in 'Manage Modules'?<br>
Did you enable the module in the [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup)?
## I get the error that Material Deck cannot connect to Material Server ## I get the error that Material Deck cannot connect to Material Server
Make sure that you've followed the [installation instructions](https://github.com/CDeenen/MaterialDeck/wiki/Installation) closely, including the last section 'Installing Material Server'.<br> Make sure that you've followed the [installation instructions](https://github.com/CDeenen/MaterialDeck/wiki/Installation) closely, including the last section 'Installing Material Server'.<br>
Make sure Material Server is running, and that you've set up the correct Material Server Address in the [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup). In most cases, the address should be 'localhost:3001', **not the address of your Foundry server!**<br> Make sure Material Server is running, and that you've set up the correct Material Server Address in the [module settings](https://github.com/CDeenen/MaterialDeck/wiki/Module-Setup). In most cases, the address should be 'localhost:3001', **not the address of your Foundry server!**<br>
The only situation where it should be changed is if you're running Material Server on a different machine than the one you're accessing Foundry from. The only situation where it should be changed is if you're running Material Server on a different machine than the one you're accessing Foundry from.
## Does Material Deck work on Windows/OSX/Linus?
#### Windows
As far as I know, there are no reported issues with Windows 10
#### OSX
Some users have reported issues. [This](https://github.com/CDeenen/MaterialDeck/issues/43) might solve your issue, otherwise, please contact me.
#### Linux
Elgato hasn't released an official Stream Deck application for Linux, however there is [streamdeck_ui](https://timothycrosley.com/project-7-streamdeck_ui). There is at least one user who has succesfully used that.
## Material Server won't run and/or gives an error ## Material Server won't run and/or gives an error
This could be due to various reasons.<br> This could be due to various reasons.<br>
Please make sure you've downloaded and installed all the [prerequisites](https://github.com/CDeenen/MaterialServer/blob/master/README.md#prerequisites)<br> Please make sure you've downloaded and installed all the [prerequisites](https://github.com/CDeenen/MaterialServer/blob/master/README.md#prerequisites)<br>
If that didn't solve the issue, you can try running the server from the [source](https://github.com/CDeenen/MaterialServer/blob/master/README.md#running-from-the-source).<br> If that didn't solve the issue, you can try running the server from the [source](https://github.com/CDeenen/MaterialServer/blob/master/README.md#running-from-the-source).<br>
Please also contact me, so I can try to fix the issue in later releases. Please also [contact me](https://github.com/CDeenen/MaterialDeck#feedback), so I can try to fix the issue in later releases.
## Is there any way I can support your work? ## Is there any way I can support your work?
You could consider becoming a patron on the [Material Foundry](https://www.patreon.com/materialfoundry) Patreon page. You could consider becoming a patron on the [Material Foundry](https://www.patreon.com/materialfoundry) Patreon page.