Skip to content

Commit bb0cb31

Browse files
asiekierkaasiekierka
committed
contributing: add theming guide
1 parent 0aaa8f9 commit bb0cb31

4 files changed

Lines changed: 139 additions & 22 deletions

File tree

‎content/contributing/_index.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: 'Contributing'
3+
weight: 10
4+
---
5+
The following is a manual detailing how to contribute to
6+
NitrousTracker.

‎content/contributing/resources.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: 'Getting started'
3+
weight: 0
4+
---
5+
6+
NitrousTracker is a hobby project maintained by volunteers in their spare time. Here's what you can do to help!
7+
8+
## Find bugs and request features!
9+
10+
Bug reports and feature requests are collected here:
11+
12+
https://github.com/NitrousTracker/nitroustracker/issues
13+
14+
If you have something that isn't already on that list, feel
15+
free to add it.
16+
17+
## Become a NitrousTracker developer!
18+
19+
The source and all the info on how to get started is here:
20+
21+
https://github.com/NitrousTracker/nitroustracker
22+
23+
If you want to contribute a pull request, go right ahead!

‎content/contributing/theming.md‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: 'Theming'
3+
weight: 20
4+
---
5+
6+
`.nttheme` files can be used to create NitrousTracker themes.
7+
8+
## .nttheme format
9+
10+
The format consists of `ID=hexcode` pairs, written like so:
11+
12+
```
13+
0=000000 ; Background
14+
1=000000 ; Envelope editor background
15+
2=2c3034 ; Medium background
16+
```
17+
18+
Unspecified colors are filled in with either the closest color by definition,
19+
to preserve backwards compatibility, or with the default theme's color if that
20+
is not possible.
21+
22+
### List of color IDs
23+
24+
| ID | Description |
25+
| -- | ----------- |
26+
| 0 | Background |
27+
| 1 | Envelope editor background |
28+
| 2 | Medium background |
29+
| 3 | Light background |
30+
| 4 | Lighter background |
31+
| 5 | Light control / button gradient 1 |
32+
| 6 | Dark control / button gradient 2 |
33+
| 7 | Light control (disabled) |
34+
| 8 | Dark control (disabled) |
35+
| 9 | Selected tab |
36+
| 10 | Unselected tab |
37+
| 11 | List item gradient 1 |
38+
| 12 | List item gradient 2 |
39+
| 13 | List item gradient 1 (highlighted) |
40+
| 14 | List item gradient 2 (highlighted) |
41+
| 15 | Scrollbar background gradient 1 |
42+
| 16 | Scrollbar background gradient 2 |
43+
| 17 | Scrollbar thumb (inactive) |
44+
| 18 | Scrollbar thumb (active) |
45+
| 19 | Scrollbar arrow background gradient 1 |
46+
| 20 | Scrollbar arrow background gradient 2 |
47+
| 21 | Widget outline |
48+
| 22 | Tab/tab box outline |
49+
| 23 | List item separator line |
50+
| 24 | Tab icon |
51+
| 25 | Button icon and scrollbar arrows |
52+
| 26 | Checkmark |
53+
| 27 | Text |
54+
| 28 | Text (light) |
55+
| 29 | Text (buttons) |
56+
| 30 | Text (value input) |
57+
| 31 | Text (list items) |
58+
| 32 | Text (highlighted list item) |
59+
| 33 | Recording/signal (red) |
60+
| 34 | Recording/signal (off, dark red) |
61+
| 35 | Piano mapping label (naturals) |
62+
| 36 | Piano mapping label (inverted, sharps) |
63+
| 37 | Loop points |
64+
| 38 | Envelope sustain line |
65+
| 39 | Envelope line |
66+
| 40 | Envelope point fill |
67+
| 41 | Envelope point outline |
68+
| 42 | Envelope point outline (active) |
69+
| 43 | Memory usage: OK |
70+
| 44 | Memory usage: Warning |
71+
| 45 | Memory usage: Alert |
72+
| 46 | Text entry cursor |
73+
| 47 | Sample editor background |
74+
| 48 | Sample editor background (selection) |
75+
| 49 | Sample editor waveform |
76+
| 50 | Sample editor waveform (selection) |
77+
| 51 | Pattern - background |
78+
| 52 | Pattern - channel number |
79+
| 53 | Pattern - lines |
80+
| 54 | Pattern - sublines |
81+
| 55 | Pattern - lines (recording) |
82+
| 56 | Pattern - cursor bar gradient 1 |
83+
| 57 | Pattern - cursor bar gradient 2 |
84+
| 58 | Pattern - cursor bar gradient 1 (highlight) |
85+
| 59 | Pattern - cursor bar gradient 2 (highlight) |
86+
| 60 | Pattern - row numbers |
87+
| 61 | Pattern - notes |
88+
| 62 | Pattern - notes (dark) |
89+
| 63 | Pattern - instruments |
90+
| 64 | Pattern - instruments (dark) |
91+
| 65 | Pattern - volume |
92+
| 66 | Pattern - volume (dark) |
93+
| 67 | Pattern - effect command |
94+
| 68 | Pattern - effect command (dark) |
95+
| 69 | Pattern - effect parameter |
96+
| 70 | Pattern - effect parameter (dark) |
97+
| 71 | Pattern - selection |
98+
| 72 | Pattern - row outline |
99+
| 73 | Pattern - cursor outline |
100+
| 74 | Pattern - mute/solo text color |
101+
| 75 | Pattern - mute/solo gradient 1 |
102+
| 76 | Pattern - mute/solo gradient 2 |
103+
| 77 | Pattern - mute/solo gradient 1 (highlight) |
104+
| 78 | Pattern - mute/solo gradient 2 (highlight) |
105+
| 79 | Pattern - row numbers (highlight) |
106+
| 80 | List item separator line (vertical) |
107+
| 81 | Togglebutton background |
108+
| 82 | Togglebutton text (off) |
109+
| 83 | Togglebutton text (on) |

‎content/manual/resources.md‎

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,6 @@ operated by deadpahn.
2323

2424
Otherwise, all that\'s left to say is: **Be creative and have fun!**
2525

26-
## Contributing
27-
28-
NitrousTracker is a hobby project maintained by volunteers in their spare time. Here's what you can do to help:
29-
30-
### Find bugs and request features!
31-
32-
Bug reports and feature requests are collected here:
33-
34-
https://github.com/NitrousTracker/nitroustracker/issues
35-
36-
If you have something that isn't already on that list, feel
37-
free to add it.
38-
39-
### Become a NitrousTracker developer!
40-
41-
The source and all the info on how to get started is here:
42-
43-
https://github.com/NitrousTracker/nitroustracker
44-
45-
If you want to contribute a pull request, go right ahead!
46-
4726
## Credits
4827

4928
This manual was [originally](https://web.archive.org/web/20150205173143/http://nitrotracker.tobw.net/index.php?cat_id=4)
@@ -99,4 +78,4 @@ if you are missing your name here :-)
9978
* My friends in `#dsdev` for patiently answering my questions
10079
* starpause for providing the samples used in the tutorial
10180
* Michael Krause for the open source SoundTracker, that was a great help with the XM format
102-
* Last but not least: Vogue and Mr.H of Triton for Fasttracker II, the tracker that NitroTracker was designed after.
81+
* Last but not least: Vogue and Mr.H of Triton for Fasttracker II, the tracker that NitroTracker was designed after.

0 commit comments

Comments
 (0)