he4et/elseifplayer
1
0
Fork 0
mirror of https://github.com/He4eT/elseifplayer.git synced 2026-05-04 17:07:22 +00:00
Code Issues Projects Releases Packages Wiki Activity
elseifplayer/README.md
He4eT 9f3e1d8c9a README.md: draft
2023-06-29 21:38:31 +03:00

2.3 KiB
Raw Blame History

ElseIFPlayer

Interactive Fiction player for the web. Powered by cheap-glkote and Emglken.

To see a live demo, check out https://he4et.github.io/elseifplayer/.

Getting Started

  • Make shure that you have NodeJS and NPM installed
  • Install required packages with npm install
  • Run local development server with npm run dev

Build

For making a production build use npm run build <public-url>

  • If you want to host player on https://your.domain/ use npm run build /
  • For https://your.domain/some-directory/ use npm run build /some-derectory

Direct links

You can provide the direct link to your game:

/#/mode/encodedURL/[theme]/

  • mode — player interface mode:
    • play — default multi-window mode
    • focus — single window mode without additional windows, such as the status bar
  • encodedURL — storyfile location encoded with encodeURIComponent
  • theme — UI theme, optional

CORS

If the player and your storyfile located on different domains you shoud set appropriate CORS settings.

In case you cannot change the server settings Parchment Proxy can be used.

Direct Link Examples