-
Notifications
You must be signed in to change notification settings - Fork 4
/
config.sample.yml
302 lines (302 loc) · 8.62 KB
/
config.sample.yml
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
---
App:
# FirstRun is set to false after user setup the app.
FirstRun: true
# JWT secret used to salt passwords (uuid)
JwtSecret: Change me
# Instance ID
#InstanceID: uuid here
Online:
# Host for your KM Server
Host: kara.moe
Secure: true
# Timeout (in ms) when calling the KM Server
Timeout: 2000
# Should your instance sends stats? True/false. Non-existant means the app will ask the user a question if it wants to send stats to KM Server.
#Stats: false
# Should your instance sends error logs to sentry.io? True/false. Non-existant means the app will ask the user a question if it wants to send errors.
#ErrorTracking: false
# Should we use KM Server's URL shortener? Turns connection URL into http://kara.moe for example
URL: true
# Should we allow users to register/login accounts on kara.moe ?
Users: true
Updates:
App: true
Medias:
Intros: true
Jingles: true
Outros: true
Encores: true
Sponsors: true
# Use Discord's rich presence to display your activity on your profile
Discord:
DisplayActivity: true
# Remote URL xxxx.kara.moe enabled ?
Remote: true
# Remote token for online URL
RemoteToken: uuid_here
# Fetch popular songs from remote repos ?
FetchPopularSongs: true
# Disallow ALL video downloads; We'll give you crepes if you keep this to true
AllowDownloads: true
Frontend:
AllowGuestLogin: true
AllowUserCreation: true
AllowCustomTemporaryGuests: false
# Webapp mode :
# 0 : closed
# 1 : Current playlist/song only (restricted)
# 2 : Opened (all features available)
Mode: 2
PublicPlayerControls: false
ShowAvatarsOnPlaylist: true
# This message will be shown on the login page for your karaoke session
WelcomeMessage: ''
GUI:
# Enable or disable chibi player
ChibiPlayer:
Enabled: false
AlwaysOnTop: true
PositionX: 153
PositionY: 800
# Enable or disable chibi playlist window
ChibiPlaylist:
Enabled: false
AlwaysOnTop: true
PositionX: 153
PositionY: 800
Karaoke:
# Which collections to enable
Collections:
c7db86a0-ff64-4044-9be4-66dd1ef1d1c1: true # Geek
dbcf2c22-524d-4708-99bb-601703633927: true # Asia
efe171c0-e8a1-4d03-98c0-60ecf741ad52: true # West
2fa2fe3f-bb56-45ee-aa38-eae60e76f224: true # Shitpost
# Autostart playing songs if no song is playing and a song is added
Autoplay: false
# Classic (Karaoke box) mode
ClassicMode: false
# Streamer mode options. PauseDuration is in seconds
StreamerMode:
Enabled: false
PauseDuration: 15
Twitch:
Enabled: false
OAuth: ''
Channel: ''
# Repeat playlist once reaching the end
Repeat: false
# In private mode try to insert songs in a smart way.
SmartInsert: false
# Number of minutes before you should be warned your session is going to end
MinutesBeforeEndOfSessionWarning: 15
Poll:
# Number of choices in poll
Choices: 4
# Enable/disable song polls
Enabled: false
# Time before poll closes after beginning in seconds
Timeout: 30
Quota:
# Minutes before a song is automatically freed
FreeAutoTime: 60
# Can songs be freed by users?
FreeUpVote: true
# How many votes are required at minimum to free a song
FreeUpVoteRequiredMin: 3
# How many percent of the connected users are required to free a song
FreeUpVoteRequiredPercent: 33
# Free songs once accepted by an operator from the public playlist
FreeAcceptedSongs: true
# Number of songs per user
Songs: 10000
# Time allowed per user in seconds
Time: 10000
# Type of quota:
# 0 : No quota
# 1 : Song number quota
# 2 : Time allowance quota
Type: 0
Player:
Display:
# Show random quotes on pause screens
RandomQuotes: true
# Show song information at the beginning and end of song
SongInfo: true
# Which language to display song information in
SongInfoLanguage: qro
# Show nickname of the person who requested a song
Nickname: true
ConnectionInfo:
Enabled: true
# Message to display to invite people to connect (or not)
Message: 'Log in at $url to add songs!'
# Override host/IP address
Host: '192.168.0.1'
QRCode: false
# Override mpv's video output driver
mpvVideoOutput: null
# Fullscreen ?
FullScreen: false
# Spawn a second monitor window in PIP mode to check what the player is displaying
Monitor: false
# Should the player window have borders ?
Borders: true
# Which screen to display on (0 is first)
Screen: 0
# Stay on top
StayOnTop: true
# Enable/Disable media keys on your keyboard
KeyboardMediaShortcuts: true
PIP:
# Picture In Picture, like a windowed mode
Enabled: true
# Position for the window on screen
PositionX: Right
PositionY: Bottom
# Size in %
Size: 30
# Volume
Volume: 100
# AudioDelay for audio/video sync
AudioDelay: 0
# Hardware decoding. See mpv manual for more info
HardwareDecoding: auto-safe
# Extra mpv commandline arguments example
ExtraCommandLine: --tone-mapping=reinhard
# Live Comments enabled or not
LiveComments: false
Playlist:
# What to do at the end of playlist :
# - random : plays random songs, should usually be used with autoplay
# - random_fallback : plays random song from the fallback playlist
# - play_fallback : play the fallback playlist
# - repeat : cycles through the playlist
# - none : just end karaoke
EndOfPlaylistAction: none
# Should a message be displayed on screen inviting people to add songs?
RandomSongsAfterEndMessage: true
# Allow duplicates in current playlist
AllowDuplicates: false
# Time after which a song is not considered recently played anymore in minutes
MaxDejaVuTime: 60
# Enable/Disable Intro Videos
IntroVideos: true
# Specify an intro video file. KM will search in all Intro folders for that file and will play it instead of selecting a random one.
Medias:
Jingles:
Enabled: true
Interval: 20
Sponsors:
Enabled: true
Interval: 50
Intros:
Enabled: true
Message: "Let's Karaoke!"
Outros:
Enabled: false
Message: "That's all folks!"
Encores:
Enabled: false
Message: 'This is the last song!'
MysterySongs:
# Invisible songs are not hidden (they appear as a slot in playlist)
Hide: false
# Should songs added by admin be invisible?
AddedSongVisibilityAdmin: false
# Should songs added by public be invisible?
AddedSongVisibilityPublic: false
# List of mystery songs labels
Labels:
- ???
- Mystery song!
System:
# Port to listen to
FrontendPort: 1337
Database:
bundledPostgresBinary: false
database: karaokemugen_app
host: localhost
password: musubi
port: 6559
superuser: postgres
superuserPassword: musubi
username: karaokemugen_app
Binaries:
Player:
Linux: /usr/bin/mpv
OSX: app/bin/mpv.app/Contents/MacOS/mpv
Windows: app/bin/mpv.exe
ffmpeg:
Linux: /usr/bin/ffmpeg
OSX: app/bin/ffmpeg
Windows: app/bin/ffmpeg.exe
Postgres:
Linux: app/bin/postgres/bin/
OSX: app/bin/postgres/bin/
Windows: app/bin/postgres/bin/
patch:
Linux: /usr/bin/patch
OSX: app/bin/patch
Windows: app/bin/patch.exe
Repositories:
- Name: kara.moe
Online: true
Secure: true
Enabled: true
Update: true
Git:
URL: https://gitlab.com/karaokemugen/bases/karaokebase.git
Username: username
Password: pass
Author: Nanamin
Email: [email protected]
ProjectID: 32123952
FTP:
Host: ftphost
Port: 21
Username: nanamin
Password: pass
BaseDir: storage/medias-otaku
SendStats: true
AutoMediaDownloads: updateOnly
# AutoMediaDownloads determines when a song should be downloaded
# 'none' = never
# 'updateOnly' = only when the song has already been downloaded before and it's an update
# 'all' = always
BaseDir: 'repos/kara.moe/git'
Path:
Medias:
- repos/kara.moe/medias
- Name: Local
Online: false
Enabled: true
SendStats: true
BaseDir: 'repos/Local'
Path:
Medias:
- repos/Local/medias
MediaPath:
Jingles:
- jingles
- jingles/KaraokeMugen
Intros:
- intros
- intros/KaraokeMugen
Outros:
- outros
Encores:
- encores
Sponsors:
- sponsors
Path:
Avatars: avatars
Backgrounds: backgrounds
Bin: bin
Fonts: fonts
Import: import
Previews: previews
SessionExports: sessionExports
DB: db
BundledBackgrounds: BundledBackgrounds
StreamFiles: streamfiles