Skip to content

Commit d67ec84

Browse files
authored
Update readme for 0.3
1 parent 58f227d commit d67ec84

File tree

1 file changed

+20
-13
lines changed

1 file changed

+20
-13
lines changed

WinReadMe.txt

+20-13
Original file line numberDiff line numberDiff line change
@@ -55,39 +55,44 @@ General:
5555
and change the alpha channel to 0. Then press SHIFT twice.
5656
Press shift once more while on the window to make it reappear.
5757

58+
- The FPS combo box is the global timer. So if you set it higher, everything will run faster and vice versa.
59+
And due to windows sub par timings, setting a high FPS is just a mere suggestion.
60+
Use Stats|Deadline to get an idea if the FPS you set is what you are receiving.
61+
5862
- The icon is just my profile pic as a place holder until I come with a better custom icon.
5963

6064

6165
Settings:
6266

6367
For best performance leave as default, shrink the program size and lower the FPS as needed.
64-
Use Stats's Late Frames and Latency to gauge performance.
68+
Use Stats|Deadline to gauge performance.
69+
6570

6671
On a scale from [0] being negligible/none to [5] being the worst performance cost of settings:
6772

68-
Main|Split Audio - Splits the audio into left(top half) and right(bottom half) channels [5]
73+
Main|Split Audio - Splits the audio into left(top half) and right(bottom half) channels [4]
6974
Main|Curviness - Curves/Smooths the bars with a Savitzky Golay Filter [1]
70-
Main|Interpolation - By averaging old data with new data it makes the bars appear smoother [1]
71-
Main|Frames - Audio frames in the buffer, the higher the number the higher the accuracy [5]
75+
Main|Interpolation - By averaging old data with new data it makes the bars appear less noisy [1]
76+
Main|Audio Buffer - Audio frames in the buffer. The higher the number the higher the accuracy, but old data lingers [3]
7277

7378
Design|Color|Bar Color/Background Color/Outline Color - Allows to pick color and alpha(transparency) [0-2]*
7479
Design|Color|Rainbow - Creates a rainbow effect to the colors of Bars/(Outline Only) based on current Bar Color [1]
75-
Design|Dimensions - Brings up a scroll bars the change dimensions and look of the bars. [0-5]**
80+
Design|Dimensions - Brings up sliders to change the dimensions and look of the bars. [0-5]**
7681
Design|Illuminate - Scales the alpha cap of the bars [2]
7782
Design|Outline Only - If Out Width is more than 0 it will only show the outline. [0]
7883
Design|Cutout - Instead of drawing the bars it will "cut" the background instead [2]
7984

80-
Stats|Frequencies - Reveals the frequency plots(sample rate / frames) of the bars [5]
81-
Stats|Notes - Places notes to the closest given frequency plot [4]
82-
Stats|Late Frames - Tells you how many video frames aren't meeting the frame time(FPS) deadline [0-1]
85+
Stats|Deadline - Tells you the percentage of frames that are meeting the frame time(FPS) deadline [0-1]
8386
Stats|Bars - Tells how many bars are being drawn in the window [0-1]
84-
Stats|Latency - Tells the time in ms(milliseconds) to complete drawing a frame [0-1]
87+
Stats|Latency - Tells the time in ms(milliseconds) from collecting the data to completing a frame [0-1]
8588
Stats|dB Bar - Using a bar it shows you the loudness of the audio in decibels [1]
89+
Stats|Frequencies - Reveals the frequency plots(sample rate / frames) of the bars [5]
90+
Stats|Notes - Places notes to the closest given frequency plot [4]
8691

8792
* If you change the alpha to anything less than 255 will cost some performance.
8893

89-
**If you change the width or gap to allow more bars (use Stats|Bars to check) will decrease performance.
90-
Having (Out)line more than 0/enabled will decrease performance.
94+
**If you change the widths to allow more bars (use Stats|Bars to check) will decrease performance.
95+
Having (Out)line Width more than 0/enabled will decrease performance.
9196
And increasing the height to allow the bars to take up more screen space will decrease performance.
9297

9398
Shortcuts:
@@ -99,7 +104,9 @@ Esc - Close program
99104

100105
Tips:
101106

102-
- Lower the Main|Interpolation for more responsiveness, this helps when you have a low FPS set.
107+
- Due to timings never being perfect, setting a fps slightly above your refresh rate is a good idea.
108+
109+
- Lower the Main|Interpolation and Main|Audio Buffer for more responsiveness, this helps when you have a low FPS set.
103110

104-
- For a Monstercat lite-edition style, set Main|Curviness to Sharp, Main|Frames to 8192, scale window to have 64 bars(Stats|Bars)
111+
- For a Monstercat lite-edition style, set Main|Curviness to Sharp, Main|Audio Buffer to 8192, scale window to have 64 bars(Stats|Bars)
105112
and keep the rest at default. This WILL NOT look the exact same, that was never my goal to begin with.

0 commit comments

Comments
 (0)