Skip to content

docs: remove category column from common settings table #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
oca-agent wants to merge 1 commit into from
Closed

docs: remove category column from common settings table #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,24 +273,24 @@ Create or edit `~/.config/smoc/config.json` to customize settings.
</details>

#### Common Settings
| Category | Key | Type | Default Value | Description |
| :----------------- | :--------------------------------------------- | :----------------- | :----------------- | :------------------------------------------------------------------ |
| **Streaming** | `SmocConfiguration.ActiveService` | `StreamingService` | `YouTubeMusic` | Active service (`YouTubeMusic`, `Subsonic`) |
| **Subsonic** | `SubsonicConfig.ServerScheme` | `string` | `http` | URI Scheme for the Subsonic API |
| | `SubsonicConfig.ServerHost` | `string` | `null` | Hostname of your Subsonic server |
| | `SubsonicConfig.ServerPort` | `int` | `80` | Port of your Subsonic server |
| | `SubsonicConfig.Username` | `string` | `null` | Subsonic username |
| | `SubsonicConfig.Password` | `string` | `null` | Subsonic password |
| | `SubsonicConfig.UseToken` | `bool` | `true` | Whether to use token auth instead of plaintext password |
| **Caching** | `SmocConfiguration.SongCacheSizeBytes` | `long` | `536870912` | Max size of song cache in bytes (512MB, 0 = no limit) |
| | `SmocConfiguration.AlbumCoverCacheSizeBytes` | `long` | `104857600` | Max size of album cover cache in bytes (100MB, 0 = no limit) |
| | `SmocConfiguration.SongCacheMaxElements` | `int` | `0` | Max number of songs to cache (0 = no limit) |
| | `SmocConfiguration.AlbumCoverCacheMaxElements` | `int` | `0` | Max number of album covers to cache (0 = no limit) |
| **Logging** | `SmocConfiguration.LogLevel` | `LogLevel` | `Information` | Min log level (Trace, Debug, Information, Warning, Error, Critical) |
| **Listen History** | `ListenHistory.Enabled` | `bool` | `true` | Whether listen history tracking is enabled |
| | `ListenHistory.MinimumPositionSeconds` | `int` | `30` | Minimum position (seconds) to consider listened |
| | `ListenHistory.MinimumFraction` | `double` | `0.5` | Minimum fraction of a song to consider listened |
| **UI** | `Theme` | `string` | `default` | The name of the theme to use |
| Key | Type | Default Value | Description |
| :--------------------------------------------- | :----------------- | :----------------- | :------------------------------------------------------------------ |
| `SmocConfiguration.ActiveService` | `StreamingService` | `YouTubeMusic` | Active service (`YouTubeMusic`, `Subsonic`) |
| `SubsonicConfig.ServerScheme` | `string` | `http` | URI Scheme for the Subsonic API |
| `SubsonicConfig.ServerHost` | `string` | `null` | Hostname of your Subsonic server |
| `SubsonicConfig.ServerPort` | `int` | `80` | Port of your Subsonic server |
| `SubsonicConfig.Username` | `string` | `null` | Subsonic username |
| `SubsonicConfig.Password` | `string` | `null` | Subsonic password |
| `SubsonicConfig.UseToken` | `bool` | `true` | Whether to use token auth instead of plaintext password |
| `SmocConfiguration.SongCacheSizeBytes` | `long` | `536870912` | Max size of song cache in bytes (512MB, 0 = no limit) |
| `SmocConfiguration.AlbumCoverCacheSizeBytes` | `long` | `104857600` | Max size of album cover cache in bytes (100MB, 0 = no limit) |
| `SmocConfiguration.SongCacheMaxElements` | `int` | `0` | Max number of songs to cache (0 = no limit) |
| `SmocConfiguration.AlbumCoverCacheMaxElements` | `int` | `0` | Max number of album covers to cache (0 = no limit) |
| `SmocConfiguration.LogLevel` | `LogLevel` | `Information` | Min log level (Trace, Debug, Information, Warning, Error, Critical) |
| `ListenHistory.Enabled` | `bool` | `true` | Whether listen history tracking is enabled |
| `ListenHistory.MinimumPositionSeconds` | `int` | `30` | Minimum position (seconds) to consider listened |
| `ListenHistory.MinimumFraction` | `double` | `0.5` | Minimum fraction of a song to consider listened |
| `Theme` | `string` | `default` | The name of the theme to use |

#### Custom Themes
If specifying a custom theme (as in the example config above), you will need to specify styling for all schemes.
Expand Down
Loading