README.md

americanRoulette - R Shiny Implementation

americanRoulette is a R Shiny implementation of the American Roulette, the popular casino game. The loaded and running applet can be tried at ignatkulinka.shinyapps.io/AmericanRoulette/.

Quick Start

To download and launch americanRoulette you need to download and install devtools as well as the application itself. To do that use the R Studio console and type in the following code:

install.packages("devtools")    # install devtools
devtools::install_github("ignatkulinka/americanRoulette")    #install americanRoulette
library(americanRoulette)    # import the americanRoulette app
americanRoulette::launch()    # launch the app!

Package Requirements

americanRoulette uses functions/methods from packages DT, shiny, ggplot2 and stringr. These can be installed using the following line:

install.packages("PACKAGE NAME HERE")

App Mechanics

NEW: Multiple sessions are now allowed! Join others playing on the hosted app or run multiple sessions on your machine/local server. On your local server/machine open multiple windows in your web browser or use R Studio built-in browser as one of the sessions.

americanRoulette is divided into parts by tabs on the left and right sides of the screen.

The left hand side tabs:

left hand side tabs

Betting

^Placing $250 on Black     ^Placing ten random bets

Summary

Provides a list overview of the bets that a user has placed. The bets are divided into two tables: Manual and CPU bets. The Reset button allows for the user to clear the table of any bets. In addition, this tab has the spin the roulette button. This button will generate a random winning slot and output it. Lastly, the Results table will show the user which of the bets won and lost.

^spin the roulette and reset buttons

The right hand side tabs:

right hand side tabs

Roulette Table

This tab outputs a simulation of the American roulette table. This plot can be clicked to place bets. The clickable spots follow the general official rules for betting. Bets can be stacked on top of each other by clicking them again.

Summary Plots

NEW: Better plots have been added and the old ones have been overhauled.

This tab provides a useful insight into the statistics behind the current game session. Monitor the amount of money won/lost, number of bets won, frequency of winning slots and many more.

Data Output

Warning: Data download option only functions when the app is open in web browser. At the moment, downloading data from the built-in R Studio browser is not possible.

This tab shows the running list of all the possibly useful data that is being generated by the simulation. By clicking this tab, the user can take a quick look at the data or click the Download button to download a .csv copy of the table.

^download the data button

Future Updates

Currently, the plan is to continue developing a variety of multi-user functionalities. Additions such as a group chat/log, as well as allowing users to choose a personal chip color are coming. Ideally, a complete multiplayer update would also include methods to have active players democratically vote on ending a round of betting and spinning the roulette wheel.



ignatkulinka/americanRoulette documentation built on Dec. 30, 2020, 2:42 p.m.