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/
201 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 5e756a8e0c Update CHANGELOG.md
2023-06-29 21:36:17 +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
CHANGELOG.md Update CHANGELOG.md 2023-06-29 21:36:17 +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 0.2.0 2023-06-29 20:57:21 +03:00
package.json 0.2.0 2023-06-29 20:57:21 +03:00
README.md Update README.md 2023-06-29 20:50:44 +03:00

README.md

ElseIFPlayer

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/.

Getting Started

  • 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.

Build

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.

Direct links

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 mode
    • focus: the single-window mode without additional windows, such as the status bar
  • encodedURL represents the location of the storyfile encoded with encodeURIComponent.
  • theme is optional and allows you to choose a specific UI theme.

CORS

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.

Direct Link Examples

License

ElseIFPlayer is distributed under the MIT License. However, please remember to respect the licenses of the interpreters listed on the Emglken page.