Skip to content

curiousdannii/parchment

This branch is 14 commits behind master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

db79b6a · Dec 18, 2024
Dec 18, 2024
Dec 18, 2024
Dec 12, 2024
Dec 14, 2024
Oct 13, 2024
Sep 25, 2024
Aug 2, 2020
Dec 12, 2024
Dec 14, 2024
Dec 12, 2024
Jul 17, 2024
Dec 14, 2024
Dec 12, 2024

Repository files navigation

Parchment

Parchment is the Interactive Fiction player for the web. To play a story with Parchment go to https://iplayif.com!

IFTF logo

Parchment is made with the support of a grant from the Interactive Fiction Technology Foundation.

Parchment for Inform 7

Inform 7 includes Parchment, allowing you to produce personal websites for your stories. If you want to update the version of Parchment used by Inform 7, get it from the releases page and unzip it into the Templates subfolder of your project's Materials folder.

Site Generator

For those who aren't using Inform 7 (or who can no longer recompile their storyfile), the Parchment Site Generator allows you to make a single file version of Parchment. This supports any of the formats supported by Parchment (Adrift 4, Glulx, Hugo, TADS 2/3, Z-Code).

Single File Build

Parchment is also available as a single file, suitable for downloading and using offline. Download from the releases page.

Free Software

Parchment is MIT licensed, and incorporates the following upstream projects:

Name Upstream repo License
AsyncGlk curiousdannii/asyncglk MIT
Bocfel garglk/garglk GPL-2.0/GPL-3.0
Emglken curiousdannii/emglken MIT
Git DavidKinder/Git MIT
GlkOte erkyrath/glkote MIT
Glulxe erkyrath/glulxe MIT
Hugo hugoif/hugo-unix BSD-2-Clause
Iosevka be5invis/Iosevka OFL
jQuery jquery/jquery MIT
Quixe erkyrath/quixe MIT
RemGlk erkyrath/remglk MIT
Scare garglk/garglk GPL-2.0
TADS tads-intfic/tads-runner GPL-2.0
ZVM curiousdannii/ifvms.js MIT

Building Instructions

Parchment is only designed for building in Linux and may not work in other OSes. You'll need to install Git and Node version >= 16.

The upstream projects are included as Git submodules. Start by cloning the Git repository:

git clone --recurse-submodules https://github.com/curiousdannii/parchment.git
cd parchment

Install the npm dependencies, and then build Parchment:

npm install
npm run build

You can now open index.html on a web server. But... it won't work when you run it on your filesystem as a file:/// URL. You can instead launch a simple web server like this:

npm start

Then you can view Parchment at http://localhost:8080 to see your handiwork.

In addition, each time you change code in the src folder, the server will automatically rebuild the web code! Refresh to see your changes.

You can also build your own dist/inform/parchment-for-inform7.zip like this:

npm run inform7