Configuration File

Tizonia ships with a configuration file template. See below for the system locations where this template is usually installed. On first use, Tizonia copies this file into the user’s local configuration directory, usually in one of these locations:

  • $HOME/.config/tizonia/tizonia.conf (Debian and AUR installations)

  • $HOME/snap/tizonia/current/.config/tizonia/tizonia.conf (Snap installation)

Customization of this file by the user is typically required, e.g. to add credentials for the subscribed streaming services. Note that Tizonia only reads this file, never writes to it.

Warning

When user names and passwords are stored in your local tizonia.conf, please ensure that this file has the correct file system permissions to prevent other users from accessing your credentials.

E.g.: $ chmod og-rwx $HOME/.config/tizonia/tizonia.conf

Use tizonia --help config for a reminder of the location of the configuration files in the system:

$ tizonia --help config
This software is part of the Tizonia project <https://tizonia.org>

GNU Lesser GPL version 3 <http://gnu.org/licenses/lgpl.html>
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Configuration file: 'tizonia.conf'

Tizonia creates its config file in one of the following locations when it
first starts (add your user credentials here):
    - Debian or AUR packages: $HOME/.config/tizonia/tizonia.conf
    - Snap package: $HOME/snap/tizonia/current/.config/tizonia/tizonia.conf

Example configuration files may also be found at
    - /etc/xdg/tizonia/tizonia.conf or
    - /snap/tizonia/current/etc/xdg/tizonia/tizonia.conf.

tizonia.conf

Note

When Tizonia is upgraded, a new version of the tizonia.conf template is installed in the corresponding system location. An exising configuration file located under the user’s local configuration directory will remain unmodified. In order to access the new features, the user is expected to manually update his/her local configuration file. This is optional however, as an old configuration file will remain functional and backguard-compatible when used by a newer version of the software. Please note the version information at the top of tizonia.conf.

This is the template that ships with the latest version of Tizonia:

  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
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
# -*-Mode: conf; -*-
# tizonia-config v0.21.0 configuration file

[ilcore]
# Tizonia OpenMAX IL Core section

# Component plugins discovery
# -------------------------------------------------------------------------
# A comma-separated list of paths to be scanned by the Tizonia IL Core when
# searching for component plugins
component-paths = /home/joni/temp/lib/tizonia0-plugins12;

# IL Core extension plugins discovery
# -------------------------------------------------------------------------
# A comma-separated list of paths to be scanned by the Tizonia IL Core when
# searching for IL Core extensions (not implemented yet)
extension-paths =


[resource-management]
# Tizonia OpenMAX IL Resource Management (RM) section

# Resource Manager (RM) daemon interface enable/disable switch
# -------------------------------------------------------------------------
# Whether the IL RM functionality is enabled or not
enabled = false

# RM database
# -------------------------------------------------------------------------
# This is the path to the Resource Manager database
rmdb = /home/joni/temp/share/tizrmd/tizrm.db


[plugins]
# OpenMAX IL Component plugins section

# Each key-value pair represents a list of any data that a
# specific component might need. The entries here must honor the following
# format: OMX.component.name.key = <semi-colon-separated list of items>

# ALSA Audio Renderer
# -------------------------------------------------------------------------
#
# OMX.Aratelia.audio_renderer.alsa.pcm.preannouncements_disabled.port0 = false
OMX.Aratelia.audio_renderer.alsa.pcm.alsa_device = default
OMX.Aratelia.audio_renderer.alsa.pcm.alsa_mixer = Master

# PulseAudio Audio Renderer
# -------------------------------------------------------------------------
#
# OMX.Aratelia.audio_renderer.pulseaudio.pcm.preannouncements_disabled.port0 = false
# OMX.Aratelia.audio_renderer.pulseaudio.pcm.default_volume = Value from 0
#                                                             to 100 (Default: 75)


[tizonia]
# Tizonia player section

# The default audio renderer used by the tizonia player
# -------------------------------------------------------------------------
# Valid values are:
# - OMX.Aratelia.audio_renderer.pulseaudio.pcm
# - OMX.Aratelia.audio_renderer.alsa.pcm
default-audio-renderer = OMX.Aratelia.audio_renderer.pulseaudio.pcm


# MPRIS v2 interface enable/disable switch
# -------------------------------------------------------------------------
# Valid values are: true | false
#
mpris-enabled = false


# HTTP proxy server configuration
# -------------------------------------------------------------------------
# NOTE: Proxy configuration is currently only available with the Spotify
# service. It will be ignored with other music services.
#
# proxy.server = Url to the proxy server that should be used.
#                The format is protocol://<host>:port (where protocol
#                is http/https/socks4/socks5). E.g.: http:some.proxy.net:1234
# proxy.user_name = Username to authenticate with proxy server
# proxy.user_password = Password to authenticate with proxy server


# Spotify configuration
# -------------------------------------------------------------------------
# To avoid passing this information on the command line, uncomment
# and configure accordingly
#
# spotify.user     = user
# spotify.password = pass
# spotify.recover_lost_token = false (set to true to continue playback after
#                                     the token has been [spuriously?] lost)
# spotify.allow_explicit_tracks = false (set to true to allow explicit tracks)
# spotify.preferred_bitrate = Three possible values: 96, 160, or 320 ; default: 320


# Google Play Music configuration
# -------------------------------------------------------------------------
# To avoid passing this information on the command line, uncomment and
# configure here.
#
# gmusic.user       = user@gmail.com
# gmusic.password   = pass (account password or app-specific password for
#                          2-factor users)
# gmusic.device_id  = deviceid (16 hex digits, e.g. '1234567890abcdef')
# gmusic.buffer_seconds = size of the audio buffer (in seconds) to use while
#                         downloading streams. Default: 720. Increase in
#                         case of cuts.


# SoundCloud configuration
# -------------------------------------------------------------------------
# To avoid passing this information on the command line, uncomment and
# configure your SoundCloud OAuth token here.
#
# To obtain your OAuth token, Tizonia needs to be granted access to your
# SoundCloud account. Visit https://tizonia.org/docs/soundcloud/ for the
# details.
#
# soundcloud.oauth_token = X-XXXXXX-XXXXXXXX-XXXXXXXXXXXXXX
# soundcloud.buffer_seconds = size of the audio buffer (in seconds) to use
#                             while downloading streams. Default: 600.
#                             Increase in case of cuts.


# Tunein configuration
# -------------------------------------------------------------------------
# To avoid passing this information on the command line, uncomment and
# configure here.
#
#
# tunein.buffer_seconds = size of the audio buffer (in seconds) to use
#                         while downloading streams. Default: 120.
#                         Increase in case of cuts.


# YouTube configuration
# -------------------------------------------------------------------------
# To avoid passing this information on the command line, uncomment and
# configure as needed.
#
# youtube.api_key = youtube api key. Optional but RECOMMENDED to avoid
#                   problems when the daily quota of the interal api key
#                   is exceeded. To create your YouTube api key, see info at:
#                   https://www.slickremix.com/docs/get-api-key-for-youtube/
# youtube.buffer_seconds = size of the audio buffer (in seconds) to use
#                          while downloading streams. Default: 60.
#                          Increase in case of cuts.


# Plex configuration
# -------------------------------------------------------------------------
# To avoid passing this information on the command line, uncomment and
# configure your Plex server and account auth token here.
#
# To find how to obtain a Plex user authentication token, see:
# https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/
#
# plex.base_url = xxxxxxxxxxxxxx (e.g. http://plexserver:32400)
# plex.auth_token = xxxxxxxxxxxxxx (e.g. SrPEojhap3H5Qj2DmjhX)
# plex.buffer_seconds = size of the audio buffer (in seconds) to use
#                       while downloading streams. Default: 600.
#                       Increase in case of cuts.
# plex.music_section_name = name of the music section in your plex library
#                           (default: Music)


# iHeart configuration
# -------------------------------------------------------------------------
# To avoid passing this information on the command line, uncomment and
# configure here.
#
#
# iheart.buffer_seconds = size of the audio buffer (in seconds) to use
#                         while downloading streams. Default: 120.
#                         Increase in case of cuts.


[color-themes]
# Tizonia uses around 16 different colors while displaying information on the
# terminal. These colors are referred to in this configuration file as:
# C01, C02, ..., C15, C16.
#
# There are three options for specifying the color codes (depending on the
# number of colors supported by the terminal; most terminals should support all
# three options).
#
# OPTION 1: 3/4-bit color codes
#     https://en.wikipedia.org/wiki/ANSI_escape_code#3/4_bit
#           Normal FG colors: 30-37 - Bright FG colors: 90-97
#           Normal BG colors: 40-47 - Bright BG colors: 100-107
#
# OPTION 2: 8-bit color codes:
#     https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit
#           38,5,⟨n⟩ -> Foreground color
#           48,5,⟨n⟩ -> Background color
#
# OPTION 3: 24-bit color codes:
#     https://en.wikipedia.org/wiki/ANSI_escape_code#24-bit
#           38,2,⟨r⟩,⟨g⟩,⟨b⟩ -> RGB foreground color
#           48,2,⟨r⟩,⟨g⟩,⟨b⟩ -> RGB background color
#
# In addition to the foreground and background color codes, the font display
# attributes or 'decorations' may also be specified.
#
# Display attributes (a.k.a. decorations):
#     https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
#           1 -> Bold, 2 -> Faint, 3 -> Italic, 4 -> Underline, 5 -> Slow blink,
#           etc...
#
# Then, to specify a C01-C16 color for Tizonia, choose one of the bit depth
# options above and compose your Cxy code like this:
#
# Cxy = <fg>,<bg>,<attr>
#
# Note that there is no need to provide all three of <fg>, <bg> and <attr>, but
# at least one of them should be given for the Cxy color to be of any use.
#
# You can use multiple bit-depth definitions in a color theme (e.g. C01-C08
# defined using 3/4 bit codes, and C09-C16 using 24-bit), but you should stick
# with one bit-depth for <fg>,<bg> within the same Cxy definition.
#
#
#
# There are four color themes available in this config file:
#
#  tizonia (the default theme), black, blink, and monokai
#
# To activate a color theme, add its name and uncomment the following line.
#
# active-theme = tizonia


# 'tizonia' color theme (default 3/4-bit theme).
# =============================================
# NOTE: C01-C07 -> Misc. colors.
# NOTE: C08-C12 -> These usually are bright FG colors, for some important messages.
# NOTE: C13-C16 -> The colors used in the progress bar display.
# IMPORTANT: Only commas are allowed between digits in the color definition, no SPACES!.
# ---------------------------------------------
tizonia.C01 = 31        # Red     FG, no BG or Decoration - Hint: error messages.
tizonia.C02 = 32        # Green   FG, no BG or Decoration - Hint: higher importance info messages.
tizonia.C03 = 33        # Yellow  FG, no BG or Decoration - Hint: song/stream title.
tizonia.C04 = 34        # Blue    FG, no BG or Decoration - Hint: normal importance info messages.
tizonia.C05 = 35        # Magenta FG, no BG or Decoration - Hint: other info messages (e.g. '2 Ch, 44.1 KHz, 16:s:b').
tizonia.C06 = 36        # Cyan    FG, no BG or Decoration - Hint: various song/stream infos (e.g. album, duration, etc).
tizonia.C07 = 37        # White   FG, no BG or Decoration - Hint: seldom used. For future use.

tizonia.C08 = 91        # Bright Red     FG, no BG or Decoration - Hint: additional error messages.
tizonia.C09 = 92        # Bright Green   FG, no BG or Decoration - Hint: additional higher importance info messages.
tizonia.C10 = 93        # Bright Yellow  FG, no BG or Decoration - Hint: useful data, highlighted messages.
tizonia.C11 = 94        # Bright Blue    FG, no BG or Decoration - Hint: tracks the in playlist.
tizonia.C12 = 95        # Bright Magenta FG, no BG or Decoration - Hint: other useful data messages.

tizonia.C13 = 36        # Cyan FG  - Hint: the percentage bar.
tizonia.C14 = 37        # White FG - Hint: the digits in the percentage bar.
tizonia.C15 = 41        # Red BG   - Hint: the song's elapsed time.
tizonia.C16 = 46        # Cyan BG  - Hint: the moving progress bar itself (IMPORTANT: This must a BG code, no FG or attr.).

# 'Black' color theme (8-bit).
# ===========================
# NOTE: C01-C07 -> Misc. colors.
# NOTE: C08-C12 -> These usually are bright FG colors, for some important messages.
# NOTE: C13-C16 -> The colors used in the progress bar display.
# IMPORTANT: Only commas are allowed between digits in the color definition, no SPACES!.
# ---------------------------
black.C01 = 38,5,9               # Hint: error messages.
black.C02 = 38,5,249             # Hint: higher importance info messages.
black.C03 = 38,5,253,1           # Hint: song/stream title.
black.C04 = 38,5,243             # Hint: normal importance info messages.
black.C05 = 38,5,241             # Hint: other info messages (e.g. '2 Ch, 44.1 KHz, 16:s:b').
black.C06 = 38,5,238             # Hint: various song/stream infos (e.g. album, duration, etc).
black.C07 = 38,5,255             # Hint: seldom used. For future use.

black.C08 = 38,5,9               # Hint: additional error messages.
black.C09 = 38,5,230,48,5,233    # Hint: additional higher importance info messages.
black.C10 = 38,5,245,48,5,233    # Hint: useful data, highlighted messages.
black.C11 = 38,5,251,48,5,233,3  # Hint: tracks the in playlist.
black.C12 = 38,5,245,48,5,233    # Hint: other useful data messages.

black.C13 = 38,5,231             # Hint: the percentage bar.
black.C14 = 38,5,244             # Hint: the digits in the percentage bar.
black.C15 = 48,5,243             # Hint: the song's elapsed time (a BG code).
black.C16 = 48,5,237             # Hint: the moving progress bar itself (a BG code).

# 'Blink' color theme (24-bit).
# =============================
# NOTE: C01-C07 -> Misc. colors.
# NOTE: C08-C12 -> These usually are bright FG colors, for some important messages.
# NOTE: C13-C16 -> The colors used in the progress bar display.
# IMPORTANT: Only commas are allowed between digits in the color definition, no SPACES!.
# -----------------------------
blink.C01 = 38,2,255,255,255,48,2,235,21,25    # Hint: error messages  (default theme: red)
blink.C02 = 38,2,74,143,115                    # Hint: higher importance info messages  (default theme: green)
blink.C03 = 38,2,93,213,222,48,2,12,23,171,1   # Hint: song/stream title  (default theme: yellow)
blink.C04 = 38,2,42,10,252                     # Hint: normal importance info messages  (default theme: blue)
blink.C05 = 38,2,66,135,245,48,2,35,40,48,1    # Hint: other info messages (e.g. '2 Ch, 44.1 KHz, 16:s:b')  (default theme: magenta)
blink.C06 = 38,2,235,171,21,48,2,57,58,59,3    # Hint: various song/stream infos (e.g. album, duration, etc)  (default theme: cyan)
blink.C07 = 38,2,255,255,255                   # Hint: seldom used. For future use (default theme: white)

blink.C08 = 38,2,255,255,255,48,2,235,21,25    # Hint: additional error messages.
blink.C09 = 38,2,27,227,147                    # Hint: additional higher importance info messages.
blink.C10 = 38,2,222,174,18                    # Hint: useful data, highlighted messages.
blink.C11 = 38,2,214,55,219                    # Hint: tracks the in playlist.
blink.C12 = 38,2,255,255,255                   # Hint: other useful data messages.

blink.C13 = 38,2,74,143,115,5                  # Hint: the percentage bar.
blink.C14 = 38,2,92,90,85                      # Hint: the digits in the percentage bar. (NOTE: decoration: 5 -> blink)
blink.C15 = 38,2,93,213,222,48,2,46,38,140,1   # Hint: the song's elapsed time.
blink.C16 = 48,2,93,213,222                    # Hint: the moving progress bar itself (IMPORTANT: This must a BG code, no FG or attr.).

# 'Monokai' color theme (24-bit).
# ==============================
# NOTE: C01-C07 -> Misc. colors.
# NOTE: C08-C12 -> These usually are bright FG colors, for some important messages.
# NOTE: C13-C16 -> The colors used in the progress bar display.
# IMPORTANT: Only commas are allowed between digits in the color definition, no spaces PLEASE!.
# ------------------------------
monokai.C01 = 38,2,121,121,121         # Hint: error messages  (default theme: red)
monokai.C02 = 38,2,214,214,214         # Hint: higher importance info messages  (default theme: green)
monokai.C03 = 38,2,229,181,103,4       # Hint: song/stream title  (default theme: yellow)
monokai.C04 = 38,2,180,210,115         # Hint: normal importance info messages  (default theme: blue)
monokai.C05 = 38,2,232,125,62          # Hint: other info messages (e.g. '2 Ch, 44.1 KHz, 16:s:b')  (default theme: magenta)
monokai.C06 = 38,2,158,134,200         # Hint: various song/stream infos (e.g. album, duration, etc)  (default theme: cyan)
monokai.C07 = 38,2,255,255,255         # Hint: seldom used. For future use (default theme: white)

monokai.C08 = 38,2,249,38,114          # Hint: additional error messages.
monokai.C09 = 38,2,102,217,239         # Hint: additional higher importance info messages.
monokai.C10 = 38,2,166,226,46          # Hint: useful data, highlighted messages.
monokai.C11 = 38,2,253,151,31          # Hint: tracks the in playlist.
monokai.C12 = 38,2,255,255,255         # Hint: other useful data messages.

monokai.C13 = 38,2,174,129,255         # Hint: the percentage bar.
monokai.C14 = 38,2,92,90,85            # Hint: the digits in the percentage bar. (NOTE: decoration: 5 -> blink)
monokai.C15 = 48,2,115,109,56,1        # Hint: the song's elapsed time.
monokai.C16 = 48,2,39,40,34            # Hint: the moving progress bar itself (IMPORTANT: This must a BG code, no FG or attr.).