-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathUsage.txt
78 lines (55 loc) · 3.63 KB
/
Usage.txt
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
text2vol4, replaces text2data for famitone2
doug fraker, 9-17-2018, unofficial update, nesdoug.com
additions so far:
-volume column support
-full note range
-1xx,2xx,4xx effects
version4.1:
-added command line switch -allin to prevent removing unused instruments
-added command line switch -Wno to ignore warnings about unsupported effects
-fixed bug, multiple D00 effects (different channels) incorrect pattern length
-fixed bug, Bxx below D00 effect (different channels) incorrect pattern length
-fixed bug, Bxx loop back causing wrong instrument inserted at loop point
example of new switches:
text2vol4 filename.txt -ca65 -allin -Wno
usage notes:
-use the "v1.15 by Shiru 04'17" version of nsf2data (included) for sound effects.
-must use with famitone4 asm files
-should use with famitracker 0.4.6 (or later) text export
-use volume column for Square 1, Square 2, and Noise Channels
-at the start of a song, the volume column is assumed to be 'f'
-if you loop backwards, use a volume column entry for the first note at the loop point, or else it will carry over whatever volume is still loaded
Example - at the start of the loop, you fail to put a volume column entry, but at the end of the loop, you fade out to zero. When it loops backwards, the volume will still be set to zero.
-use any note for Square 1 + 2, Triangle, or Noise Channel
-restrict DPCM to C-1 to D-6
-pal support has been removed. only the ntsc note table remains.
added features:
-use the command line -allin to ensure all instruments are output, even if no song uses it. this may come in handy if you have too many songs and need to split the famitracker file into 2 parts.
-the song titles will appear in comments in the asm data. This may come in handy if you need to cut or move 1 song for space reasons.
***new with version 4 - support for 1xx,2xx,4xx effects. They apply to the Square and Triangle channels. Use 100 or 200 to disable the pitch bend. Use 400 to disable to vibrato. The vibrato speed (4xy where x is speed) is permanently set to 8. I recommend that you write all the vibrato effects like 481 482 483, etc. "a" (like 48a) is the maximum depth. Don't try b-f.
You can put a 1xx(2xx) and 4xx effect at the same time on a note, but not on the same line...only 1 fx column is allowed(per channel), so 1xx(2xx) on the first line and 4xx on the line below that.
It's not perfectly the same as famitracker. You might have to make slight adjustments to get it to do what you want.
comparison:
-a level of efficiency has been removed to make room for more elements
-even without volume column, file sizes could be 110-125% of what they would have been in the official famitone2
-every volume column entry will add another byte
-every fx change will add another byte
other notes:
-i've marked all changes with ** or *** in the files and in the source code
-i have not modified the licence, which states...
The library is open source and released into the Public Domain. You can
use it for any purpose without restrictions: redistribute, modify, use
for commercial and non-commercial projects. You may credit the author,
inform the author about your project, donate, etc, but nothing is
obligatory, you could do it at free will. Obviously, the library
provided AS IS without warranties of any kind, the author is not
responsible for anything.
-Shiru wrote the original famitone2 library
comparisson famitone2 vs famitone3.2:
-ROM space, about 16 bytes bigger
-RAM usage, 6 bytes more
-CPU usage, about 350 cycles more per frame
comparisson famitone2 vs famitone4:
-ROM space, about 490 bytes bigger
-RAM usage, 25 bytes more
-CPU usage, about ? 500 cycles more per frame