# Frontispiece

This is a hopefully easy-to-use engine for writing ink stories that turn into interactive games. With images! And sounds! and yeah.

## How to run the game?

Because of web browser restrictions, you can't just click on `index.html` and expect it to run; you have to run it on a *web server*. (You won't have this problem if you upload a game somewhere, it's just a problem when running it on your own computer).

The easiest way to do so, if you're at all comfortable with the terminal, is to navigate your terminal to the folder that `index.html` is in and run:

```
python3 -m http.server
```

Then, in your web browser, go to `http://localhost:8000/` and you should see the ink game running there!

If you don't have python or it isn't installed, there are other command line tools or GUIs to run local web servers, but I'm not familiar with them...

## How to edit the game?

There's a `story.ink` file. Put your story in that.

Want to change how the thing looks? Change it in `style.css` - it should have some level of documentation, but playing around is encouraged.

The final bit of configuration you can change is in `config.toml` - every option there has comments (starting with `#`) that explain what those options do. If you accidentally delete config.toml or break it it shouldn't damage your game, you'll just end up using the default values for everything. Worst comes to worst you can delete it and it won't do anything terrible, though I don't really suggest that.

EVERYTHING ELSE IN THE TOP-LEVEL FOLDER MUST NOT BE DELETED. 

`index.css`, `index.html`, and `index.js` are important and I sincerely suggest you do not edit them. They're not meant to be edited! If you want to change the CSS go change `style.css`.

Want to add images or music? The default folders (`assets/images` and `assets/audio`) will automatically be searched if you use a command with a file name and no directory. But if you use full file paths (with `/` in them) then you can use other folders.

## List of usable commands

```c
>> clear
// clears the screen

>> bg <color or url>
// sets the background color (if you write a hexadecimal color) or image
// e.g. >> bg \#111111
// ink requires you to backslash before the # because the # is usually used for tags...

>> music <filename or url>
// plays background music which loops
// example:
// >> music sample_music.mp3

>> sfx <filename or url>
// plays a sound once (no looping)

>> stop_music
// stops the music
```