Updated sharing maps how to

src/docs/assets/index.js

@@ -1,7 +1,7 @@
 import defaultMaps from "./DefaultMaps.mp4";
 import customMaps from "./CustomMaps.mp4";
-import customMapsAdvanced from "./CustomMapsAdvanced.jpg";
-import resetingAndRemovingMaps from "./ResetingAndRemovingMaps.mp4";
+import editingMapsAdvanced from "./EditingMapsAdvanced.jpg";
+import resetAndRemovingMaps from "./ResetAndRemovingMaps.mp4";
 import usingDrawing from "./UsingDrawing.mp4";
 import openDiceTray from "./OpenDiceTray.mp4";
 import diceRolling from "./DiceRolling.mp4";
@@ -21,12 +21,14 @@ import startGame from "./StartGame.mp4";
 import diceSharing from "./DiceSharing.mp4";
 import usingTimer from "./UsingTimer.mp4";
 import usingPointer from "./UsingPointer.mp4";
+import mapEditor from "./MapEditor.mp4";
+import filteringMaps from "./FilteringMaps.mp4";
 
 export default {
   defaultMaps,
   customMaps,
-  customMapsAdvanced,
-  resetingAndRemovingMaps,
+  editingMapsAdvanced,
+  resetAndRemovingMaps,
   usingDrawing,
   openDiceTray,
   diceRolling,
@@ -46,4 +48,6 @@ export default {
   diceSharing,
   usingTimer,
   usingPointer,
+  mapEditor,
+  filteringMaps,
 };

src/docs/howTo/sharingMaps.md

@@ -16,26 +16,37 @@ When the default maps don't suit your needs you can upload a custom map.
 
 ![Custom Maps](customMaps)
 
-To do this open the Map Select Screen and then either click the Add Map button in the top left or simply drag an image from your computer into the list of maps.
+To do this open the Map Select Screen and then either click the Add Map button in the top right or simply drag an image from your computer into the list of maps.
 
-Once a custom map has been added you must configure the size of the map.
-
-To do this there are the Column and Row properties. Columns represent how many grid cells your map has in the horizontal direction while Rows represents the amount of cells in the vertical direction.
-
-`Tip: Owlbear Rodeo can automatically fill the Column and Row properties for you if you include them in the file name of the uploaded map. E.g. River [10x15] will create a map named River with 10 columns and 15 rows`
+Once a custom map has been added Owlbear Rodeo will use its machine learning based grid detection to set up your map for you.
 
 `Note: When uploading a custom map keep the file size in mind. Maps are shared between users in Owlbear Rodeo so if a map is taking too long to load for other party members consider changing the Quality option in the advanced map settings.`
 
-## Custom Maps (Advanced)
+## Editing Maps
 
-Once a custom map has been uploaded there are a few advanced settings available.
-To get access to these settings, with the desired map selected, click the Show More button under the Rows and Columns in the Map Select Screen.
+![Map Editor](mapEditor)
 
-![Custom Maps Advanced](customMapsAdvanced)
+Once a custom map has been added there are a few settings you can edit if you wish.
+
+To get access to these settings you can click the Edit Map button while a map is selected.
+
+The topmost view of the Edit Map Screen is a grid editor. This allows you to visually set up any inset your map's grid may have.
+
+Next there are the Column and Row properties. Columns represent how many grid cells your map has in the horizontal direction while Rows represents the amount of cells in the vertical direction.
+
+Next you can set the name of your map shown in the Map Select Screen.
+
+`Tip: If Owlbear Rodeo's grid detection feature fails to automatically fill the Column and Row properties for you, you can also include them in the file name of the uploaded map. E.g. River [10x15] will create a map named River with 10 columns and 15 rows`
+
+## Editing Maps (Advanced)
+
+When editing a map there are also a few more advanced settings available.
+To get access to these settings, click the Show More button under the Name input in the Map Edit Screen.
+
+![Editing Maps Advanced](editingMapsAdvanced)
 
 A brief summary of these settings is listed below.
 
-- Name: The name of the map shown in the Map Select Screen.
 - Grid Type: Change the type of grid to use for the map. Currently only the Square type is supported however Hex will be added in a future release.
 - Show Grid: When enabled Owlbear Rodeo will draw a grid on top of your map, this is useful if a custom map you have uploaded doesn't include a grid.
 - Snap to Grid: When enabled tokens, drawing, fog and measurements will attempt to snap to the grid.
@@ -45,13 +56,22 @@ A brief summary of these settings is listed below.
   - Drawings: Controls whether others can add drawings to the map (default enabled).
   - Tokens: Controls whether others can move tokens that they have not placed themselves (default enabled).
 
-## Reseting and Removing a Map
+## Reseting, Removing and Grouping Maps
 
 With a map selected there are a couple of actions you can perform on them.
 
-![Reseting and Removing Maps](resetingAndRemovingMaps)
+`Tip: You can select multiple maps at the same time using the Select Multiple option or using the Ctrl/Cmd or Shift keyboard shortcuts`
 
-Once a map has been used you can clear away all the tokens, fog and drawings by selecting the map in the Select Map Screen and then on the selected tile click the Reset Map button.
+![Reseting, Removing and Grouping Maps](resetAndRemovingMaps)
 
-To remove a custom map select the map in the Map Select Screen then on the selected tile click the Remove Map button.
-`Warning: This operation cannot be undone`
+Once a map has been used you can clear away all the tokens, fog and drawings by selecting the map in the Select Map Screen and then clicking the Reset Map button.
+
+To remove a custom map select the map in the Map Select Screen then click the Remove Map button or use the Delete keyboard shortcut.
+
+Maps can also be grouped to allow for better organisation. To do this with a map selected click on the Group Map button then select or create a new group.
+
+## Filtering Maps
+
+![Filtering Maps](filteringMaps)
+
+In the Select Map Screen you can filter the maps that are being shown by entering a term in the Search Bar. This will show maps whose names or groups best match your search term.