Skip to contents

gameR provides a collection of R color palettes inspired by video games.

Note: these color palettes may not be color blind friendly. If accessibility is a priority, I recommend either using the virdis package or checking your plots before sharing using tools which simulate color blindness such as coblis

Table of Contents

Installation

gameR is on CRAN! Install the stable version of gameR with:

You can install the development version of gameR, which may contain additional palettes, from r-universe with:

# Enable universe(s) by nathansam
options(repos = c(
  nathansam = 'https://nathansam.r-universe.dev',
  CRAN = 'https://cloud.r-project.org'))

install.packages('gameR')

Getting started

gameR provides either discrete color palettes or continuous palettes generated by interpolating a discrete palette. Discrete palettes and continuous palettes are provided via the gameR_cols() and gameR_cont() functions respectively with the name of the palette passed as an argument. For a full list of the palettes provided by gameR, call one of these functions without any arguments.

gameR_cols()
#>  [1] "blocks"    "border"    "cowboy"    "cups"      "cyberpunk" "fallout"  
#>  [7] "gris"      "ocarina"   "p4g"       "pman"      "rayman"    "sonic"    
#> [13] "spirit"    "splat"     "superbros" "wow"

Palettes

This section presents a list of the palettes provided by gameR ordered alphabetically by the name of the game which inspired the palette.

Borderlands

gameR_cols("border")

Cuphead

gameR_cols("cups")

Cyberpunk

gameR_cols("cyberpunk")

Fallout

gameR_cols("fallout")

Gris

gameR_cols("gris")

Legend of Zelda: Ocarina of Time

gameR_cols("ocarina")

Pac-Man

gameR_cols("pman")

Persona 4 Golden

gameR_cols("p4g")

Rayman

gameR_cols("rayman")

Red Dead Redemption II

gameR_cols("cowboy")

Sonic the Hedgehog

gameR_cols("sonic")

Spiritfarer

gameR_cols("spirit")

Splatoon

gameR_cols("splat")

Super Mario Bros

gameR_cols("superbros")

Tetris

gameR_cols("blocks")

World of Warcraft

gameR_cols("wow")

Contributing new palettes

Contributions via pull requests are welcome! I would love to have as many video games represented as possible. With that said, there are two requirements I ask of any contributed palettes:

  1. The palette must be at least somewhat distinctive. There are many popular and beloved games, but if the palette suggestion does not evoke the video game that inspired it, it probably should not be contributed.
  2. Please avoid trademarked names for palette names. I am not entirely sure how far the CRAN policy extends when it comes to trademarked names but I would rather not risk running afoul of CRAN policy.

Adding a New Palette to the gameR Palette List

Adding a new palette is as simple adding a new element to the gameR_colors list in R/palettes.R, and calling devtools::document() from R to update the package documentation.

Updating the README

The README is generated by README.Rmd. Please update this file with the palettes you are contributing (the palettes are in alphabetical order) and knit the file before committing and pushing your contributions.

Credit

If you are contributing palette(s), I would love for your contribution to be recognized. Please feel free to add yourself as a contributor (role = “ctb”) in the DESCRIPTION file.