Skip to contents

Layout data frame for a named preset

Source: R/layout.R
layout_preset.Rd

layout_preset() calculates a layout data frame for a named preset. layout_names() returns the supported layout presets.

Usage

layout_preset(preset = "button_shy_cards", ...)

layout_names()

Arguments

preset

Preset name. Must be in layout_names().

...

Passed to layout_grid()

Value

A data frame with columns "row", "col", "x", "y", "angle", "width", "height", "bleed", "paper", "orientation", and "name".

Details

Unless otherwise indicated the presets are centered on the paper size given by getOption("papersize", "letter") (pass paper or input in ... to override). Supports the following presets:

button_shy_cards

Button Shy Games PnP cards. Caveat: matches many but not all of their PnP files e.g. ROVE-PNP-V2.pdf better matches the poker_3x2_bleed layout.

button_shy_rules

Button Shy Games PnP rule booklet pages (8-page booklet).

button_shy_rules_2x2

Button Shy Games PnP rule booklet pages (4-page booklet).

poker_3x2_bleed

Poker-sized cards (2.5" by 3.5") in 3 columns of 2 cards (landscape) with an 1/8" bleed around each card. Examples of PnP games using this layout include Galdor's Grip.

poker_3x3

Poker-sized cards (2.5" by 3.5") in 3 columns of 3 cards (portrait) with an zero bleed around each card. Examples of PnP games using this layout include the original Mini Rogue.

poker_4x2

Poker-sized cards (2.5" by 3.5") in 4 columns of 2 cards (landscape) with zero bleed around each card. Examples of PnP games using this layout include the Decktet.

4x6_jacket

A single 4x6 photo storage box jacket as created by pdf_create_4x6_jacket(). The width covers the full jacket (back + spine + front).

poker_jacket_1x1

A single poker deck storage box jacket as created by pdf_create_poker_jacket(). The width covers the full jacket (back + spine + front).

poker_jacket_1x2

Two poker deck storage box jackets as created by pdf_create_poker_jacket() when passed a list of two items. Uses portrait paper. The bleed column is zero (the gap between jackets is encoded in the y positions).

Examples

layout_preset("button_shy_cards")
#>   row col     x      y angle width height bleed  paper orientation    name
#> 1   1   1 2.781 6.0985     0 2.469  3.447 0.125 letter   landscape piece.1
#> 2   1   2 5.500 6.0985     0 2.469  3.447 0.125 letter   landscape piece.2
#> 3   1   3 8.219 6.0985     0 2.469  3.447 0.125 letter   landscape piece.3
#> 4   2   1 2.781 2.4015     0 2.469  3.447 0.125 letter   landscape piece.4
#> 5   2   2 5.500 2.4015     0 2.469  3.447 0.125 letter   landscape piece.5
#> 6   2   3 8.219 2.4015     0 2.469  3.447 0.125 letter   landscape piece.6
layout_names()
#> [1] "button_shy_cards"     "button_shy_rules"     "button_shy_rules_2x2"
#> [4] "poker_3x2_bleed"      "poker_3x3"            "poker_4x2"           
#> [7] "4x6_jacket"           "poker_jacket_1x1"     "poker_jacket_1x2"    

# Center the preset on the paper size of a pdf's pages
input <- pdf_create_blank(paper = "a4", orientation = "portrait")
layout_preset("poker_3x3", input = input)
#>   row col        x        y angle width height bleed paper orientation    name
#> 1   1   1 1.633858 9.346457     0   2.5    3.5     0    a4    portrait piece.1
#> 2   1   2 4.133858 9.346457     0   2.5    3.5     0    a4    portrait piece.2
#> 3   1   3 6.633858 9.346457     0   2.5    3.5     0    a4    portrait piece.3
#> 4   2   1 1.633858 5.846457     0   2.5    3.5     0    a4    portrait piece.4
#> 5   2   2 4.133858 5.846457     0   2.5    3.5     0    a4    portrait piece.5
#> 6   2   3 6.633858 5.846457     0   2.5    3.5     0    a4    portrait piece.6
#> 7   3   1 1.633858 2.346457     0   2.5    3.5     0    a4    portrait piece.7
#> 8   3   2 4.133858 2.346457     0   2.5    3.5     0    a4    portrait piece.8
#> 9   3   3 6.633858 2.346457     0   2.5    3.5     0    a4    portrait piece.9
unlink(input)