Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/curiousdannii/parchment-testing
Testing site for Parchment
https://github.com/curiousdannii/parchment-testing
Last synced: 19 days ago
JSON representation
Testing site for Parchment
- Host: GitHub
- URL: https://github.com/curiousdannii/parchment-testing
- Owner: curiousdannii
- License: mit
- Created: 2022-01-11T08:05:40.000Z (almost 3 years ago)
- Default Branch: gh-pages
- Last Pushed: 2024-10-24T06:08:56.000Z (2 months ago)
- Last Synced: 2024-10-24T15:39:12.809Z (2 months ago)
- Language: HTML
- Homepage: https://testing.iplayif.com/
- Size: 128 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Parchment
=========
Parchment is the Interactive Fiction player for the web. To play a story with Parchment go to !
Parchment is made with the support of [a grant](https://blog.iftechfoundation.org/2024-02-18-announcing-iftf-grant-recipients.html) from the [Interactive Fiction Technology Foundation](https://iftechfoundation.org/).
Parchment for Inform 7
----------------------
[Inform 7](http://inform7.com/) includes Parchment, allowing you to produce [personal websites for your stories](http://inform7.com/book/WI_25_11.html). If you want to update the version of Parchment used by Inform 7, get it [from the releases page](https://github.com/curiousdannii/parchment/releases) 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](https://iplayif.com/api/sitegen) 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](https://github.com/curiousdannii/parchment/releases).
Free Software
-------------
Parchment is MIT licensed, and incorporates the following upstream projects:
Name | Upstream repo | License
------- | ------------- | -------
AsyncGlk | [curiousdannii/asyncglk](https://github.com/curiousdannii/asyncglk) | [MIT](https://github.com/curiousdannii/asyncglk/blob/master/LICENSE)
Bocfel | [garglk/garglk](https://github.com/garglk/garglk) | [GPL-2.0](https://github.com/garglk/garglk/blob/master/terps/bocfel/COPYING.GPLv2)/[GPL-3.0](https://github.com/garglk/garglk/blob/master/terps/bocfel/COPYING.GPLv3)
Emglken | [curiousdannii/emglken](https://github.com/curiousdannii/emglken) | [MIT](https://github.com/curiousdannii/emglken/blob/master/LICENSE)
Git | [DavidKinder/Git](https://github.com/DavidKinder/Git) | [MIT](https://github.com/DavidKinder/Git/blob/master/README.txt)
GlkOte | [erkyrath/glkote](https://github.com/erkyrath/glkote) | [MIT](https://github.com/erkyrath/glkote/blob/master/LICENSE)
Glulxe | [erkyrath/glulxe](https://github.com/erkyrath/glulxe) | [MIT](https://github.com/erkyrath/glulxe/blob/master/LICENSE)
Hugo | [hugoif/hugo-unix](https://github.com/hugoif/hugo-unix) | [BSD-2-Clause](https://github.com/hugoif/hugo-unix/blob/master/License.txt)
Iosevka | [be5invis/Iosevka](https://github.com/be5invis/Iosevka) | [OFL](https://github.com/be5invis/Iosevka/blob/master/LICENSE.md)
jQuery | [jquery/jquery](https://github.com/jquery/jquery) | [MIT](https://github.com/jquery/jquery/blob/main/LICENSE.txt)
Quixe | [erkyrath/quixe](https://github.com/erkyrath/quixe) | [MIT](https://github.com/erkyrath/quixe/blob/master/LICENSE)
RemGlk | [erkyrath/remglk](https://github.com/erkyrath/remglk) | [MIT](https://github.com/erkyrath/remglk/blob/master/LICENSE)
Scare | [garglk/garglk](https://github.com/garglk/garglk) | [GPL-2.0](https://github.com/garglk/garglk/blob/master/terps/scare/COPYING)
TADS | [tads-intfic/tads-runner](https://github.com/tads-intfic/tads-runner) | [GPL-2.0](https://github.com/tads-intfic/tads-runner/blob/master/COPYING)
ZVM | [curiousdannii/ifvms.js](https://github.com/curiousdannii/ifvms.js) | [MIT](https://github.com/curiousdannii/ifvms.js/blob/master/LICENSE)
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
```