Updated docs

co-authored-by: mitchemmc <mitchemmc@gmail.com>
This commit is contained in:
Nicola Thouliss 2021-01-20 18:42:19 +11:00
parent 71cce03d58
commit 151e541313
5 changed files with 36 additions and 17 deletions

View File

@ -1,16 +1,16 @@
## Audio Sharing
---
### How do I use Audio Sharing?
You can find out how to use Audio Sharing in our how-to [docs](https://www.owlbear.rodeo/how-to#sharingAudio).
### Why isnt audio sharing working?
Your audio sharing may not be working for a few reasons:
If you see "Your browser doesnt support audio sharing":
- Be sure that you are using Chrome for sharing audio
- Your browser doesnt support audio sharing. Be sure that you are using Chrome for sharing audio, and that your player is is another tab in Chrome.
- No audio found when sharing audio.
### Ive added a map to my game, why cant my players see it?
This could be because its taking a while to upload. Ensure that your players can see a loading bar at the top of the site. Owlbear Rodeo will do its best to load a lower quality map, before continuing to load in higher quality.
If you see "No audio found when sharing audio":
- Be sure that you have the Share audio checkbox ticked when clicking the Share button.

View File

@ -1,5 +1,7 @@
## Database
---
### Database is diasbled.
Owlbear Rodeo uses a local database to store saved data. If you are seeing a database is disabled message this usually means you have data storage disabled. The most common occurrences of this is if you are using Private Browsing modes or in Firefox have the Never Remember History option enabled. The site will still function in these cases however all data will be lost when the page closes or reloads.

9
src/docs/faq/general.md Normal file
View File

@ -0,0 +1,9 @@
## General
---
### Can I self host Owlbear Rodeo
At this time we have no plans to offer a self hosted version of Owlbear Rodeo.
### Is Owlbear Rodeo open source
Owlbear Rodeo is not open source at the moment.

View File

@ -1,20 +1,24 @@
## Games & Maps
---
### Ive added a map to my game, why cant my players see it?
This could be because its taking a while to upload. Ensure that your players can see a loading bar at the top of the site. Owlbear Rodeo will do its best to load a lower quality map, before continuing to load in higher quality. See 'How big can my maps be?' in our faqs.
If your players do not see a loading bar at the top of their screen ensure that you don't have an extension that is blocking WebRTC connections. Some VPN extensions can causes this.
### Why do some of my tokens have a question mark on them?
This means that the token hasnt loaded in just yet. If they still havent loaded in after some time, try giving the page a refresh. You should see load progress on the loading bar at the top of the website.
### How big can my maps be?
Owlbear Rodeo doesn't impose a limit on map sizes but keep in mind the larger the map you upload the longer it will take for your players to load and the harder it will be for your computer to run. We recommend trying to keep your maps under 10MB with a good internet connection and under 5MB with slower internet. If you accidently upload a map that is too big you can use the quality option in the map's settings to lower the size without needing to re-upload your map.
Owlbear Rodeo doesn't impose a limit on map sizes but keep in mind the larger the map you upload the longer it will take for your players to load. We recommend trying to keep your maps under 10MB with a good internet connection and under 5MB with slower internet. If you accidently upload a map that is too big you can use the quality option in the map's settings to lower the size without needing to re-upload your map.
### Where are my maps stored?
Your maps are stored on your local device. This means that clearing your cache will delete your maps, so please only do so if you have no other options.
Your maps are stored on your local device. This means that clearing your site data will delete your maps, so please only do so if you have no other options.
### Why am I being prompted for a password when I didn't set one?

View File

@ -1,5 +1,5 @@
import React from "react";
import { Flex, Text } from "theme-ui";
import { Flex, Text, Box } from "theme-ui";
import raw from "raw.macro";
import Footer from "../components/Footer";
@ -10,6 +10,7 @@ import assets from "../docs/assets";
const database = raw("../docs/faq/database.md");
const maps = raw("../docs/faq/maps.md");
const audioSharing = raw("../docs/faq/audio-sharing.md");
const general = raw("../docs/faq/general.md");
function FAQ() {
return (
@ -32,15 +33,18 @@ function FAQ() {
<Text mb={2} variant="heading" as="h1" sx={{ fontSize: 5 }}>
Frequently Asked Questions
</Text>
<div id="database">
<Markdown source={database} assets={assets} />
</div>
<div id="maps">
<Box my={1} id="general">
<Markdown source={general} assets={assets} />
</Box>
<Box my={1} id="maps">
<Markdown source={maps} assets={assets} />
</div>
<div id="audio-sharing">
</Box>
<Box my={1} id="audio-sharing">
<Markdown source={audioSharing} assets={assets} />
</div>
</Box>
<Box my={1} id="database">
<Markdown source={database} assets={assets} />
</Box>
</Flex>
<Footer />
</Flex>