README.Rmd

---
output: github_document
---

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

# AmigaFFH

The Amiga File Format Handler package (AmigaFFH) is designed to interpret file formats that were native
to [Commodore Amiga](https://en.wikipedia.org/wiki/Amiga) machines.
In combination with the adfExplorer package this package can be used to interpret older file formats that
were native to the Commodore Amiga. The focus of this package will be on the older system (Amiga OS <= 3.0).
This will allow you to analyse and interpret these files in the scripted environment of R.

In the sections below there are some prominent examples of supported file formats. For a more detailed
overview, please consult the package documentation (`?AmigaFFH`)

## Installation

> Get CRAN version
```{r eval=FALSE}
install.packages("ProTrackR")
```
> Get development version from R-Universe
``` r
install.packages("ProTrackR", repos = c('https://pepijn-devries.r-universe.dev', 'https://cloud.r-project.org'))
```

## Usage

Below there are some ultra-short demostrations of a selection of supported Amiga file types

### IFF

The Interchange File Format (IFF) is and was a file container that could hold any kind of data.
Below is an example of a bitmap image stored as such a file.

```{r iff, fig.width=5, fig.height=4}
library(AmigaFFH)

example.iff <-
  system.file("ilbm8lores.iff", package = "AmigaFFH") |>
  read.iff()

par(bg = "black")
plot(example.iff, interpolate = FALSE)
```

### AmigaBasic

[AmigaBasic](https://en.wikipedia.org/wiki/Amiga_Basic) is a simple interpreted programming
language for the early Commodore Amiga's. Its code was stored in a binary format to save
disk and memory space. Below an example of how to read such a file.

```{r basic}
system.file("demo.bas", package = "AmigaFFH") |>
  read.AmigaBasic()
```

### Amiga File Icons

On the Amiga, file icons were stored as separate files. Below an example of
how to create such a file.

```{r icons, fig.width=3, fig.height=3}
icon <- simpleAmigaIcon()
plot(icon, interpolate = FALSE)
```

### Amiga Fonts

The Commodore Amiga used bitmap fonts to display texts. The package comes with an
example object that can be stored as an Amiga Font file.

```{r fonts, fig.width=7, fig.height=4}
data(font_example)

plot(font_example, interpolate = FALSE)
```

### System configuration

The `systemconfiguration` file was used to store some system preferences (screen resolution, font,
default printer, etc.). It was loaded during the boot process. The exaple below shows how to create
such a file.

```{r sysconfig}
simpleSysConfig()
```

## Developmental status

It has been years since the initial release of this package. Since it's release
a lot has changed in R and in my skill set. I still have plans for this package,
but this requires drastic changes. Therefore, I will only apply minimal maintenance
to this package. Meanwhile I will work on a complete overhaul which will be released
in due time as a new package. This new package will:

 * have the same or similar features as the current package.
 * will implement modern R features and try to adhere to
   [tidyverse](https://www.tidyverse.org) principles.
 * implement rendering procedures in C++ giving the package a speed boost.

But until then, please enjoy the current package as is.