From d702e4b8a2f3f66a2bb58f8768f47b455a3b210e Mon Sep 17 00:00:00 2001 From: Alexey Date: Thu, 25 Mar 2021 20:34:40 +0500 Subject: [PATCH] Create README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..b32f86c --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# ifplayer + +Interactive Fiction player for the web. +Powered by [cheap-glkote](https://github.com/He4eT/cheap-glkote) and [Emglken](https://github.com/curiousdannii/emglken). + +To see a live demo, check out [https://he4et.github.io/ifplayer/](https://he4et.github.io/ifplayer/). + +## Direct links + +You can provide the direct link to your game: + +`/#/play/encodedURL/[theme]/` +- `encodedURL` - storyfile location encoded with `encodeURIComponent`; +- `theme` - [UI theme](https://github.com/He4eT/ifplayer/blob/master/src/themes/themes.js), optional; + +### Examples +- [Play "Lost Pig" with default or last used theme](https://he4et.github.io/ifplayer/#/play/https%3A%2F%2Fmirror.ifarchive.org%2Fif-archive%2Fgames%2Fzcode%2FLostPig.z8/); +- [Play "Lost Pig" with Nord theme](https://he4et.github.io/ifplayer/#/play/https%3A%2F%2Fmirror.ifarchive.org%2Fif-archive%2Fgames%2Fzcode%2FLostPig.z8/nord/);