Skip to content

Commit e7dd46f

Browse files
authored
Update readme for 0.3
1 parent a42e6b9 commit e7dd46f

File tree

1 file changed

+30
-19
lines changed

1 file changed

+30
-19
lines changed

Diff for: LinuxReadMe

+30-19
Original file line numberDiff line numberDiff line change
@@ -15,48 +15,57 @@ chmod +x install.sh && ./install.sh
1515
After it says "Done" you can exit your terminal.
1616
Then just use the desktop shortcut to enjoy!
1717

18+
Note: Run the installer again if you move the file at all
19+
1820

1921
Usage/About
2022
============================
2123

22-
This software ONLY accepts input(mics) audio streams for now.
24+
General:
25+
26+
- This software ONLY accepts input(mics) audio streams for now.
27+
28+
- To use your speaker's audio I recommend using jack like in this guide:
29+
https://forum.manjaro.org/t/how-to-replace-pulseaudio-with-jack-jack-and-pulseaudio-together-as-friend/2086
30+
31+
Or something like this: https://unix.stackexchange.com/questions/82259/how-to-pipe-audio-output-to-mic-input#
32+
33+
- The FPS combo box is the global timer. So if you set it higher, everything will run faster and vice versa.
2334

24-
To use your speaker's audio I recommend using jack like in this guide:
25-
https://forum.manjaro.org/t/how-to-replace-pulseaudio-with-jack-jack-and-pulseaudio-together-as-friend/2086
26-
Or by using some other form of loop back software for now.
35+
- The icon is just my profile pic as a place holder until I come with a better custom icon.
2736

28-
The icon is just my profile pic as a place holder until I come with a better custom icon.
2937

3038
Settings:
3139

3240
For best performance leave as default, shrink the program size and lower the FPS as needed.
33-
Use Stats's Late Frames and Latency to gauge performance.
41+
Use Stats|Deadline to gauge performance.
42+
3443

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

37-
Main|Split Audio - Splits the audio into left(top half) and right(bottom half) channels [5]
46+
Main|Split Audio - Splits the audio into left(top half) and right(bottom half) channels [4]
3847
Main|Curviness - Curves/Smooths the bars with a Savitzky Golay Filter [1]
39-
Main|Interpolation - By averaging old data with new data it makes the bars appear smoother [1]
40-
Main|Frames - Audio frames in the buffer, the higher the number the higher the accuracy [5]
48+
Main|Interpolation - By averaging old data with new data it makes the bars appear less noisy [1]
49+
Main|Audio Buffer - Audio frames in the buffer. The higher the number the higher the accuracy, but old data lingers [3]
4150

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

49-
Stats|Frequencies - Reveals the frequency plots(sample rate / frames) of the bars [5]
50-
Stats|Notes - Places notes to the closest given frequency plot [4]
51-
Stats|Late Frames - Tells you how many video frames aren't meeting the frame time(FPS) deadline [0-1]
58+
Stats|Deadline - Tells you the percentage of frames that are meeting the frame time(FPS) deadline [0-1]
5259
Stats|Bars - Tells how many bars are being drawn in the window [0-1]
53-
Stats|Latency - Tells the time in ms(milliseconds) to complete drawing a frame [0-1]
60+
Stats|Latency - Tells the time in ms(milliseconds) from collecting the data to completing a frame [0-1]
5461
Stats|dB Bar - Using a bar it shows you the loudness of the audio in decibels [1]
62+
Stats|Frequencies - Reveals the frequency plots(sample rate / frames) of the bars [5]
63+
Stats|Notes - Places notes to the closest given frequency plot [4]
5564

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

58-
**If you change the width or gap to allow more bars (use Stats|Bars to check) will decrease performance.
59-
Having (Out)line more than 0/enabled will decrease performance.
67+
**If you change the widths to allow more bars (use Stats|Bars to check) will decrease performance.
68+
Having (Out)line Width more than 0/enabled will decrease performance.
6069
And increasing the height to allow the bars to take up more screen space will decrease performance.
6170

6271
Shortcuts:
@@ -68,11 +77,13 @@ Esc - Close program
6877

6978
Tips:
7079

80+
- Due to timings never being perfect, setting a fps slightly above your refresh rate is a good idea.
81+
7182
- If you like to make the background disappear go into Design|Color|Background Color
7283
and change the alpha channel to 0. Then press SHIFT twice for the borders to go away too.
73-
- Using this effect on top of a non-Fullscreen YouTube videos are pretty fun.
84+
- Using this effect on top of a non-Fullscreen YouTube videos is pretty fun.
7485

75-
- Lower the Main|Interpolation for more responsiveness, this helps when you have a low FPS set.
86+
- Lower the Main|Interpolation and Main|Audio Buffer for more responsiveness, this helps when you have a low FPS set.
7687

77-
- For a Monstercat lite-edition style, set Main|Curviness to Sharp, Main|Frames to 8192, scale window to have 64 bars(Stats|Bars)
88+
- For a Monstercat lite-edition style, set Main|Curviness to Sharp, Main|Audio Buffer to 8192, scale window to have 64 bars(Stats|Bars)
7889
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)