Package 'ppdf'

Setups for alquerque variants

Description

tibble data frames of setups for 2 alquerque variants. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

alquerque_alquerque()

alquerque_baghchal()

Details

Here are links for more information about the various games:

Game	URL
Alquerque	https://en.wikipedia.org/wiki/Alquerque
Bagh-chal	https://en.wikipedia.org/wiki/Bagh-chal

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

Examples

df <- alquerque_alquerque()
if (requireNamespace("ppcli", quietly = TRUE) &&
    packageVersion("ppcli") >= "0.2.0-1") {
  ppcli::cat_piece(df)
}

---

Generate alquerque boards and pieces

Description

alquerque_board() returns an alquerque board. alquerque_bits() returns alquerque pieces.

Usage

alquerque_board(x0 = 1, y0 = 1, ..., suit = 3L)

alquerque_bits(
  ...,
  suit = 1:6,
  x = as.double(1:6),
  y = 1,
  angle = 0,
  length.out = NA_integer_
)

Arguments

x0	X coordinate for the center of the first point
y0	Y coordinate for the center of the first point
...	Should be left empty.
suit	Suit value (color) of board. 1L is "red", 2L is "black", 3L is "green", 4L is "blue", 5L is "yellow", and 6L is "white".
x, y	Cartesian coordinates (numeric vectors)
angle	Rotation of piece (numeric vector of degrees, counter-clockwise)
length.out	The number of pieces. Not needed if all the arguments are the same length (or of length one) and this length is the same as the number of desired pieces.

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Setups for other games playable with a checkers set

Description

tibble data frames of setups for 8 other games playable with a checkers set. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

checkers_breakthrough(cell_width = 1)

checkers_crossings(cell_width = 1)

checkers_dao(cell_width = 1)

checkers_focus(cell_width = 1)

checkers_four_field_kono(cell_width = 1)

checkers_grasshopper(cell_width = 1)

checkers_julgonu(cell_width = 1)

checkers_lines_of_action(cell_width = 1)

Arguments

cell_width

Width of board cell. Most renderers support 1 or 2.

Details

Here are links for more information about the various games:

Game	URL
Breakthrough	https://en.wikipedia.org/wiki/Breakthrough_(board_game)
Crossings	https://en.wikipedia.org/wiki/Crossings_(game)
Dao	https://boardgamegeek.com/boardgame/948/dao
Focus	https://en.wikipedia.org/wiki/Focus_(board_game)
Four Field Kono	https://en.wikipedia.org/wiki/Four_Field_Kono
Grasshopper	http://www.cyningstan.com/game/71/grasshopper
Jul-Gonu	https://en.wikipedia.org/wiki/Jul-Gonu
Lines of Action	https://en.wikipedia.org/wiki/Lines_of_Action

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Setups for checkers variants

Description

tibble data frames of setups for 16 checkers variants. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

checkers_american_checkers(cell_width = 1)

checkers_american_pool_checkers(cell_width = 1)

checkers_brazilian_checkers(cell_width = 1)

checkers_canadian_checkers(cell_width = 1)

checkers_checkers(cell_width = 1)

checkers_czech_checkers(cell_width = 1)

checkers_dameo(cell_width = 1)

checkers_english_checkers(cell_width = 1)

checkers_frisian_checkers(cell_width = 1)

checkers_gothic_checkers(cell_width = 1)

checkers_international_checkers(cell_width = 1)

checkers_italian_checkers(cell_width = 1)

checkers_jamaican_checkers(cell_width = 1)

checkers_portuguese_checkers(cell_width = 1)

checkers_russian_checkers(cell_width = 1)

checkers_spanish_checkers(cell_width = 1)

checkers_thai_checkers(cell_width = 1)

checkers_turkish_checkers(cell_width = 1)

Arguments

cell_width

Width of board cell. Most renderers support 1 or 2.

Details

Here are links for more information about the various games:

Game	URL
(American) Checkers AKA (English) Draughts	https://en.wikipedia.org/wiki/Draughts
American Pool Checkers	https://draughts.github.io/american-pool-checkers.html
Brazilian Checkers AKA Brazilian Draughts	https://en.wikipedia.org/wiki/Brazilian_draughts
Canadian Checkers AKA Canadian Draughts	https://en.wikipedia.org/wiki/Canadian_checkers
Czech Checkers AKA Czech Draughts	https://en.wikipedia.org/wiki/Czech_draughts
Dameo	https://en.wikipedia.org/wiki/Dameo
Frisian Checkers AKA Frisian Draughts	https://en.wikipedia.org/wiki/Frisian_draughts
Gothic Checkers AKA Gothic Draughts	http://mlwi.magix.net/bg/gothiccheckersvariants.htm
International Checkers AKA International Draughts	https://en.wikipedia.org/wiki/International_draughts
Italian Checkers AKA Italian Draughts	https://en.wikipedia.org/wiki/Italian_draughts
Jamaican Checkers AKA Jamaican Draughts	https://web.archive.org/web/20230605023244/http://poolcheckers.com/jamaica/
Portuguese Checkers AKA Portuguese Draughts	http://www.fpdamas.pt/regras/
Russian Checkers AKA Russian Draughts	https://en.wikipedia.org/wiki/Russian_draughts
Spanish Checkers AKA Spanish Draughts	https://mindsports.nl/index.php/on-the-evolution-of-draughts-variants/draughts-variants/497-dama_s
Thai Checkers AKA Thai Draughts AKA Mak-hot AKA Makhos	https://checkers.fandom.com/wiki/Mak-hot
Turkish Checkers AKA Turkish Draughts AKA Dama	https://en.wikipedia.org/wiki/Turkish_draughts

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Generate checkers boards and pieces

Description

checkers_board() returns a square checkers board of desired size and type. checkers_bits() returns checkers discs.

Usage

checkers_board(
  nrows = 8L,
  ncols = nrows,
  x0 = 1,
  y0 = 1,
  ...,
  side = "face",
  piece_side = paste0("board_", side),
  suit = 3L,
  angle = 0,
  cell_width = 1
)

checkers_bits(
  ...,
  suit = 1:6,
  x = as.double(1:6),
  y = 1,
  angle = 0,
  cell_width = 1,
  length.out = NA_integer_
)

Arguments

nrows	Number of rows in game board
ncols	Number of columns in game board
x0	X coordinate for the center of the first cell
y0	Y coordinate for the center of the first cell
...	Should be left empty.
side	Either "face" or "back"
piece_side	If "board_face" a checkered board (as in American Checkers). If "board_back" a lined board (as in Turkish Checkers).
suit	Suit value (color) of board. 1L is "red", 2L is "black", 3L is "green", 4L is "blue", 5L is "yellow", and 6L is "white".
angle	Angle of board in degrees. Italian Checkers rotates its board 90 degrees compared to other checkers variants.
cell_width	Width of board cell. piecepackr::game_systems() supports 1 or 2. If NULL then don't set it yet.
x, y	Cartesian coordinates (numeric vectors)
length.out	The number of pieces. Not needed if all the arguments are the same length (or of length one) and this length is the same as the number of desired pieces.

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Setups for chess variants

Description

tibble data frames of setups for 5 chess variants. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

chess_chess(cell_width = 1)

chess_chess960(seed = NULL, cell_width = 1)

chess_fischer_random_chess(seed = NULL, cell_width = 1)

chess_horde_chess(..., cell_width = 1)

chess_international_chess(cell_width = 1)

chess_monochrome_chess(cell_width = 1)

chess_racing_kings(cell_width = 1)

Arguments

cell_width	Width of board cell. Most renderers support 1 or 2.
seed	Seed that determines setup, either an integer or NULL
...	Should be left empty.

Details

Here are links for more information about the various games:

Game	URL
(International) Chess	https://en.wikipedia.org/wiki/Chess
Fischer Random Chess AKA Chess960	https://www.chessvariants.com/diffsetup.dir/fischer.html
Horde Chess	https://lichess.org/variant/horde
Monochrome Chess	https://wunderland.com/WTS/Andy/Games/monochess.html
Racing Kings	https://www.chessvariants.com/diffobjective.dir/racing.html

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Generate chess boards and pieces

Description

chess_board() returns a square checkered board of desired size and type. chess_bits() returns chess pieces.

Usage

chess_board(
  nrows = 8L,
  ncols = nrows,
  x0 = 1,
  y0 = 1,
  ...,
  side = "face",
  piece_side = paste0("board_", side),
  suit = 3L,
  angle = 0,
  cell_width = 1
)

chess_bits(
  ...,
  suit = rep(1:6, each = 6L),
  rank = rep(1:6, 6L),
  x = rep(1:6, 6L),
  y = rep(1:6, each = 6L),
  angle = 0,
  cell_width = 1,
  length.out = NA_integer_
)

Arguments

nrows	Number of rows in game board
ncols	Number of columns in game board
x0	X coordinate for the center of the first cell
y0	Y coordinate for the center of the first cell
...	Should be left empty.
side	Either "face" or "back"
piece_side	If "board_face" a checkered board (as in American Checkers). If "board_back" a lined board (as in Turkish Checkers).
suit	Suit value (color) of board. 2L is "black" and 3L is "green".
angle	Angle of board in degrees. Italian Checkers rotates its board 90 degrees compared to other checkers variants.
cell_width	Width of board cell. piecepackr::game_systems() supports 1 or 2.
rank	Integer vector with values between 1L and 6L.
x, y	Cartesian coordinates (numeric vectors)
length.out	The number of pieces. Not needed if all the arguments are the same length (or of length one) and this length is the same as the number of desired pieces.

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Setups for dominoes variants

Description

tibble data frames of setups for 7 dominoes variants. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

domino_concentration(seed = NULL)

domino_finder(seed = NULL)

domino_runners(seed = NULL)

domino_fujisan(seed = NULL)

domino_luzon(seed = NULL)

domino_patience(seed = NULL)

domino_the_jubilee(seed = NULL)

Arguments

seed	Seed that determines setup, either an integer or NULL

Details

Here are links for more information about the various games:

Game	URL
Concentration	http://www.domino-play.com/Games/Concentration.htm
Domino Finder	https://donkirkby.github.io/donimoes/rules.html#domino-finder
Domino Runners	https://donkirkby.github.io/donimoes/rules.html#domino-runners
(Domino) Fuji-san	http://donkirkby.github.io/donimoes/rules.html#fujisan
Luzon	http://www.domino-play.com/Games/Luzon.htm
(Domino) Patience	http://www.domino-play.com/Games/Patience.htm
The Jubilee	http://www.domino-play.com/Games/Jubilee.htm

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Generate dominoes tiles

Description

domino_tiles() generates a data frame of dominoes tiles. By default will generate all the dominoes tiles of a double-6 set.

Usage

domino_tiles(
  n = 7,
  ...,
  side = "face",
  piece_side = paste0("tile_", side),
  suit = sequence(n:1, from = 1:n),
  rank = rep.int(1:n, n:1),
  cfg = "dominoes",
  x = sequence(n:1, from = 1:n),
  y = 2 * rep.int(n:1, n:1) - 0.5,
  angle = 0
)

Arguments

n	The number of doubles in a set e.g. n = 7 for double-6 set, n = 10 for a double-9 set, n = 13 for a double-12 set.
...	Should be left empty.
side	Either "face" or "back".
piece_side	Either "tile_face" or "tile_back".
suit	"Bottom" half of domino.
rank	"Top" half of domino.
cfg	"dominoes" or perhaps "dominoes_black", "dominoes_blue", "dominoes_green", "dominoes_red", "dominoes_white", or "dominoes_yellow".
x, y	Cartesian coordinates (numeric vectors)
angle	Rotation of dominoes (numeric vector of degrees, counter-clockwise)

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

Examples

df_double6 <- domino_tiles()
nrow(df_double6)
df_double9 <- domino_tiles(n = 10)
nrow(df_double9)
df_double12 <- domino_tiles(n = 13)
nrow(df_double12)
df_double15 <- domino_tiles(n = 16)
nrow(df_double15)

---

Data frames with game info

Description

chess_games(), domino_games(), checkers_games(), piecepack_games(), and stackpack_games() contain information about the games whose setups are provided by this package.

Usage

alquerque_games()

chess_games()

checkers_games()

domino_games()

piecepack_games()

stackpack_games()

Value

A tibble::tibble() data frame with character columns "game", "methods", "comment", and "url" for game name, setup function name(s), possible comment, and url for more information.

Examples

head(piecepack_games())
# Number of games for each game system
nrow(alquerque_games())
nrow(chess_games())
nrow(checkers_games())
nrow(domino_games())
nrow(piecepack_games())
nrow(stackpack_games())

---

Generate marbles boards and pieces

Description

marble_board() returns a square holed board of desired size and color. marble_bits() returns marble pieces.

Usage

marble_board(
  nrows = 4L,
  ncols = nrows,
  x0 = 1 * scale_factor,
  y0 = 1 * scale_factor,
  ...,
  suit = 4L,
  scale_factor = 0.5
)

marble_bits(
  ...,
  suit = 1:6,
  rank = 9L,
  x = as.double(1:6),
  y = 1,
  angle = 0,
  length.out = NA_integer_
)

Arguments

nrows	Number of rows in game board (i.e. number of holes vertically)
ncols	Number of columns in game board (i.e. number of holes horizontally)
x0	X coordinate for the center of the first hole
y0	Y coordinate for the center of the first hole
...	Should be left empty.
suit	Suit value (color) of board. 1L is "red", 2L is "black", 3L is "green", 4L is "blue", 5L is "yellow", and 6L is "white".
scale_factor	Used by {ppn}. Should usually be 0.5 for square pyramidal games but could be 1 if not playing a pyramidal game.
rank	Determines the size of the marble from 0.5 inch diameter (rank 1) to 1.0 inch diamter (rank 9). The default is 1.0 inch diameter marbles which match the holed boards.
x, y	Cartesian coordinates (numeric vectors)
angle	Rotation of piece (numeric vector of degrees, counter-clockwise)
length.out	The number of pieces. Not needed if all the arguments are the same length (or of length one) and this length is the same as the number of desired pieces.

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

Examples

dfb <- marble_board(nrows = 2L, scale_factor = 1.0)
dfm <- marble_bits(x = c(1:2, 1:2, 1.5),
                   y = c(1, 1, 2, 2, 1.5),
                   suit = c(1:3, 5:6))
df <- rbind(dfb, dfm)
if (require("piecepackr", quietly = TRUE) &&
    packageVersion("piecepackr") >= "1.15.0-1") {
  grid::grid.newpage()
  envir = game_systems()
  pmap_piece(df, envir = envir, default.units = "in")
}

---

Normalize name(s)

Description

normalize_name() normalizes (game) name(s).

Usage

normalize_name(x, sep = "_")

Arguments

x	Name to normalize.
sep	Separator character.

Details

⁠normalize_name(x, sep = "_") is used to help create R variable names while ⁠normalize_name(x, sep = "-")' is used to help create filenames and LaTeX labels.

Value

Character vector of normalized names.

Examples

normalize_name("Fuji-san")
  normalize_name("Nine Men's Morris", sep = "-")

---

Setup various game boards using piecepack tiles

Description

piecepack_rectangular_board() returns a tibble data frame of a rectangular board of desired size made using a maximum number of piecepack tiles. It will use either “cells”, “points”, and/or “rivers” as necessary. piecepack_donut_board() returns 24 tiles arranged 5x5 with hole in middle.

Usage

piecepack_donut_board(
  ...,
  side = "back",
  piece_side = paste0("tile_", side),
  suit = rep(1:4, each = 6L),
  rank = rep.int(1:6, 4L),
  cfg = "piecepack",
  x0 = 1,
  y0 = 1,
  angle = 0
)

piecepack_rectangular_board(
  nrows = 8L,
  ncols = 8L,
  x0 = 1,
  y0 = 1,
  ...,
  max_tiles = 24L,
  suit = rep.int(1:4, 6L),
  rank = rep(1:6, each = 4L),
  cfg = "piecepack"
)

Arguments

...	Should be left empty.
side	Either "face" or "back".
piece_side	Either "tile_face" or "tile_back".
suit	Vector of suit values to use for tile back (will be repeated).
rank	Vector of rank values to use for tile back (will be repeated).
cfg	"piecepack" or perhaps "playing_cards_expansion", "dual_piecepacks_expansion", or "subpack".
x0	X coordinate for the center of the first cell/point for piecepack_rectangular_board(). X coordinate for center of bottom-left tile for piecepack_donut_board().
y0	Y coordinate for the center of the first cell/point for piecepack_rectangular_board(). Y coordinate for center of bottom-left tile for piecepack_donut_board().
angle	Rotation of piece (numeric vector of degrees, counter-clockwise)
nrows	Number of rows in game board
ncols	Number of columns in game board
max_tiles	Maximum number of tiles that can be used

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Setups for checkers variants playable with a piecepack

Description

tibble data frames of setups for 12 checkers variants playable with a piecepack. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

piecepack_american_checkers()

piecepack_american_pool_checkers()

piecepack_checkers()

piecepack_brazilian_checkers()

piecepack_czech_checkers()

piecepack_english_checkers()

piecepack_gothic_checkers()

piecepack_italian_checkers()

piecepack_jamaican_checkers()

piecepack_portuguese_checkers()

piecepack_russian_checkers()

piecepack_spanish_checkers()

piecepack_thai_checkers()

piecepack_turkish_checkers()

Details

Here are links for more information about the various checkers variants:

Game	URL
(American) Checkers AKA (English) Draughts	https://www.ludism.org/ppwiki/Checkers
American Pool Checkers	https://draughts.github.io/american-pool-checkers.html
Brazilian Checkers AKA Brazilian Draughts	https://en.wikipedia.org/wiki/Brazilian_draughts
Czech Checkers AKA Czech Draughts	https://en.wikipedia.org/wiki/Czech_draughts
Gothic Checkers AKA Gothic Draughts	http://mlwi.magix.net/bg/gothiccheckersvariants.htm
Italian Checkers AKA Italian Draughts	https://en.wikipedia.org/wiki/Italian_draughts
Jamaican Checkers AKA Jamaican Draughts	https://web.archive.org/web/20230605023244/http://poolcheckers.com/jamaica/
Portuguese Checkers AKA Portuguese Draughts	http://www.fpdamas.pt/regras/
Russian Checkers AKA Russian Draughts	https://en.wikipedia.org/wiki/Russian_draughts
Spanish Checkers AKA Spanish Draughts	https://mindsports.nl/index.php/on-the-evolution-of-draughts-variants/draughts-variants/497-dama_s
Thai Checkers AKA Thai Draughts AKA Mak-hot AKA Makhos	https://checkers.fandom.com/wiki/Mak-hot
Turkish Checkers AKA Turkish Draughts AKA Dama	https://en.wikipedia.org/wiki/Turkish_draughts

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Setups for chess variants playable with a piecepack

Description

tibble data frames of setups for 10 chess variants playable with a piecepack. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

piecepack_alice_chess(has_subpack = FALSE, max_tiles = 24L)

piecepack_baroque_chess(has_subpack = FALSE)

piecepack_chaturaji(has_subpack = FALSE)

piecepack_chess(has_subpack = FALSE)

piecepack_chess960(..., seed = NULL, has_subpack = FALSE)

piecepack_fischer_random_chess(..., seed = NULL, has_subpack = FALSE)

piecepack_chinese_chess(has_subpack = FALSE)

piecepack_four_seasons_chess(has_subpack = FALSE)

piecepack_international_chess(has_subpack = FALSE)

piecepack_japanese_chess(has_subpack = FALSE, cfg2 = "piecepack")

piecepack_minishogi()

piecepack_racing_kings()

piecepack_shogi(has_subpack = FALSE, cfg2 = "piecepack")

piecepack_ultima(has_subpack = FALSE)

piecepack_xiangqi(has_subpack = FALSE)

Arguments

has_subpack	Has a piecepack subpack
max_tiles	Maximum number of (piecepack) tiles available to build boards
...	Should be left empty.
seed	Seed that determines setup, either an integer or NULL
cfg2	A string of a piecepack expansion (or perhaps "piecepack" for a second piecepack)

Details

Here are links for more information about the various chess variants:

Game	URL
Alice Chess	https://en.wikipedia.org/wiki/Alice_chess
Chaturaji	https://www.ludism.org/ppwiki/Chaturaji
Fischer Random Chess AKA Chess960	https://www.chessvariants.com/diffsetup.dir/fischer.html
Four Seasons Chess	https://www.chessvariants.com/historic.dir/4seiz.html
(International) Chess	https://www.ludism.org/ppwiki/Chess
Minishogi	https://en.wikipedia.org/wiki/Minishogi
Racing Kings	https://www.chessvariants.com/diffobjective.dir/racing.html
Shogi AKA Japanese Chess	https://www.ludism.org/ppwiki/Shogi
Ultima AKA Baroque Chess	https://en.wikipedia.org/wiki/Baroque_chess
Xiangqi AKA Chinese Chess	https://www.ludism.org/ppwiki/Xiangqi

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Setups for various original piecepack games

Description

tibble data frames of setups for 52 games playable with a piecepack. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

piecepack_alien_city(seed = NULL, tiles = NULL)

piecepack_black_pawn_trucking(seed = NULL)

piecepack_brain_burn(seed = NULL)

piecepack_burbuja(seed = NULL, tiles = NULL)

piecepack_cardinals_guards(seed = NULL, tiles = NULL)

piecepack_cell_management(seed = NULL)

piecepack_chariots()

piecepack_chinese_checkers()

piecepack_halma()

piecepack_coin_collectors(seed = NULL, tiles = NULL, coins = NULL, dice = NULL)

piecepack_climbing_man(seed = NULL, variant = c("Basic", "Free"))

piecepack_crocodile_hop(seed = NULL)

piecepack_desfases(seed = NULL, tiles = NULL, dice = NULL)

piecepack_dominoids(..., seed = NULL)

piecepack_easy_slider(seed = NULL, tiles = NULL, coins = NULL, pawns = NULL)

piecepack_everest()

piecepack_four_blind_mice()

piecepack_froggy_bottom()

piecepack_fujisan(seed = NULL, coins = NULL, dice = NULL)

piecepack_galaxy_express(seed = NULL)

piecepack_iceberg(seed = NULL, tiles = NULL)

piecepack_ice_floe()

piecepack_japan(seed = NULL)

piecepack_klondike(seed = NULL)

piecepack_lab_rats(seed = NULL)

piecepack_landlocked(seed = NULL)

piecepack_ley_lines()

piecepack_mathrix(seed = NULL, coins = NULL)

piecepack_pawns_crossing(..., seed = NULL, n_players = 2L)

piecepack_piecepackman(seed = NULL, variant = "Roundabout")

piecepack_one_man_thrag(seed = NULL)

piecepack_pass_the_food()

piecepack_piece_gaps(seed = NULL)

piecepack_piece_packing_pirates(seed = NULL)

piecepack_plans_of_action(seed = NULL, coins = NULL)

piecepack_relativity(seed = NULL, coins = NULL)

piecepack_san_andreas()

piecepack_sarcophagus(seed = NULL)

piecepack_ship_it(..., seed = NULL)

piecepack_shopping_mall(seed = NULL, cfg2 = "go")

piecepack_skyscrapers(seed = NULL, tiles = NULL)

piecepack_slides_of_action()

piecepack_speedy_towers(n_players = 2, seed = NULL)

piecepack_steppin_stones(seed = NULL)

piecepack_the_in_crowd()

piecepack_the_magic_bag(seed = NULL)

piecepack_the_penguin_game(seed = NULL)

piecepack_tower_of_babel(seed = NULL, tiles = NULL)

piecepack_accordion(seed = NULL, tiles = NULL)

piecepack_tracers()

piecepack_triactor(seed = NULL, cfg2 = "playing_cards_expansion")

piecepack_tula(
  seed = NULL,
  tiles = NULL,
  variant = c("Original", "Variant 1", "Variant 2", "Variant 3", "Variant 4")
)

piecepack_wormholes()

Arguments

seed	Seed that determines setup, either an integer or NULL
tiles	String of tile layout
coins	String of coin layout
dice	String of dice layout
variant	Name of variant
...	Should be left empty.
pawns	String of pawns layout
n_players	Number of players
cfg2	A string of a piecepack expansion (or perhaps "piecepack" for a second piecepack)

Details

Here are links for more information about the various games:

Game	URL
Alien City	https://www.ludism.org/ppwiki/AlienCity
Black Pawn Trucking	https://www.ludism.org/ppwiki/BlackPawnTrucking
Brain Burn	https://www.ludism.org/ppwiki/BrainBurn
Burbuja	https://www.ludism.org/ppwiki/Burbuja
Cardinal's Guards	https://ludism.org/ppwiki/CardinalsGuards
Cell Management	https://www.ludism.org/ppwiki/CellManagement
Chariots	https://www.ludism.org/ppwiki/Chariots
Chinese Checkers AKA (Piecepack) Halma	https://www.ludism.org/ppwiki/ChineseCheckers
Climbing Man	https://www.ludism.org/ppwiki/ClimbingMan
Coin Collectors	https://www.ludism.org/ppwiki/CoinCollectors
Crocodile Hop	https://www.ludism.org/ppwiki/CrocodileHop
Desfases	https://www.ludism.org/ppwiki/Desfases
Dominoids	https://ludism.org/ppwiki/Dominoids
Easy Slider	https://www.ludism.org/ppwiki/EasySlider
Everest	https://www.ludism.org/ppwiki/Everest
Four Blind Mice	https://www.ludism.org/ppwiki/FourBlindMice
Froggy Bottom	https://www.ludism.org/ppwiki/FroggyBottom
Fuji-san	https://www.ludism.org/ppwiki/Fuji-san
Galaxy Express	https://www.ludism.org/ppwiki/GalaxyExpress
Ice Floe	https://www.ludism.org/ppwiki/IceFloe
Iceberg	https://www.ludism.org/ppwiki/Iceberg
Japan	https://www.ludism.org/ppwiki/Japan
Lab Rats	https://www.ludism.org/ppwiki/LabRats
Landlocked	https://www.ludism.org/ppwiki/Landlocked
Ley Lines	https://www.ludism.org/ppwiki/LeyLines
Mathrix	https://www.ludism.org/ppwiki/Mathrix
One Man Thrag!	https://www.ludism.org/ppwiki/OneManThrag
Pass the Food	https://www.ludism.org/ppwiki/PassTheFood
Pawns Crossing	https://ludism.org/ppwiki/PawnsCrossing
Piece Gaps	https://www.ludism.org/ppwiki/PieceGaps
Piece Packing Pirates	https://www.ludism.org/ppwiki/PiecePackingPirates
(Piecepack) Klondike	https://ludism.org/ppwiki/PiecepackKlondike
Piecepackman	https://www.ludism.org/ppwiki/Piecepackman
Plans of Action	https://www.ludism.org/ppwiki/PlansOfAction
Relativity	https://www.ludism.org/ppwiki/Relativity
San Andreas	https://www.ludism.org/ppwiki/SanAndreas
Sarcophagus	https://www.ludism.org/ppwiki/Sarcophagus
Ship It!	https://ludism.org/ppwiki/Ship_It
Shopping Mall	https://www.ludism.org/ppwiki/ShoppingMall
Skyscrapers	https://www.ludism.org/ppwiki/Skyscrapers
Slides of Action	https://www.ludism.org/ppwiki/SlidesOfAction
Speedy Towers	https://ludism.org/ppwiki/SpeedyTowers
Steppin' Stones	https://ludism.org/ppwiki/Steppin'_Stones
The "In" Crowd	https://www.ludism.org/ppwiki/TheInCrowd
The Magic Bag	https://www.ludism.org/ppwiki/The_Magic_Bag
The Penguin Game	https://www.ludism.org/ppwiki/PenguinGame
Tower of Babel AKA (Piecepack) Accordion	https://www.ludism.org/ppwiki/TowerOfBabel
Tracers	https://www.ludism.org/ppwiki/Tracers
Triactor	https://www.ludism.org/ppwiki/Triactor
Tula	https://www.ludism.org/ppwiki/Tula
Twelve Men's Morris	https://en.wikipedia.org/wiki/Morabaraba
Wormholes	https://www.ludism.org/ppwiki/Wormholes

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Setups for other modern games playable with a piecepack

Description

tibble data frames of setups for 10 other games playable with a piecepack. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

piecepack_12345ive()

piecepack_breakthrough()

piecepack_change_change(seed = NULL, coins = NULL)

piecepack_crossings()

piecepack_dao()

piecepack_evade()

piecepack_grasshopper()

piecepack_lines_of_action()

piecepack_lukawan()

piecepack_quatri()

Arguments

seed	Seed that determines setup, either an integer or NULL
coins	String of coin layout

Details

Here are links for more information about the various other games:

Game	URL
12345ive!	https://boardgamegeek.com/boardgame/154644/12345ive
Breakthrough	https://en.wikipedia.org/wiki/Breakthrough_(board_game)
Crossings	https://en.wikipedia.org/wiki/Crossings_(game)
Change Change	https://www.ludism.org/ppwiki/ChangeChange
Dao	https://boardgamegeek.com/boardgame/948/dao
Grasshopper	http://www.cyningstan.com/game/71/grasshopper
Evade	https://www.ludism.org/ppwiki/Evade
Lines of Action	https://en.wikipedia.org/wiki/Lines_of_Action
Lukawan	https://ludism.org/ppwiki/Lukawan
Quatri	https://www.ludism.org/ppwiki/Quatri

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Setups for other traditional games playable with a piecepack

Description

tibble data frames of setups for 12 other traditional games playable with a piecepack. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

piecepack_alquerque(has_matchsticks = FALSE)

piecepack_awithlaknannai_mosona(has_matchsticks = FALSE)

piecepack_backgammon()

piecepack_baghchal(has_matchsticks = FALSE)

piecepack_brandubh()

piecepack_cribbage()

piecepack_cribbage_board()

piecepack_four_field_kono()

piecepack_julgonu()

piecepack_ludo()

piecepack_nine_mens_morris(has_matchsticks = FALSE)

piecepack_salta(has_subpack = FALSE)

piecepack_tablut(die_width = 0.63)

piecepack_twelve_mens_morris(has_matchsticks = FALSE)

Arguments

has_matchsticks	Has matchsticks
has_subpack	Has a piecepack subpack
die_width	Width of dice

Details

Here are links for more information about the various other traditional games:

Game	URL
Alquerque AKA Qirkat	https://en.wikipedia.org/wiki/Alquerque
Awithlaknannai Mosona	https://en.wikipedia.org/wiki/Awithlaknannai_Mosona
Backgammon	https://www.ludism.org/ppwiki/Backgammon
Bagh-chal	https://www.ludism.org/ppwiki/Bagh_Chal
Brandubh AKA Brandub	http://www.cyningstan.com/game/125/brandub
Cribbage	https://www.ludism.org/ppwiki/Cribbage
Four Field Kono	https://www.ludism.org/ppwiki/FourFieldKono
Jul-Gonu	https://www.ludism.org/ppwiki/JulGonu
Ludo	https://en.wikipedia.org/wiki/Ludo_(board_game)
Nine Men's Morris	https://en.wikipedia.org/wiki/Nine_men%27s_morris
Salta	https://en.wikipedia.org/wiki/Salta_(game)
Tablut	https://www.ludism.org/ppwiki/Tablut

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Generate piecepack pieces

Description

piecepack_coins() generates a data frame of piecepack coins. piecepack_dice() generates a data frame of piecepack dice. piecepack_pawns() generates a data frame of piecepack pawns. piecepack_tiles() generates a data frame of piecepack tiles.

Usage

piecepack_coins(
  ...,
  side = "face",
  piece_side = paste0("coin_", side),
  suit = rep(1:4, each = 6L),
  rank = rep.int(1:6, 4L),
  cfg = "piecepack",
  x = as.double(rep.int(1:6, 4L)),
  y = as.double(rep(4:1, each = 6L)),
  angle = 0,
  length.out = NA_integer_
)

piecepack_dice(
  ...,
  suit = 1:4,
  rank = 1L,
  cfg = "piecepack",
  x = as.double(1:4),
  y = 1,
  angle = 0,
  length.out = NA_integer_
)

piecepack_matchsticks(
  ...,
  side = "face",
  piece_side = paste0("matchstick_", side),
  suit = rep(1:4, each = 6L),
  rank = rep.int(1:6, 4L),
  cfg = "piecepack",
  x = as.double(rep.int(1:6, 4L)),
  y = 3 * rep(4:1, each = 6L),
  angle = 0,
  length.out = NA_integer_
)

piecepack_pawns(
  ...,
  side = "face",
  piece_side = paste0("pawn_", side),
  suit = 1:4,
  cfg = "piecepack",
  x = as.double(1:4),
  y = 1,
  angle = 0,
  length.out = NA_integer_
)

piecepack_tiles(
  ...,
  side = "face",
  piece_side = paste0("tile_", side),
  suit = rep(1:4, each = 6L),
  rank = rep.int(1:6, 4L),
  cfg = "piecepack",
  x = 2 * rep.int(1:6, 4L),
  y = 2 * rep(4:1, each = 6L),
  angle = 0,
  length.out = NA_integer_
)

Arguments

...	Should be left empty.
side	Either "face" or "back".
piece_side	Either "tile_face" or "tile_back".
suit	Integer vector with values between 1L and 4L.
rank	Integer vector with values between 1L and 6L.
cfg	"piecepack" or perhaps "playing_cards_expansion", "dual_piecepacks_expansion", or "subpack".
x, y	Cartesian coordinates (numeric vectors)
angle	Rotation of piece (numeric vector of degrees, counter-clockwise)
length.out	The number of pieces. Not needed if all the arguments are the same length (or of length one) and this length is the same as the number of desired pieces.

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

Examples

df_coins <- piecepack_coins()
df_dice <- piecepack_dice()
df_pawns <- piecepack_pawns()
df_tiles <- piecepack_tiles()

---

Deprecated functions

Description

These functions are Deprecated in this release of ppdf, they will be marked as Defunct and removed in a future version.

Usage

checkers_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

chess_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

dominoes_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

dominoes_concentration(seed = NULL)

dominoes_domino_finder(seed = NULL)

dominoes_domino_runners(seed = NULL)

dominoes_fujisan(seed = NULL)

dominoes_luzon(seed = NULL)

dominoes_none()

dominoes_patience(seed = NULL)

dominoes_the_jubilee(seed = NULL)

dominoes_tiles(
  n = 7,
  ...,
  side = "face",
  piece_side = paste0("tile_", side),
  suit = sequence(n:1, from = 1:n),
  rank = rep.int(1:n, n:1),
  cfg = "dominoes",
  x = sequence(n:1, from = 1:n),
  y = 2 * rep.int(n:1, n:1) - 0.5,
  angle = 0
)

games_checkers()

games_chess()

games_dominoes()

games_piecepack()

games_stackpack()

piecepack_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

piecepack_piecepack_accordion(seed = NULL, tiles = NULL)

piecepack_piecepack_halma()

piecepack_piecepack_klondike(seed = NULL)

piecepack_rect_board_tiles(
  nrows = 8L,
  ncols = 8L,
  x0 = 1,
  y0 = 1,
  max_tiles = 24L,
  suit = rep.int(1:4, 6L),
  rank = rep(1:6, each = 4L)
)

stackpack_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

Arguments

name	Game name. Will be normalized by normalize_name().
...	Additional arguments to pass to the underlying setup function.
getter	Function with a single function name argument to use. By default will just look for functions in this package but a developer may want to consider dynGet() or a wrapper around get() with a custom envir argument.
seed	Seed that determines setup, either an integer or NULL
n	The number of doubles in a set e.g. n = 7 for double-6 set, n = 10 for a double-9 set, n = 13 for a double-12 set.
side	Either "face" or "back".
piece_side	Either "tile_face" or "tile_back".
suit	"Bottom" half of domino.
rank	"Top" half of domino.
cfg	"dominoes" or perhaps "dominoes_black", "dominoes_blue", "dominoes_green", "dominoes_red", "dominoes_white", or "dominoes_yellow".
x, y	Cartesian coordinates (numeric vectors)
angle	Rotation of dominoes (numeric vector of degrees, counter-clockwise)
tiles	String of tile layout
nrows	Number of rows in game board
ncols	Number of columns in game board
x0	X coordinate for the center of the first cell/point for piecepack_rectangular_board(). X coordinate for center of bottom-left tile for piecepack_donut_board().
y0	Y coordinate for the center of the first cell/point for piecepack_rectangular_board(). Y coordinate for center of bottom-left tile for piecepack_donut_board().
max_tiles	Maximum number of tiles that can be used

Details

Deprecated function	Replacement function
checkers_by_name()	checkers_setup_by_name()
chess_by_name()	chess_setup_by_name()
dominoes_by_name()	domino_setup_by_name()
dominoes_concentration()	domino_concentration()
dominoes_domino_finder()	domino_finder()
dominoes_domino_runners()	domino_runners()
dominoes_fujisan()	domino_fujisan()
dominoes_luzon()	domino_luzon()
dominoes_none()	domino_none()
dominoes_patience()	domino_patience()
dominoes_the_jubilee()	domino_the_jubilee()
dominoes_tiles()	domino_tiles()
games_checkers()	checkers_games()
games_chess()	chess_games()
games_dominoes()	domino_games()
games_piecepack()	piecepack_games()
games_stackpack()	stackpack_games()
piecepack_by_name()	piecepack_setup_by_name()
piecepack_piecepack_accordion()	piecepack_accordion()
piecepack_piecepack_halma()	piecepack_halma()
piecepack_piecepack_klondike()	piecepack_klondike()
piecepack_rect_board_tiles()	piecepack_rectangular_board()
stackpack_by_name()	stackpack_setup_by_name()

---

Setups by game name

Description

setup_by_name() returns setup data frames by game name and game system. alquerque_setup_by_name(), checkers_setup_by_name(), chess_setup_by_name(), dominoes_setup_by_name(), marble_setup_by_name(), piecepack_setup_by_name() and stackpack_setup_by_name() are aliases that set the game system.

Usage

setup_by_name(
  name,
  system = known_game_systems,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

alquerque_setup_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

checkers_setup_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

chess_setup_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

domino_setup_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

marble_setup_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

piecepack_setup_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

stackpack_setup_by_name(
  name,
  ...,
  getter = function(x) get(x, envir = getNamespace("ppdf"))
)

Arguments

name	Game name. Will be normalized by normalize_name().
system	Game system.
...	Additional arguments to pass to the underlying setup function.
getter	Function with a single function name argument to use. By default will just look for functions in this package but a developer may want to consider dynGet() or a wrapper around get() with a custom envir argument.

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---

Zero-row data frames

Description

alquerque_none(), checkers_none(), chess_none(), dominoes_none(), marbles_none(), piecepack_none(), and stackpack_none() return zero-row data frames.

Usage

alquerque_none()

checkers_none()

chess_none()

domino_none()

marbles_none()

piecepack_none()

stackpack_none()

Value

A data frame with zero rows.

Examples

checkers_none()

---

Setups for games playable with a piecepack stackpack

Description

tibble data frames of setups for 10 other games playable with a piecepack stackpack. Data frame output can usually be plotted with pmap_piece(df, default.units = "in").

Usage

stackpack_alice_chess(max_tiles = 24L)

stackpack_baroque_chess()

stackpack_chaturaji()

stackpack_chess()

stackpack_chess960(..., seed = NULL)

stackpack_fischer_random_chess(..., seed = NULL, has_subpack = FALSE)

stackpack_chinese_chess()

stackpack_four_seasons_chess()

stackpack_horde_chess()

stackpack_international_chess()

stackpack_japanese_chess()

stackpack_salta()

stackpack_shogi()

stackpack_ultima()

stackpack_xiangqi()

Arguments

max_tiles	Maximum number of (piecepack) tiles available to build boards
...	Should be left empty.
seed	Seed that determines setup, either an integer or NULL
has_subpack	Has a piecepack subpack

Details

Here are links for more information about the games:

Game	URL
Alice Chess	https://en.wikipedia.org/wiki/Alice_chess
Chaturaji	https://www.ludism.org/ppwiki/Chaturaji
Fischer Random Chess AKA Chess960	https://www.chessvariants.com/diffsetup.dir/fischer.html
Four Seasons Chess	https://www.chessvariants.com/historic.dir/4seiz.html
Horde Chess	https://lichess.org/variant/horde
(International) Chess	https://www.ludism.org/ppwiki/Chess
Salta	https://en.wikipedia.org/wiki/Salta_(game)
Shogi aka Japanese Chess	https://www.ludism.org/ppwiki/Shogi
Ultima aka Baroque Chess	https://en.wikipedia.org/wiki/Baroque_chess
Xiangqi AKA Chinese Chess	https://www.ludism.org/ppwiki/Xiangqi

Value

A tibble::tibble() data frame with the following columns:

• "piece_side"

• "suit"

• "rank"

• "cfg" (optional, defaults to "piecepack")

• "x"

• "y"

• "angle" (optional, defaults to 0).

This data frame is compatible with piecepackr::render_piece() and likely ppcli::cat_piece().

---