Skip to content

Commit c35a5dd

Browse files
committed
update docs (wip)
1 parent db8f827 commit c35a5dd

File tree

8 files changed

+21
-17
lines changed

8 files changed

+21
-17
lines changed

docs/Changelog.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,18 @@
44

55
### Added: <!-- {docsify-ignore} -->
66

7-
+ New **Advanced** panel to declutter the **Settings** panel of less-used options;
8-
+ New **Band Count** setting;
9-
+ New **Radial Size** setting;
10-
+ New compact analyzer layout for watching videos - customize in *Configuration > Subtitles & Video*;
11-
+ Support for 5.1 surround audio output (experimental - currently works only with single-channel layout);
7+
+ New [**Advanced** panel](advanced.md) to declutter the Settings panel of less-used options;
8+
+ New [**Band Count**](settings.md#band-cound) setting;
9+
+ New [**Radial Size**](advanced.md#radial-size) setting;
10+
+ New compact analyzer layout for watching videos - customize in [*Configuration > Subtitles & Video*](configuration.md#subtitles-amp-video);
11+
+ Support for 5.1 surround audio output - enable it in [*Configuration > General settings*](configuration.md#general-settings) (experimental - currently works only with single-channel layout);
1212
+ Import and export Settings - backup and share your presets in [Discussions > Resources > Presets](https://github.com/hvianna/audioMotion.js/discussions/categories/presets);
1313
+ Import and export Gradients - backup and share your creations in [Discussions > Resources > Gradients](https://github.com/hvianna/audioMotion.js/discussions/categories/gradients);
14-
+ Option to enable/disable letterboxing for video;
15-
+ Option to invert scroll direction for Volume control - suggested by **@JesusGod-Pope666-Info**;
14+
+ Option to enable/disable letterboxing for video, in [*Configuration > Subtitles & Video*](configuration.md#subtitles-amp-video);
15+
+ Option to invert scroll direction for Volume control, in [*Configuration > General settings*](configuration.md#general-settings) - suggested by **@JesusGod-Pope666-Info**;
1616
+ Debug mode with extra messages/events logged to Console;
1717
+ Button to copy messages to clipboard on Console;
18-
+ More intermediate values for *Background Image Dim*, *Bar Spacing*, *FFT Smoothing*, *Fill Opacity*, *Radial Spin* and *Reflex*.
18+
+ More intermediate values for [*Background Dim*](settings.md#background-dim), [*Bar Spacing*](advanced.md#bar-spacing), [*FFT Smoothing*](advanced.md#fft-smoothing), [*Fill Opacity*](advanced.md#fill-opacity), [*Radial Spin*](advanced.md#radial-spin) and [*Reflex*](settings.md#reflex).
1919

2020
### Changed & improved: <!-- {docsify-ignore} -->
2121

@@ -27,7 +27,8 @@
2727
+ Files that fail loading/playing are now flagged in red color in the play queue;
2828
+ Increased the default maximum number of background image files from 20 to 100;
2929
+ Gradients and saved playlists are now listed in alphabetical order in their selection boxes;
30-
+ New default settings: [Background:](settings.md#background) **album cover**; [Bar Spacing:](advanced.md#bar-spacing) **20%**; [Background Dim:](settings.md#background-dim) **0.3**; [Level Scale:](advanced.md#level-scale) **Linear**; [Line Width:](advanced.md#level-scale) **1**; [Radial Size:](advanced.md#radial-size) **0.5**; [Weighting Filter:]((advanced.md#weighting-filter) **D**.
30+
+ New defaults: [Background:](settings.md#background) **album cover**; [Bar Spacing:](advanced.md#bar-spacing) **20%**; [Background Dim:](settings.md#background-dim) **0.3**; [Level Scale:](advanced.md#level-scale) **Linear**; [Line Width:](advanced.md#level-scale) **1**; [Radial Size:](advanced.md#radial-size) **0.5**; [Weighting Filter:]((advanced.md#weighting-filter) **D**;
31+
+ Server configuration file (`config.json`) converted to YAML format (`config.yaml`) - see [Self-hosting > config.yaml file](server.md#configyaml-file) (props to [**@Borewit**](https://github.com/hvianna/audioMotion.js/pull/94)).
3132

3233
### Fixed: <!-- {docsify-ignore} -->
3334

@@ -39,7 +40,6 @@
3940
### Removed: <!-- {docsify-ignore} -->
4041

4142
+ Balance control;
42-
+ `config.json` configuration file converted to YAML - see [Self-hosting > config.yaml file](server.md#configyaml-file) (props to [**@Borewit**](https://github.com/hvianna/audioMotion.js/pull/94)).
4343
+ `mediaPanel` URL parameter has been deprecated - use [`frontPanel`](server.md#url-parameters) instead;
4444
+ Custom file server module (just use `npm start`);
4545
+ Code from the unfinished Electron version;

docs/img/internal-playlists.png

-2 KB
Loading

docs/img/screenshot1.png

-319 KB
Loading

docs/img/screenshot4.jpg

1.19 KB
Loading

docs/img/settings-panel.png

-12.9 KB
Loading

docs/known-issues.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Known issues
22

3+
### Browser requirements
4+
5+
**audioMotion** requires at least Chrome/Chromium 80, Firefox 74 or Safari 13.1.
6+
37
### File System Access API
48

59
Playing music and loading backgrounds from your local device relies on the [File System Access API](https://caniuse.com/native-filesystem-api), which

docs/media-panel.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,17 @@ Click the **Clear** button to clear the play queue.
5555

5656
The play queue is automatically restored the next time you open audioMotion. You can disable this feature in [Configuration > General settings](#general-settings).
5757

58-
**You can save the play queue to internal playlists for quick access.**
58+
<img src="img/internal-playlists.png" class="img-right">
5959

60-
Saved playlists appear in the playlist selection box, as shown below:
60+
**You can save the play queue to internal playlists for quick access.**
6161

62-
![internal-playlists](img/internal-playlists.png)
62+
Saved playlists appear in the playlist selection box (shown right).
6363

6464
Create and manage your playlists using the following buttons:
6565

6666
| Button | Action |
6767
|:-------|:-------|
68-
**Save as...** | Saves the current queue contents to a new playlist
68+
**Save&nbsp;as...** | Saves the current queue contents to a new playlist
6969
**Save** | **Update the selected playlist** with the current queue contents
7070
**Load** | Load the selected playlist, **adding** its contents to the end of the current queue
7171
**Delete** | Permanently delete the selected playlist

docs/screenshots.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# Screenshots
22

33
![screenshot1](img/screenshot1.png)
4-
*User interface showing the analyzer in **Discrete frequencies** mode (using the **Bark** frequency scale), player control panel and media panel.*
4+
*User interface showing the analyzer in **FFT** mode with **Bark** frequency scale. Settings panel selected.*
55

66
![screenshot2](img/screenshot2.png)
7-
*Analyzer set to 1/4th-octave bands mode with LEDS effect and on-screen song information. The **Settings** panel is shown open over the media panel.*
7+
*Analyzer set to 1/3rd-octave bands mode with LEDS effect and on-screen song information. Media panel selected.*
88

99
![screenshot4](img/screenshot4.jpg)
10-
*Video playback with subtitles, hidden media panel, analyzer set to Area graph mode, "Rainbow" gradient, Linear amplitude and Notes scale.*
10+
*Video playback with subtitles, collapsed front panel, [compact analyzer](configuration.md#subtitles-amp-video) set to 1/12th-octave bands and Notes labels displayed in the X-Axis.*
1111

1212
![screenshot3](img/screenshot3.png)
1313
*Fullscreen view: 1/6th-octave bands, "Outrun" gradient, Reflex effect and complete on-screen information.*

0 commit comments

Comments
 (0)