frontispiece / apps / frontispiece-editor / dist / story.ink
story.ink
Raw
-> title
=== title ===

>> clear

<h1>Demo Ink story</h1>

// inline syntax and links can be made with a tags or markdown.
// however, since Ink makes // into a comment, web pages need to start with http:\/\/ in the script.
A random thing by <a href="https:\/\/amorphic.space">Amorphous.</a>

+ [Begin]
    -> begin
+ [About]
    -> about

=== about ===

>> clear

This is a 'somewhat easier to use' version of **Frontispiece**, Amorphous's ink-powered interactive fiction engine. 

Quite frankly, it's a little bit of an over-engineered mess: it uses React to run the whole thing, and tries to make a very very stateful InkJS instance turn into an immutable visual state.

In its most powerful form, however, because of all the React, it can store variables, display other logic, run animations, etc. All to the caveat of 'I hope you like Javascript'.

This is a much more simplified version that just aims to make Ink stories display reasonably well on web with reasonable configuration options. And some level of JS extensibility, provided via commands.

<h2>Prior Art</h2>

Please take a look at [**Calico**](https:\/\/github.com/elliotherriman/calico), which aims to do a lot of the same things as this program except is more mature and also better documented.

+ [Return to Main Menu]
    -> title

=== begin ===

>> bg space.jpg

Welcome to the hopefully not painful to use version of Frontispiece!

You can use <b>HTML</b> to style your stories. Or _markdown_.

And add images via html image tags, and change the background via custom commands.

<img src="./assets/images/demo.jpg" />

Yeah.

+ Cool
+ Neat?
-

You can also change the text color with html, because you can edit the css!

(By default, there's a <span class="red">red</span> class inside style.css, you can add more with your own styles!)

@red Starting a line with `@` will also attach the class after the @ to the line, so this whole line will be red.

I hope all of that made sense...

+ What about audio?
-

>> music sample_music.mp3

It also plays music and sounds! Kinda. By default, the engine will look in `assets/audio` for sounds, and you can't have any spaces in the filename.

That's pretty much it.

+ [Okay stop the music.]
-
// yeah unfortunately because ink uses # for tags if you want to change bg color
// to a css color you need to escape the # in the color tag.
// this is a very dark grey.
>> bg \#111
>> stop_music

Got it.

->END