he4et/elseifplayer
1
0
Fork 0
mirror of https://github.com/He4eT/elseifplayer.git synced 2026-05-05 01:17:22 +00:00
Code Issues Projects Releases Packages Wiki Activity
Interactive Fiction player for the web https://he4et.github.io/elseifplayer/
195 commits 2 branches 3 tags 3.8 MiB
  • JavaScript 60.8%
  • CSS 27.5%
  • SCSS 10%
  • HTML 1.2%
  • Shell 0.5%
Find a file
He4eT db2ef7e048 README.md: draft
2023-06-29 19:22:22 +03:00
src Player: eslint 2023-06-13 00:41:52 +03:00
.editorconfig Add editorconfig 2021-02-19 01:06:19 +05:00
.eslintrc.js eslint: add braces rule 2023-06-05 00:51:41 +03:00
.gitignore Upgrade from Parcel 1 to Parcel 2 2023-05-22 00:21:19 +03:00
.parcelrc Upgrade from Parcel 1 to Parcel 2 2023-05-22 00:21:19 +03:00
gh.release.sh Rename the project to ElseIFPlayer 2021-07-24 19:54:46 +05:00
index.html index.html: remove fake markup 2023-06-05 02:16:04 +03:00
LICENSE Create LICENSE 2021-03-25 21:28:40 +05:00
package-lock.json package.json: update packages 2023-05-29 02:59:56 +03:00
package.json package.json: update packages 2023-05-29 02:59:56 +03:00
README.md README.md: draft 2023-06-29 19:22:22 +03:00

README.md

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