ElseIFPlayer is an interactive fiction player for the web. It's powered by cheap-glkote and Emglken.
Player available here: https://he4et.github.io/elseifplayer/.
- Ensure that you have Node.js and NPM installed on your system.
- Install the required packages by running the command
npm install
in your project directory. - Launch the local development server using
npm run dev
.
To create a production build, use the following command:
npm run build <public-url>
- If you intend to host the player on
https://your.domain/
, use:npm run build /
- For hosting it in a specific directory like
https://your.domain/some-directory/
, use:npm run build /some-directory
The finalized production bundle will be generated and stored in the /docs
directory.
You can provide a direct link to a specific game using the following URL format:
/#/<mode>/<encodedURL>/[theme]/
mode
specifies the player interface mode:play
: the default multi-window modefocus
: the single-window mode without additional windows, such as the status bar
encodedURL
represents the location of the storyfile encoded withencodeURIComponent
.theme
is optional and allows you to choose a specific UI theme.
If the player and your storyfile are located on different domains, you need to use appropriate CORS settings.
If you cannot modify the server settings, you can use the Parchment Proxy as an alternative.
- Play "Lost Pig" with default or last used theme
- Play "Lost Pig" without statusbar with default or last used theme
- Play "Lost Pig" with Nord theme
- Play "Lost Pig" without statusbar with Dim theme
- Play "Lost Pig" loaded with Parchment Proxy
ElseIFPlayer is distributed under the MIT License. However, please remember to respect the licenses of the interpreters listed on the Emglken page.