Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/matt-dray/r.oguelike

:crossed_swords::keyboard: R package: a tile-based roguelike toy for R's console
https://github.com/matt-dray/r.oguelike

roguelike roguelike-game rstats rstats-package

Last synced: 3 months ago
JSON representation

:crossed_swords::keyboard: R package: a tile-based roguelike toy for R's console

Host: GitHub
URL: https://github.com/matt-dray/r.oguelike
Owner: matt-dray
License: other
Created: 2022-01-23T18:34:08.000Z (about 3 years ago)
Default Branch: main
Last Pushed: 2023-01-03T22:10:13.000Z (about 2 years ago)
Last Synced: 2023-03-05T15:10:03.669Z (almost 2 years ago)
Topics: roguelike, roguelike-game, rstats, rstats-package
Language: R
Homepage: https://www.rostrum.blog/tags/r.oguelike/
Size: 536 KB
Stars: 12
Watchers: 2
Forks: 1
Open Issues: 11
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# {r.oguelike} 

[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)

[![R-CMD-check](https://github.com/matt-dray/r.oguelike/workflows/R-CMD-check/badge.svg)](https://github.com/matt-dray/r.oguelike/actions)

[![Codecov test coverage](https://codecov.io/gh/matt-dray/r.oguelike/branch/main/graph/badge.svg)](https://app.codecov.io/gh/matt-dray/r.oguelike?branch=main)

[![Launch Rstudio

Binder](http://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/matt-dray/play-r.oguelike/main?urlpath=rstudio)

[![Blog posts](https://img.shields.io/badge/rostrum.blog-posts-008900?labelColor=000000&logo=data%3Aimage%2Fgif%3Bbase64%2CR0lGODlhEAAQAPEAAAAAABWCBAAAAAAAACH5BAlkAAIAIf8LTkVUU0NBUEUyLjADAQAAACwAAAAAEAAQAAAC55QkISIiEoQQQgghRBBCiCAIgiAIgiAIQiAIgSAIgiAIQiAIgRAEQiAQBAQCgUAQEAQEgYAgIAgIBAKBQBAQCAKBQEAgCAgEAoFAIAgEBAKBIBAQCAQCgUAgEAgCgUBAICAgICAgIBAgEBAgEBAgEBAgECAgICAgECAQIBAQIBAgECAgICAgICAgECAQECAQICAgICAgICAgEBAgEBAgEBAgICAgICAgECAQIBAQIBAgECAgICAgIBAgECAQECAQIBAgICAgIBAgIBAgEBAgECAgECAgICAgICAgECAgECAgQIAAAQIKAAAh%2BQQJZAACACwAAAAAEAAQAAAC55QkIiESIoQQQgghhAhCBCEIgiAIgiAIQiAIgSAIgiAIQiAIgRAEQiAQBAQCgUAQEAQEgYAgIAgIBAKBQBAQCAKBQEAgCAgEAoFAIAgEBAKBIBAQCAQCgUAgEAgCgUBAICAgICAgIBAgEBAgEBAgEBAgECAgICAgECAQIBAQIBAgECAgICAgICAgECAQECAQICAgICAgICAgEBAgEBAgEBAgICAgICAgECAQIBAQIBAgECAgICAgIBAgECAQECAQIBAgICAgIBAgIBAgEBAgECAgECAgICAgICAgECAgECAgQIAAAQIKAAA7)](https://www.rostrum.blog/tags/r.oguelike/)

A tile-based [roguelike toy](https://en.wikipedia.org/wiki/Roguelike) for R's console.

This is a proof-of-concept. Read more [in the blogposts](https://www.rostrum.blog/tags/r.oguelike/). Suggest improvements or fixes in [the issues](https://github.com/matt-dray/r.oguelike/issues).

You can install {r.oguelike} from GitHub via [{remotes}](https://CRAN.R-project.org/package=remotes) (CRAN packages [{crayon}](https://CRAN.R-project.org/package=crayon), [{keypress}](https://CRAN.R-project.org/package=keypress) and [{sonify}](https://CRAN.R-project.org/package=sonify) are also installed):

``` r

if (!require(remotes)) install.packages("remotes")

remotes::install_github("matt-dray/r.oguelike")

```

You could also [launch an instance of RStudio in the browser](https://mybinder.org/v2/gh/matt-dray/play-r.oguelike/main?urlpath=rstudio) with {r.oguelike} preinstalled, thanks to [Binder](https://mybinder.org/).

Use `start_game()` to begin. See `?start_game` for details on how to adjust the starting parameters.

``` r

r.oguelike::start_game(

  max_turns  = 25,

  iterations = 3,

  n_row      = 15,

  n_col      = 20,

  n_rooms    = 4

)

```

The console will clear and then you’ll see a dungeon map, an inventory bar, a status message and a prompt for player input. Output will appear in colour if your console supports it.

```

# # # # # # # # # # # # # # # # # # # # 

# # # # # # # . . . . . . . . # # # # # 

# # # # # # . . . . . . $ . . # # # # # 

# # # . . . . . . # # . . . . # # # # # 

# . . . # # # # # # # . . . # # # # # # 

# . . # # # # # # # # . . . # # # # # # 

# . . . # # # # # # # . . . . . # . # # 

# . . # # # # # # # . . . . . . . . # # 

# . . # # # # # # # # . . . . . . # # # 

# . @ . . . # # . # # # # . . . . . # # 

# . . . . . . . . . . . . . . . . # # # 

# . . . . . . . . . E . # # . . . # # # 

# . . a . . . . . . . . . . . . # # # # 

# # . . . . # # . # # # # . # # # # # # 

# # # # # # # # # # # # # # # # # # # # 

T: 25 | HP: 10 | $: 0 | a: 0

Press W, A, S or D then Enter to move, 1 to eat apple, 0 to exit

Input:

```

The dungeon map (`#` for walls and `.` for floor tiles) is [procedurally-generated](https://www.rostrum.blog/2022/05/01/dungeon/) and the placement of objects (`@` is the player, `E` is an enemy, `$` is gold and `a` is an apple) is randomised.

To move the player character (`@`), type one of [WASD](https://en.wikipedia.org/wiki/Arrow_keys#WASD_keys) at the prompt and hit Enter. If your terminal supports [{keypress}](https://github.com/gaborcsardi/keypress) (RStudio doesn't) then you'll be able to type a single arrow key instead.

After instructing the player character to move down, for example, the screen refreshes to show `@` is in a new location and the status message has been updated. Simple sound effects will play depending on the outcome of the move.

```

# # # # # # # # # # # # # # # # # # # # 

# # # # # # # . . . . . . . . # # # # # 

# # # # # # . . . . . . $ . . # # # # # 

# # # . . . . . . # # . . . . # # # # # 

# . . . # # # # # # # . . . # # # # # # 

# . . # # # # # # # # . . . # # # # # # 

# . . . # # # # # # # . . . . . # . # # 

# . . # # # # # # # . . . . . . . . # # 

# . . # # # # # # # # . . . . . . # # # 

# . . . . . # # . # # # # . . . . . # # 

# . @ . . . . . . . . . . . . . . # # # 

# . . . . . . . . E . . # # . . . # # # 

# . . a . . . . . . . . . . . . # # # # 

# # . . . . # # . # # # # . # # # # # # 

# # # # # # # # # # # # # # # # # # # # 

T: 24 | HP: 10 | $: 0 | a: 0

Moved down

Input:

```

Also note that the enemy's (`E`) position has changed and it's [heading in your direction...](https://www.rostrum.blog/2022/06/10/basic-search/)

What now? Collect the gold (`$`). Auto-battle the chasing enemy (`E`). Collect an apple (`a`) for your inventory, then eat it with a keypress input of `1` to replenish health. You’ll die if you run out of `HP` or if you reach the maximum number of turns allowed (`T`). You can quit the game with `0`.

## Code of Conduct

Please note that the {r.oguelike} project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.