Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ search:
- [Downloads](using/downloads.md)
- [Uploads](using/uploads.md)
- In-Browser Play
- [EasyRPG](using/in-browser-play/easyrpg.md)
- [EmulatorJS](using/in-browser-play/emulatorjs.md)
- [`js-dos`](using/in-browser-play/js-dos.md)
- [MS-DOS](using/in-browser-play/ms-dos.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ These are the terms the docs, UI, and API use consistently. Foundational concept

**Firmware**: BIOS or system firmware required for certain emulators (PS1, GBA, Saturn, etc.). Lives wherever the [`filesystem.structure.firmware`](configuration-file.md#filesystemstructure) template points, `bios/{platform}` by default. Uploaded via the UI and managed by admins and users with the `firmware.write` scope (see [Firmware Management](../administration/firmware-management.md)).

**Full image**: the default container variant, bundling all four browser runtimes (EmulatorJS, Ruffle, `js-dos`, FAKE-08). `rommapp/romm:X.Y.Z` (see [Image Variants](../install/image-variants.md)).
**Full image**: the default container variant, bundling all five browser runtimes (EmulatorJS, Ruffle, `js-dos`, FAKE-08, EasyRPG). `rommapp/romm:X.Y.Z` (see [Image Variants](../install/image-variants.md)).

**Game Data tab**: the ROM detail page tab for saves, states, and screenshots. User-specific.

Expand Down
13 changes: 7 additions & 6 deletions docs/resources/snippets/env-vars.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,12 +145,13 @@

### Emulation

| Variable | Default | Required | Description |
| --------------------- | ------- | :------: | -------------------------------------------------------- |
| `DISABLE_EMULATOR_JS` | `false` | | Disable in-browser play via EmulatorJS |
| `DISABLE_RUFFLE_RS` | `false` | | Disable in-browser Flash playback via RuffleRS |
| `DISABLE_JSDOS` | `false` | | Disable in-browser Win3.x and Win9.x playback via js-dos |
| `DISABLE_PICO8` | `false` | | Disable in-browser PICO-8 playback via FAKE-08 |
| Variable | Default | Required | Description |
| --------------------- | ------- | :------: | ----------------------------------------------------------- |
| `DISABLE_EMULATOR_JS` | `false` | | Disable in-browser play via EmulatorJS |
| `DISABLE_RUFFLE_RS` | `false` | | Disable in-browser Flash playback via RuffleRS |
| `DISABLE_JSDOS` | `false` | | Disable in-browser Win3.x and Win9.x playback via js-dos |
| `DISABLE_PICO8` | `false` | | Disable in-browser PICO-8 playback via FAKE-08 |
| `DISABLE_EASYRPG` | `false` | | Disable in-browser RPG Maker 2000/2003 playback via EasyRPG |

### Integrations

Expand Down
49 changes: 49 additions & 0 deletions docs/using/in-browser-play/easyrpg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
---
title: EasyRPG
description: Play RPG Maker 2000 and 2003 games in the browser
---

# EasyRPG

RPG Maker 2000 and 2003 games run in the browser on the [EasyRPG Player](https://easyrpg.org), an open-source reimplementation of the RPG Maker 2000/2003 engine built to WebAssembly. Put games under the `rpg-maker` platform (an `easyrpg` folder maps to it too) to play them.

<!-- prettier-ignore -->
!!! info "Full image only"
The player and the free RTP are bundled in the full container image and have no CDN fallback, so RPG Maker games do not play on the slim image (see [Image Variants](../../install/image-variants.md)).

Server owners can turn the player off with `DISABLE_EASYRPG=true` (see [Environment Variables](../../reference/environment-variables.md)).

## Game folders

The player fetches each file of a game as it needs it, so it can't open an archive. A game must be an extracted folder with `RPG_RT.ldb` at its root, the same layout the game shipped in:

```text
roms/rpg-maker/
└── Yume Nikki/
├── RPG_RT.ldb
├── RPG_RT.lmt
├── Map0001.lmu
├── CharSet/
└── Music/
```

Zipped games show up in the library but have no Play button.

## Run-time package

Many games rely on the RPG Maker run-time package (RTP) for shared graphics and sounds instead of shipping them. RomM bundles the free [EasyRPG RTP](https://github.com/EasyRPG/RTP) and hands its files to any game that asks for an RTP asset by its Japanese or translated name. A game's own files always win over the RTP's.

The free RTP is partial: it has system graphics, character sets, music and sounds, but no battle backgrounds and few monsters or battle animations. Games that depend on the RTP play, with assets missing mostly in battles.

## Controls

The player brings its own controls: keyboard, gamepad and on-screen touch buttons.

## Saves

Saves stay in your browser, separately for each RomM account, and don't sync back to the server.

## Related

- [EmulatorJS](emulatorjs.md): the libretro-core player behind most platforms
- [PICO-8](pico-8.md): another native, non-EmulatorJS player
1 change: 1 addition & 0 deletions docs/using/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ description: Browse, play, collect, patch, and share from the UI

## Browse and play

- **[EasyRPG](in-browser-play/easyrpg.md)**
- **[EmulatorJS](in-browser-play/emulatorjs.md)**
- **[MS-DOS](in-browser-play/ms-dos.md)**
- **[`js-dos`](in-browser-play/js-dos.md)**
Expand Down