Put in a package

DESCRIPTION

@@ -0,0 +1,11 @@
+Package: pacman
+Version: 1.0.0
+Depends:
+  nara,
+  eventloop,
+  audio,
+  grid
+Remotes:
+  coolbutuseless/nara,
+  coolbutuseless/eventloop
+RoxygenNote: 7.2.0

NAMESPACE

@@ -0,0 +1,4 @@
+# Generated by roxygen2: do not edit by hand
+
+export(play)
+import(nara)

board.R → R/board.R

@@ -88,7 +88,7 @@ board <- matrix(board, nrow = 31, ncol = 28, byrow = TRUE)
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 #' Load the maze parts
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-im <- suppressWarnings(png::readPNG("image/game-maze.png"))
+im <- suppressWarnings(png::readPNG(system.file("image/game-maze.png", package = "pacman")))
 if (FALSE) {
   dim(im)
   grid.raster(im)

game.R → R/game.R

@@ -1,18 +1,3 @@
-
-
-if (FALSE) {
-  remotes::install_github('coolbutuseless/eventloop')
-  remotes::install_github('coolbutuseless/nara')
-}
-
-library(grid)
-library(nara)
-library(eventloop)
-
-source("board.R")
-source("sprites.R")
-source("sound.R")
-
 # set.seed(1)
 
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -274,7 +259,7 @@ update_game <- function(event, frame_num, ...) {
     }
 
     # Render to screen
-    grid.raster(board_nr)
+    grid::grid.raster(board_nr)
   }
 
   #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -310,12 +295,10 @@ update_game <- function(event, frame_num, ...) {
 
 
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-# Run the game within an event loop
+#' Run the game within an event loop
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-eventloop::run_loop(update_game, width = 7, height = 8, fps_target = 50)
-
-
-
-
-
-
+#' @import nara
+#' @export
+play <- function() {
+  eventloop::run_loop(update_game, width = 7, height = 8, fps_target = 50)
+}

R/sound.R

@@ -0,0 +1,19 @@
+
+library(audio)
+
+
+# Tweak the audio to be compatible with the audio package
+# sox -r 8000 -b 8 -e signed-integer -c 1 %s -b 16 %s
+# sox %s -b 16 %s
+
+sound <- list(
+  intro = audio::load.wave(system.file("./sound/intro.wav", package = "pacman")),
+  chomp = audio::load.wave(system.file("./sound/chomp.wav", package = "pacman")),
+  death = audio::load.wave(system.file("./sound/death.wav", package = "pacman")),
+  ghost = audio::load.wave(system.file("./sound/ghost.wav", package = "pacman")),
+  extra = audio::load.wave(system.file("./sound/extra.wav", package = "pacman")),
+  fruit = audio::load.wave(system.file("./sound/fruit.wav", package = "pacman")),
+  inter = audio::load.wave(system.file("./sound/inter.wav", package = "pacman"))
+)
+
+# audio::play(sound$inter)

sprites.R → R/sprites.R

@@ -6,7 +6,7 @@ library(nara)
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 # Load the spritemap for pacman and the ghosts
 #~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-spritemap <- png::readPNG("image/game-sprites.png")
+spritemap <- png::readPNG(system.file("image/game-sprites.png", package = "pacman"))
 
 if (FALSE) {
   dim(spritemap)

README.md

@@ -14,7 +14,7 @@ The game plays in realtime using 2 key packages:
 
 ## Gameplay  
 
-<img src="video/pacman-game.gif" />
+<img src="inst/video/pacman-game.gif" />
 
 ## Controls
 
@@ -34,33 +34,11 @@ your 5 pacman lives.
 
 ## Installation
 
-1. Install the dependencies
-    * [`{nara}`](https://github.com/coolbutuseless/nara)
-    * [`{eventloop}`](https://github.com/coolbutuseless/eventloop)
-2. Retrieve the pacman game code from [github](https://github.com/coolbutless/pacman)
-    * Note that this is *not* a package, but just a collection of R scripts and
-      code.  This should make it easier to hack on, extend and adapt.
-
+1. `remotes::install_github("coolbutuseless/pacman")`
 
+```{r}
+pacman::play()
 ```
-library(remotes)
-
-# Packages required for interactive rendering
-remotes::install_github("coolbutuseless/eventloop")
-remotes::install_github("coolbutuseless/nara")
-
-install.packages('audio')
-
-# Grab a copy of the pacman game code by cloning the repository
-system("git clone https://github.com/coolbutuseless/pacman.git")
-
-
-
-# Change into the source code directory and run
-setwd('pacman')
-source('game.R')
-```
-
 
 ## Requirements