development:player:web
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
development:player:web [2015/10/03 09:55] – external edit 127.0.0.1 | development:player:web [2020/09/14 12:30] – The games must be in the subdirectory. There is no absolute path. ghabry | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | =====EasyRPG Player for the Web===== | + | ====== EasyRPG Player for the Web ====== |
- | EasyRPG supports running games directly inside your web browser. | + | EasyRPG |
- | If you want to test it you can play with a [[https://easy-rpg.org/play/? | + | If you want to test it you can play with a [[https://easyrpg.org/ |
- | ===How | + | ===== How it works ===== |
- | Web request are asynchronous. This means that all assets like pictures and music must be fetched asynchronously. When the Player wants to display a new graphic it will appear on the desktop versions (Windows, Linux, Android, ...) immedieately | + | Web request are asynchronous. This means that all assets like pictures and music must be fetched asynchronously. When the Player wants to display a new graphic it will appear on the desktop versions (Windows, Linux, Android, ...) immediately |
- | In contrast to images and music some files are important to continue execution. When a map file is pending the Player will halt until the file is downloaded. The first halt is while the Logo is displayed on startup, it downloads the database and the maptree here. Download of map files is blocking, too. But this is usually not noticable | + | In contrast to images and music some files are important to continue execution. When a map file is pending the Player will halt until the file is downloaded. The first halt is while the Logo is displayed on startup, it downloads the database and the maptree here. Download of map files is blocking, too. But this is usually not noticeable |
- | ===Hosting your own games=== | + | ===== Hosting your own games ===== |
- | Hosting your own games is quite simple. Just follow these three steps. | + | Hosting your own games is quite simple. Just follow these steps. |
- | == Deploying the Player on your server == | + | ==== Deploying the Player on your server |
- | [[https://easy-rpg.org/jenkins/ | + | [[https://ci.easyrpg.org/ |
- | Your server needs support for PHP (most servers support this). | + | You will get the following files and folder: |
- | + | ||
- | You will get the following files: | + | |
* index.html | * index.html | ||
+ | * index.wasm | ||
* index.js | * index.js | ||
- | | + | * games/ |
- | | + | |
- | == Preprocessing steps for games == | + | Note: if you want to try it locally you need a HTTP server, using '' |
- | Because of current player for the web is not supporting MIDI playback in browser yet (see [[https:// | ||
- | To convert MIDI to OGG run FIXME. | + | ==== Deploying a game on your server ==== |
- | To convert MP3 to OGG run FIXME. | + | Because RPG Maker games refer to files without extension and querying the server for every supported extension would be slow, you need to run a small tool to generate a file called '' |
- | == Deploying a game on your server == | + | You can get the tool here: |
- | The following only apply when you use our '' | + | * {{https:// |
+ | * {{https:// | ||
- | Your games are expected | + | Place the gencache executable |
- | If your '' | + | Your games are expected in subdirectories of the '' |
- | + | ||
- | Run '' | + | |
Now open the '' | Now open the '' | ||
- | |||
- | ===Technical details about the server side=== | ||
- | |||
- | The '' | ||
- | |||
- | Depending on the requested '' | ||
- | |||
- | This is required because Windows is case-insensitive (and original RPG2k was for Windows) and because the file extensions are not stored. '' | ||
- | |||
- | == Example == | ||
- | |||
- | The file '' | ||
- | |||
- | == API == | ||
- | |||
- | Our file finder is stored under '' | ||
- | |||
- | The directory struture of the '' | ||
- | |||
- | The only GET arguments that must be supported are '' | ||
- | |||
- | '' | ||
- | |||
- | '' | ||
- | |||
- | When a '' |
development/player/web.txt · Last modified: 2021/11/11 09:38 by ghabry