ProTrackR2/README.Rmd at master · pepijn-devries/ProTrackR2 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
---
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# ProTrackR2

<!-- badges: start -->
[![R-CMD-check](https://github.com/pepijn-devries/ProTrackR2/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/pepijn-devries/ProTrackR2/actions/workflows/R-CMD-check.yaml)
[![ProTrackR2 status badge](https://pepijn-devries.r-universe.dev/badges/ProTrackR2)](https://pepijn-devries.r-universe.dev/ProTrackR2)
[![codecov](https://codecov.io/gh/pepijn-devries/ProTrackR2/graph/badge.svg?token=0ILPGKGB73)](https://app.codecov.io/gh/pepijn-devries/ProTrackR2)
[![version](https://www.r-pkg.org/badges/version/ProTrackR2)](https://CRAN.R-project.org/package=ProTrackR2)
![cranlogs](https://cranlogs.r-pkg.org/badges/ProTrackR2)
<!-- badges: end -->

<img src="man/figures/logo.svg" align="right" height="139" copyright="cc-sa" alt="logo" class="pkgdown-hide" />

[ProTracker](https://en.wikipedia.org/wiki/ProTracker) is music sequencer software
from the 1990s on the [Commodore Amiga](https://en.wikipedia.org/wiki/Amiga)
(see screenshot of version 2.3a on the right).
The R package `ProTrackR2` is the successor of [`ProTrackR`](https://pepijn-devries.github.io/ProTrackR/).
It can be used to play and manipulate ProTracker module music.

## Installation

You can install the development version of ProTrackR2 from [r-universe](https://pepijn-devries.r-universe.dev/ProTrackR2) with:

``` r
install.packages("ProTrackR2", repos = c("https://pepijn-devries.r-universe.dev", "https://cloud.r-project.org"))
```

Install the [CRAN](https://cran.r-project.org/) release with:

``` r
install.packages("ProTrackR2")
```

## ProTracker2.3d clone

<img src="https://content.pouet.net/files/screenshots/00050/00050055.png" alt="ProTracker 2.3a" align="right" />

The ProTrackR2 package essentially provides an R entry point into the
[ProTracker2.3d clone](https://16-bits.org/pt2.php) by
[Olav S&oslash;rensen (A.K.A. 8bitbubsy)](https://github.com/8bitbubsy) and other
[contributors](https://github.com/8bitbubsy/pt2-clone/graphs/contributors)
([source code](https://github.com/8bitbubsy/pt2-clone)). For this
purpose, I took the code by S&oslash;rensen and stripped away the graphical user interface (GUI)
and access to the audio device. Next I added R bindings to access functionality to read,
write, manipulate and render
ProTracker modules. This allows you to process such modules with R scripts and in batches.
If you wish to use the
the GUI I suggest to visit one of the links above and check out the work of Olav S&oslash;rensen.

The work by Olav S&oslash;rensen is gratefully acknowledged here, without which this package would
have not been possible.

## Example

The example below shows how to load a ProTracker module file and play it in R:

```{r example, eval=FALSE}
library(ProTrackR2)

mod <- pt2_read_mod("https://api.modarchive.org/downloads.php?moduleid=41529#elektric_funk.mod")

play(mod)
```

## Code of Conduct

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