« get me outta code hell

flash.md « documents - hsmusic-docs - Unnamed repository; edit this file 'description' to name the repository.
about summary refs log tree commit diff
path: root/documents/flash.md
blob: 96ac9a170bc8e24a31a288e61d2fd4fc9331a96c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
# Flash Format

Flash documents are stored all in one file, `flashes.yaml`, one document (entry) per flash. They're grouped by flash act documents.

The website section for flashes is called "Flashes & Games". Apart from this, these data objects are always called flashes.

The flashes file will, in its entirety, look something like this:

```yaml
Act: Act 1 - The Note Desolation Plays
Anchor: a1
Color: '#7799ff'
Jump: Side 1 (Acts 1-5)
Jump Color: '#4ac925'
---
Flash: 'John: Examine games on CD rack.'
Page: '31'
Date: April 16, 2009
Featured Tracks:
- Problem Sleuth Theme
# ...
---
Act: Act 6 Intermission 3 - Ballet of the Dancestors
Anchor: a6i3
Color: '#b536da'
---
Flash: '[S] ACT 6 INTERMISSION 3'
Page: '5263'
Date: August 31, 2012
Contributors:
- Killian Ng (art)
- Xamag (art)
# ...
```

## Flash documents

Referenced as `flash:directory`.

* `Flash`: flash name
* `Directory`: unique identifier among other flashes (inherits from Page before Name)
* `Page`: page number on https://homestuck.com
* `URLs`: web URLs for flash playback (or game purchase)

* `Date`: flash posting/release date
* `Cover Art File Extension`: corresponds to media file

* `Featured Tracks`: tracks that play (in full or part) as part of the flash
* `Contributors`: artists who contributed directly to flash, e.g. art media, programming

## Flash act documents

* `Act`: act name
* `Color`: theme color representing act
* `Anchor`: unique identifier among other acts
* `Jump`: title of quick link on Flashes & Games index
* `Jump Color`: color of quick link on Flashes & Games index