easyrpg-web

A custom build script for EasyRPG Player for the web, with advanced features such as batch download save files, various utility functions, better button configuration and fixing some glitches related to iOS/Safari and ARPG support for touch control devices.

How to build

Prebuilt binaries (the index.js file and easyrpg-player.wasm file) are included in the www directory in this repository. For reference, here is an example build procedure using Docker.

1. cd build
2. docker run --rm -it -v $PWD:/easyrpg ubuntu
3. cd /easyrpg
4. bash ./build.sh
5. exit
6. bash ./copy.sh

Finally, serve www using a HTTP(S) server like nginx, or follow the instructions below to setup a HTTP server with utility API activated.

How to play a game

1. Place the game files in www/games/<gamename>.
2. cd www/games/<gamename>
3. ../../../gencache/gencache
4. Serve the www directory using some HTTP(S) server.
5. Access to www/index.html?game=<gamename> via a modern web browser.

Set up a server with API

You can setup a FastAPI server, which serves the main EasyRPG app, game files, and the utility API altogether. The server will start on port 9000. Visit http://localhost:9000/?game=<gamename> and enjoy the game!

Currently, the utility API only have a feature to record debugging logs (mainly for debugging the software only with the phone). There will be more functionality (such as cloud file sync) in the future.

1. cd api
2. python -m venv venv
3. venv/bin/python3 -m pip install -r requirements.txt
4. bash ./start.sh

Buttons

Unlike the original index.html on https://easyrpg.org/player/guide/webplayer/, the data-key property now can specify multiple keys at once, like data-key="ArrowUp,ArrowRight" to denote up-right movement for some action-RPG games. You can easily configure buttons by editing index.html.

By default, the keys are placed as such:

-----------------
- D           F -
-               -
-               -
-               -
-               -
- 123           -
- 4 5         X -
- 678        ZS -
-----------------

D ... Open dialog (batch/indivisual download saves, upload saves, evaluate javascript code, resume audio if stopped)
1 ... Up-Left
2 ... Up
3 ... Up-Right
4 ... Left
5 ... Right
6 ... Down-Left
7 ... Down
8 ... Down-Right
X ... X button (Escape, Open Menu, etc.)
Z ... Z button (Confirm, Next, etc.)
S ... Shift button (Special Action for some games.
      Also you can use it in the save menu to download/upload
      save files! though uploading is not working
      on iOS due to some permisssion issue)
F ... Fullscreen

License

This program is licensed under GPLv3.

See COPYING for more information.