Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aidatorajiro/easyrpg-web
EasyRPG web build and a new index.html optimized for better iOS experiences
https://github.com/aidatorajiro/easyrpg-web
easyrpg emscripten emscripten-game emscripten-port web
Last synced: 5 days ago
JSON representation
EasyRPG web build and a new index.html optimized for better iOS experiences
- Host: GitHub
- URL: https://github.com/aidatorajiro/easyrpg-web
- Owner: aidatorajiro
- License: gpl-3.0
- Created: 2024-08-25T05:57:23.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T06:56:52.000Z (3 months ago)
- Last Synced: 2024-08-25T07:24:03.988Z (3 months ago)
- Topics: easyrpg, emscripten, emscripten-game, emscripten-port, web
- Language: JavaScript
- Homepage:
- Size: 6.65 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# 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.
## 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. You can also setup the API server and proxy it to `/api` in the HTTP(S) server.
## How to play a game
1. Place the game files in `www/games/`.
2. `cd www/games/`
3. `../../../gencache/gencache`
4. Serve the `www` directory using some HTTP(S) server.
5. Access to `www/index.html?game=` via a modern web browser.
## Set up api
You can setup an API server for debugging log (other features such as cloud save data syncing may be added later). The server will start on port 9001. See `nginx.conf.example` for an example proxy configuration.
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 , 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 -
- -
- -
- -
- -
- 123 -
- 4 5 X -
- 678 ZS -
-----------------
D ... Open dialog (you can batch download saves, upload saves, evaluate javascript code, resume audio if stopped etc.)
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)
```
## License
This program is licensed under GPLv3.
See `COPYING` for more information.