Self-serve help material

I’ve had several users ask for general help material before, but I’ve always been at a loss of what kind of help material would be useful. So I’m going to try and start drafting some Q&A material in this post. I’ll make it a wiki so those of you who have the ability to edit wiki posts can edit it, but feel free to post comments with suggestions as well.

What’s the best way to get started with Shmeppy?

Getting familiar with the map editing tools should help you feel more comfortable with Shmeppy. Everything you need to know is available to you in the help text that appears when you hover over tools in the toolbar.

Screen Shot 2020-03-30 at 3.13.57 PM

If you’d like some practice, try recreating this map yourself using Shmeppy’s tools.

How can I track initiative in my games?

Shmeppy does not have an initiative tracking tool built in, however, many GMs have found it very convenient to track initiative in Shmeppy using tokens.

How can I talk to my players? Or roll dice?

Shmeppy does not have any teleconferencing features built in. You’ll need to use other tools to communicate with your players. Here’s a list of some teleconferencing options.

If you don’t have a reason to distrust your players, consider just letting everyone roll physical dice and share their results verbally (or however you’re communicating). There’s lots of digital options too though if you’re worried about lying: here’s a list of some dice rolling options.

Character sheets are often best left in the physical realm, each player keeping a paper sheet like they normally would. But again, there’s digital options if you’d like them. That same guide that contains the two lists I linked to above also has options for character sheets and other things you might want for playing online.

Can I have a rundown of all of the drawing tools?

Yes, let’s go through them all. Though remember that almost all of this information is available in the help text that appears when you hover over each tool in the toolbar.

Screen Shot 2020-03-30 at 3.13.57 PM

Fill Tool

Select the Fill tool by pressing f or clicking on it in the toolbar. With the Fill tool selected, you can…

  • Fill a cell with the selected color by clicking. Click and drag to fill multiple cells.
    Fill_Click
  • Clear cells (return to default gray) by Alt-Clicking or Right-Clicking
    Fill_RClick
  • Flood fill a group of cells sharing the same color by Shift-Clicking. fill
  • Clear a group of cells sharing the same color by holding Alt and Shift-Clicking. You can also Shift-Right-Click, but this won’t work in Firefox because Shift-Right-Click always brings up the context menu. fill
  • Fill a rectangle of cells with the selected color by Shift-Click and Dragging
    Fill_Shift
  • Clear a rectangle of cells by Shift-Alt-Click and Dragging. You can also Shift-Right-Click and Drag, but this won’t work in Firefox because Shift-Right-Click always brings up the context menu.
    Fill_RShift

Edge Tool

Select the Edge tool by pressing e or clicking on it in the toolbar. With the Edge tool selected, you can…

  • Draw an edge by clicking.
    Edge_Click
  • Draw a line of edges by clicking and dragging.
    Edge_Drag
  • Clear an edge by Alt-Clicking or Right-Clicking.
    Edge_RClick
  • Clear a line of edges by Alt-Clicking and dragging or Right-Clicking and dragging.
    Edge_RDrag
  • Draw a 1-by-1 box by Shift-Clicking. Draw a rectangle by Shift-Clicking and dragging
    Edge_Shift
  • Clear a rectangle by Shift-Alt-Clicking and dragging. You can also Shift-Right-Click and Drag, but this won’t work in Firefox because Shift-Right-Click always brings up the context menu.
    Edge_RShift

Token Tool

Select the Token tool by pressing t or clicking on it in the toolbar. With the Token tool selected, you can…

  • Create a token by Left-Clicking. Move a token by Clicking and dragging.
    Token_Click
  • Remove a token by Alt-Clicking or Right-Clicking.
    Token_RClick
  • Rename a token by Double-Clicking on it. Press Enter to save.
    Token_DClick
  • Resize a token by Shift-Clicking and dragging.
    Token_Shift

Fog of War

Select the Fog of War tool by pressing w or clicking on it in the toolbar. With the Fog of War tool selected, you can…

  • Hide a cell from players by Clicking.
    Fog_Click Players see:Fog_Click_Player
  • Reveal a cell to players by Alt-Clicking or Right-Clicking.
    Fog_RClick Players see:Fog_RClick_Player
  • Hide a rectangle of cells from players by Shift-Clicking and dragging. Edges are shown to the players if they border any visible cells.
    Fog_Drag Players see:Fog_Drag_Player
  • Edges are not shown to players if they do not border any visible cells.
    Fog_Drag2 Players see:Fog_Drag2_Player
  • Tokens that are partially behind Fog of War are visible to players.
    Fog_Token_Partial Players see:Fog_Token_Partial_Player
  • Tokens are hidden only if the entire token is within Fog of War.
    Fog_Token_Full Players see:Fog_Token_Full_Player

Measure

Select the Measure tool by pressing s or clicking on it in the toolbar. With the Measure tool selected, you can…

  • Measure the distance between the center of one cell to another by Clicking and dragging. (Snaps to cell center)
    Measure_Drag
  • Measure the distance between any two points by Shift-Clicking and dragging. (No snapping)
    Measure_ShiftDrag

Laser

Select the Laser tool by pressing spacebar or clicking on it in the toolbar. With the Laser tool selected, you can…

  • Leave a cursor laser trail by moving your mouse. All participants can use and see all lasers at the same time.
    Laser_Mouse Players see:Laser_Player

Pan

Select the Pan tool by pressing a or clicking on it in the toolbar. With the Pan tool selected, you can…

  • Drag the view of the map around by Clicking and dragging. The Pan tool can also be used at any time by Middle-Clicking and dragging.
    Pan_Drag

Palette

Select the color you want to draw in using the Palette.
The Palette allows you to…

  • Choose a different color by Double-Clicking. Click the Check to finalize. The selected color in the Palette is displayed a bit larger than the others.
    Palette_DClick
  • Choose a different color by Clicking the Pencil icon. Click the Check to finalize.
    Palette_Pencil
  • Retrieve a color from the map by Double-Clicking on Palette color then Click and drag the Eyedropper to the desired color. Click the Check to finalize.
    Palette_Eyedropper
  • The Fill, Edge, and Token tools all use the selected color in the Palette.
    Palette_Click_Fill Palette_Edge Palette_Token
2 Likes

Was talking to Learuis on Discord today and they made a good case for having documentation and a small gif for every capability Shmeppy has. “Filling a rectangle”, “freeform filling”, “clearing a rectangle”, “freeform clearing”, “drawing an edge”, …

Seems like an intense amount of very boring work, but probably worthwhile.

1 Like

This is what I was thinking, as an example…

*edit - went for it.

1 Like

This came up last night with the Giant Sharks. We were like “I don’t remember how to resize the tokens” so we went to this forum and typed resize into the search and found what we were looking for.

So for me it’s a few things for a new user:

  1. basics of the platform is picked up quickly (clicking, dragging, making a map)
  2. tools and functions are made known (list of features, tutorial gifs)
  3. knowledge of these tools and functions is searchable
  4. searching for functions is intuitive (like being able to search tags like “make bigger…”)
1 Like

Super interesting! Thank you @Nick_Louie. I think those are great goals to try and hit with this documentation.

Notably though, I don’t want to try and solve (1) with this documentation. Or rather, I don’t want Shmeppy to try and solve (1) with this documentation if that makes sense, but if reading this documentation makes you familiar with Shmeppy’s tools that’s totally fine.

This self-serve material is basically the manual that you get when you buy a new product. If many users are consulting this, Shmeppy has failed to make a particular behavior easily discoverable.

Of course, some users enjoy reading manuals, and that’s fine (which was basically Learuis’s point that convinced me to start making this). I remember staying up late reading ledger’s manual because I couldn’t put it down, it was just too exciting.

So I think it’ll be a problem if what you described happens often. There’s quite a few things (some subtle, some direct) that I’ve done to try and make it very easy to discover how to do things with Shmeppy.

In this case, I went and poked Justin (Nick’s and I’s GM, we’re in a campaign together but I missed yesterday) about this, and he said that he hadn’t tried to figure out how to resize a token yet and was more wondering aloud about whether it had landed yet and how to do it. So I’m not sure there’s a problem that’s being signaled there, but I’d be interested in hearing more stories of how someone landed on this documentation.

Someone asked me about tooling to use with Shmeppy recently. That’s probably a good thing to include here. I’ll try to add some useful tools here soon if no one else beats me to it.