readme.md 1.63 KB
Newer Older
Nathan Pasko's avatar
Nathan Pasko committed
1
2
# Tunnel

3
_A temporally-unopinionated audio/video engine for the web._
Nathan Pasko's avatar
Nathan Pasko committed
4

5
6
7
8
9
10
11
12
13
Create, trade, remix, and share Tunnel cartridges. Each cartridge is composed of layers of sound, images, and color. The Tunnel engine is a new format designed to let the audience control the timing and structure of interactive artworks. Everything is open source and responsive.

**Tunnel HQ**
[https://tunnelengine.netlify.app](https://tunnelengine.netlify.app)

## What's in the repo

This repository contains the Tunnel engine and the Cartridge Maker tool.

Nathan Pasko's avatar
Nathan Pasko committed
14
### 📁 tunnel/tunnel-core/
15
16
17

The **Tunnel** engine with no cartridge loaded. This is the basis for any cartridge. Add a data file and assets to complete the package.

Nathan Pasko's avatar
Nathan Pasko committed
18
### 📁 tunnel/cartridge-maker/
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

The **Cartridge Maker** tool. Open **index.html** in your browser to use a simple cartridge creation assistant.

## Quick Start 

**For people comfortable with HTML and JavaScript.** You can also [read the full instructions to make a cartridge in the User's Manual](https://tunnelengine.netlify.app/manual-making-a-tunnel-cartridge).

1. Create a directory called **cart**.

2. Copy Tunnel into **cart**.

3. Open **index.html** in browser to see empty message.

4. Create **cartridge.js** in **cart**.

5. Write `info` object—see **Info Settings** in [Cartridge Data](https://tunnelengine.netlify.app/manual-cartridge-data).

6. Write `layers` array—see **Layer Settings** in [Cartridge Data](https://tunnelengine.netlify.app//manual-cartridge-data).

7. Embed **cartridge.js** into **index.html**.

8. Refresh **index.html** in browser to see loaded cartridge.

9. Add image and sound assets to directory and metadata to layers.