User Tools

Site Tools


development:player:web

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
development:player:web [2016/02/18 22:12]
fdelapena Add a note about oggenc not supporting ADPCM
development:player:web [2020/09/20 21:54] (current)
ghabry recommend python server. improve ?game wording
Line 1: Line 1:
 ====== EasyRPG Player for the Web ====== ====== EasyRPG Player for the Web ======
  
-EasyRPG supports running games directly inside your web browser.+EasyRPG Player supports running games directly inside your web browser.
  
-If you want to test it you can play with a [[https://easy-rpg.org/play/|Demo of our TestGame]]. Try also a working game: [[https://easy-rpg.org/play/?game=ib|Ib]]+If you want to test it you can play with a [[https://easyrpg.org/play/|Demo of our TestGame]]. Try also a working game: [[https://easyrpg.org/play/?game=ib|Ib]]
  
-===== How does it work =====+===== 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, ...) immediately but on the web it will be invisible while the file is downloaded. Once the downloaded finishes it is replaced with the real image. 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 but on the web it will be invisible while the file is downloaded. Once the downloaded finishes it is replaced with the real image.
Line 13: Line 13:
 ===== 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/job/player-js/lastSuccessfulBuild/artifact/player-js.tar.gz|Download this archive]] and extract it on your server.+[[https://ci.easyrpg.org/job/player-js/lastSuccessfulBuild/artifact/player-js.tar.gz|Download this archive]] and extract it on your server.
  
-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
-  * index.html.mem +  * games/
-  * games/index.php+
  
-==== Preprocessing steps for games ====+If you want to //try it locally// you need a HTTP server. Just opening the ''index.html'' in your browser will not work. If you don't have a local webserver the simplest way is installing Python and running ''python -m http.server''. Then open ''http://localhost:8000/'' in your browser and navigate to your directory.
  
-Because of current player for the web is not supporting MP3 playback properly in browser yet (there are resampling and buffering issues in SDL_mixer) you should convert ''MP3'' audio files to Ogg Vorbis. Also, EasyRPG Player supports existing WAV files but Ogg Vorbis is a lot smaller and worth for the web. Do the same following process for both ''Music'' and ''Sound'' folders and remove unneeded MP3 and WAV files after the conversion. 
- 
-=== MP3 to Ogg Vorbis conversion === 
- 
-== GNU/Linux command line option == 
- 
-  * First, install ''lame'' and decode all MP3 to WAV: 
- 
-  for song in *.mp3; do lame --decode "$song"; done 
- 
-  * Then, install ''vorbis-tools'' and encode all WAV to Ogg Vorbis. 
- 
-  oggenc -q-1 *.wav 
- 
-Beware of existing MS ADPCM WAV files, they are not supported by oggenc. If you get conversion errors, use ''ffmpeg -i adpcmfile.wav -o pcmfile.wav'' and rename it. 
- 
-== Windows drag and drop tools option == 
- 
-  * First, download [[http://www.rarewares.org/mp3-lamedrop.php|LameDropXPd]] based on LAME. 
- 
-  * Open the LameDropXPd app (it is a square window), select all MP3 files from the folder, then drag and drop them over the square app window. They will be converted to WAV. 
- 
-  * Then, download [[http://www.rarewares.org/ogg-oggdropxpd.php|oggdropXPd]] (aoTuV version is preferred). 
- 
-  * Open the oggdropXPd app (it is a square window), select all WAV files from the folder, then drag and drop them over the square oggdropXPd window. They will be converted to Ogg Vorbis. If you want to make smaller Ogg Vorbis files, do secondary mouse button click over the square window to select options and adjust the compression quality option to -1 (~48 kbps) or -2 (~32 kbps). 
 ==== Deploying a game on your server ==== ==== Deploying a game on your server ====
  
-The following only apply when you use our ''index.php''+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 ''index.json'' (containing an game file list index with extensions) for every game before uploading. The tool is called ''gencache''.
- +
-Your games are expected in subdirectories of the ''games'' directory. The default game executed is the one in ''games/default''. You can create further games by just putting them in subdirectories of the ''games'' directory. Because of security considerations (directory traversal) your directory name may not contain ''.'', ''\'' or ''cache''+
- +
-If your ''games'' directory is not writable for PHP create a ''cache'' folder in ''games'' and give it write permissions. You can skip this step if ''games'' is writable. You can revoke read permission on this folder for world/others. +
- +
-Run ''games/?update'' once. You have to run this each time you change files of the game. For other games different than default, use ''games/?update&game=folder_name''+
- +
-Now open the ''index.html'' file and your default game should start. To play different game pass ''?game=folder_name'' to your index file+
- +
-===== Technical details about the server side ===== +
- +
-The ''index.php'' works as a file finder which allows case-insensitive lookup of files. +
- +
-Depending on the requested ''file'' it either returns ''404'' or a ''Location''-header to the file on the server. +
- +
-This is required because Windows is case-insensitive (and original RPG2k was for Windows) and because the file extensions are not stored''Charset/Hero1'' could be ''Hero1.png'', hero1.bmp or ''HeRo1.xyz'', depending on which file exists. +
- +
-==== Example ==== +
- +
-The file ''System/System1'' is requested. The server returns ''Location: games/default/System/System1.png''. The same result is expected for file ''SyStEm/systEM1''+
- +
-==== API ==== +
- +
-Our file finder is stored under ''src/platform/easyrpg-filefinder.php''. In case you want to replace the file finder you only have to fulfill a very simple API.+
  
-The directory struture of the ''games'' folder is not part of the API contract. The player only expects that accessing ''games/'' invokes the file finder.+You can get the tool here:
  
-The only GET arguments that must be supported are ''game'' and ''file''.+  * {{https://ci.easyrpg.org/job/tools-win32/lastSuccessfulBuild/artifact/bin/gencache.exe|gencache for Windows}} 
 +  * {{https://ci.easyrpg.org/job/tools-linux/lastSuccessfulBuild/artifact/gencache.tar.gz|gencache for Linux}}
  
-''game'' is the name of the game that is executed.+Place the gencache executable in a game working folder (the folder containing RPG_RT.* files) to generate the ''index.json''. Move the ''gencache'' executable to working folders for each game you want to upload and run ''gencache'' again to generate the ''index.json'' for them. Once finished you can remove (don't upload it, it's not needed) the ''gencache'' from any game folder.
  
-''file'' is the name of the file the game requests.+Your games are expected in subdirectories of the ''games'' directory. The default game executed is the one in ''games/default''. You can create further games by just by putting them in subdirectories of the ''games'' directory.
  
-When a ''file'' is requested it must return a downloadable representation of the file. How doesn't matter, it can be an ''octet-stream'' or redirect via ''Location''-header. If the file is not found ''404'' must be returned.+Now access the ''index.html'' file and your default game should startTo play different game pass ''?game=folder_name'' as part of the URL (query string) to your index file.
development/player/web.1455833570.txt.gz · Last modified: 2016/02/18 22:12 (external edit)