Updated FAQ (markdown)

CDeenen
2021-01-15 11:31:13 +01:00
parent 456b7cf0af
commit 17879b9ed9

22
FAQ.md

@@ -2,8 +2,11 @@ Material Deck is a big and complex module, and requires some setup. If you have
* [What Stream Deck variants are supported?](what-stream-deck-variants-are-supported) * [What Stream Deck variants are supported?](what-stream-deck-variants-are-supported)
* [What game systems are supported?](what-game-systems-are-supported) * [What game systems are supported?](what-game-systems-are-supported)
* [Could you add support for [game system]?](could * [My game system is currently not supported, can I still use Material Deck?](
* [Could you add support for [game system]?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#could-you-add-support-for-game-system)
* [Could you add support for [module]?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#could-you-add-support-for-module)
* [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 on Windows/OSX/Linus?](https://github.com/CDeenen/MaterialDeck/wiki/FAQ#does-material-deck-work-on-windowsosxlinus)
* [Could you add support for [StreamPi](https://stream-pi.com/) or [Touch Portal](https://www.touch-portal.com/)?]
* [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)
@@ -16,13 +19,25 @@ Material Deck is a big and complex module, and requires some setup. If you have
## What Stream Deck variants are supported? ## What Stream Deck variants are supported?
All of them, including the mobile version! All of them, including the mobile version!
## What game systems are supported?
Currently the following systems are supported:
* Dungeons & Dragons 5e
* Dungeons & Dragons 3.5e
* Pathfinder 1e
* Pathfinder 2e
* Shadow of the Demon Lord
## My game system is currently not supported, can I still use Material Deck?
Yes, you can!<br>
Most functions are system agnostic, with the exception of [Token Actions](https://github.com/CDeenen/MaterialDeck/wiki/Token-Action) and [Combat Tracker Actions](https://github.com/CDeenen/MaterialDeck/wiki/Combat-Tracker-Action), where the system is required to display token stats and to set conditions.<br>
If you're system isn't supported, I'd suggest you set the system to DnD5e. You can manually set up the stats using the [custom stats] function, and there's a chance that your systems uses the same conditions as DnD5e.
## Could you add support for [game system]? ## Could you add support for [game system]?
Sure! Please [contact me](https://github.com/CDeenen/MaterialDeck#feedback). Sure! Please [contact me](https://github.com/CDeenen/MaterialDeck#feedback).
## Could you add support for [module]? ## 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). 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? ## Does Material Deck work on Windows/OSX/Linus?
#### Windows #### Windows
As far as I know, there are no reported issues with Windows 10 As far as I know, there are no reported issues with Windows 10
@@ -31,6 +46,9 @@ Some users have reported issues. [This](https://github.com/CDeenen/MaterialDeck/
#### Linux #### 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. 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.
## Could you add support for [StreamPi](https://stream-pi.com/) or [Touch Portal](https://www.touch-portal.com/)?
There are currently no plans for either, but this might change in the future.
## 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.