R/wurstmineR-package.r

#' Throw R at Minecraft. See what sticks.
#' 
#' wurstmineR is a package that grew out of
#' \href{http://github.com/wurstmineberg/wurstminestats}{wurstminestats}, a
#' project of the \href{http://wurstmineberg.de}{Wurstmineberg} Minecraft
#' server. It utilizes Farthen's Minecraft API, which you can find
#' \href{http://github.com/wurstmineberg/api.wurstmineberg.de#data-sources}{on Github}, and
#' is \href{http://blog.farthen.de/a-vanilla-minecraft-server-api/}{described
#' here}. The prerequisites are extensive and the actual usecase is
#' \emph{very} specialized, since it is only useful to people who
#' \enumerate{
#' \item Are involved with a vanilla Minecraft server
#' \item Use the API
#' \item Are interested in working with said API's data
#' \item Intend to do so with R
#' }
#' Relevant data sources are documented in the 
#' \href{http://github.com/wurstmineberg/wurstminestats}{wurstminestats Readme} for now, 
#' but will sooner or later be documented here.
#' 
#' None of this would be possible without \href{https://twitter.com/Farthen}{Farthen's} 
#' work on the API and \href{https://twitter.com/Fenhl}{Fenhl's} 
#' expansions on the API and his helpful descriptive JSON files located 
#' at \href{http://github.com/wurstmineberg/assets.wurstmineberg.de}{our assets repository}
#' @name wurstmineR
#' @docType package
NULL
jemus42/wurstmineR documentation built on May 19, 2019, 4:03 a.m.