fork/m-overlay

git clone https://git.julia.blue/fork/m-overlay

BkacjiosStylize the Tabs on a TabPanel.be5d99b

settings-overhaul
15.6 KiB489 linesraw
1local PANEL = class.create("Settings", "Panel")
2
3local log = require("log")
4local json = require("serializer.json")
5local notification = require("notification")
6local music = require("music")
7local overlay = require("overlay")
8
9require("extensions.math")
10
11SLIPPI_OFF = 1
12SLIPPI_NETPLAY = 2
13SLIPPI_REPLAY = 3
14
15function PANEL:Settings()
16	self:super() -- Initialize our baseclass
17
18	self:DockMargin(0, 0, 0, 0)
19	self:SizeToScreen()
20	self:SetBackgroundColor(color_blank)
21	self:SetBorderColor(color_blank)
22
23	self.PORTSELECT = self:Add("PortSelect")
24	self.SKINSELECT = self:Add("SkinSelect")
25
26	self.COLORSELECT = self:Add("ColorSelector")
27	self.COLORSELECT:SetSize(296 + 32, 256)
28	self.COLORSELECT:Center()
29	self.COLORSELECT:SetVisible(false)
30
31	self.MAIN = self:Add("TabbedPanel")
32	self.MAIN:SizeToParent()
33	self.MAIN:SetSize(296 + 32, 176)
34	self.MAIN:Center()
35	self.MAIN:DockPadding(0, 0, 0, 0)
36	self.MAIN:Center()
37
38	self.GENERAL = self.MAIN:AddTab("General", "textures/gui/cog.png", true)
39	self.GENERAL:SetBackgroundColor(color(200, 200, 200, 255))
40
41	self.GENERAL.LEFT = self.GENERAL:Add("Panel")
42	self.GENERAL.LEFT:SetWidth(158)
43	self.GENERAL.LEFT:Dock(DOCK_LEFT)
44	self.GENERAL.LEFT:SetBGColor(color_blank)
45	self.GENERAL.LEFT:SetBorderColor(color_blank)
46	self.GENERAL.LEFT:DockPadding(0, 0, 0, 0)
47
48	self.GENERAL.RIGHT = self.GENERAL:Add("Panel")
49	self.GENERAL.RIGHT:SetWidth(158)
50	self.GENERAL.RIGHT:Dock(DOCK_RIGHT)
51	self.GENERAL.RIGHT:SetBGColor(color_blank)
52	self.GENERAL.RIGHT:SetBorderColor(color_blank)
53	self.GENERAL.RIGHT:DockPadding(0, 0, 0, 0)
54
55	self.SLIPPI = self.MAIN:AddTab("Slippi", "textures/gui/slippi.png")
56	self.SLIPPI:SetBackgroundColor(color(33, 186, 69, 255))
57
58	self.MELEE = self.MAIN:AddTab("Melee", "textures/gui/melee.png")
59	self.MELEE:SetBackgroundColor(color(189, 15, 23, 255))
60
61	self.MELEE.VOLUME = self.MELEE:Add("Slider")
62	self.MELEE.VOLUME:SetValue(50)
63	self.MELEE.VOLUME:Dock(DOCK_BOTTOM)
64	self.MELEE.VOLUME:SetTooltipTitle("VOLUME")
65	self.MELEE.VOLUME:SetTooltipBody([[Adjust the volume of the music.]])
66
67	local VOLLABEL = self.MELEE:Add("Label")
68	VOLLABEL:SetText("Music volume")
69	VOLLABEL:SetTextAlignment("center")
70	VOLLABEL:SizeToText()
71	VOLLABEL:Dock(DOCK_BOTTOM)
72	VOLLABEL:SetTextColor(color_white)
73	VOLLABEL:SetShadowDistance(1)
74	VOLLABEL:SetShadowColor(color_black)
75	VOLLABEL:SetFont("fonts/melee-bold.otf", 12)
76
77	function self.MELEE.VOLUME:OnValueChanged(i)
78		music.setVolume(i)
79		VOLLABEL:SetText(("Music Volume - %d%%"):format(i))
80	end
81
82	self.MELEE.LEFT = self.MELEE:Add("Panel")
83	self.MELEE.LEFT:SetWidth(158)
84	self.MELEE.LEFT:Dock(DOCK_LEFT)
85	self.MELEE.LEFT:SetBGColor(color_blank)
86	self.MELEE.LEFT:SetBorderColor(color_blank)
87	self.MELEE.LEFT:DockPadding(0, 0, 0, 0)
88
89	self.MELEE.RIGHT = self.MELEE:Add("Panel")
90	self.MELEE.RIGHT:SetWidth(158)
91	self.MELEE.RIGHT:Dock(DOCK_RIGHT)
92	self.MELEE.RIGHT:SetBGColor(color_blank)
93	self.MELEE.RIGHT:SetBorderColor(color_blank)
94	self.MELEE.RIGHT:DockPadding(0, 0, 0, 0)
95
96	self.SLIPPI.MODE = self.SLIPPI:Add("RadioPanel")
97	self.SLIPPI.MODE:SetWidth(158)
98	self.SLIPPI.MODE:Center(true, true)
99
100	local off = self.SLIPPI.MODE:AddOption(SLIPPI_OFF, "Off")
101	off:SetTooltipTitle("SLIPPI MODE")
102	off:SetTooltipBody([[- Off: Use normal game detection. Supported game list can be found on the github README.]])
103	local netplay = self.SLIPPI.MODE:AddOption(SLIPPI_NETPLAY, "Rollback/Netplay")
104	netplay:SetTooltipTitle("SLIPPI MODE")
105	netplay:SetTooltipBody([[- Rollback/Netplay: Allows the overlay to work properly when playing Slippi online. Will also actively change the overylay to display your current port.]])
106	local mirror = self.SLIPPI.MODE:AddOption(SLIPPI_REPLAY, "Replay/Mirror")
107	mirror:SetTooltipTitle("SLIPPI MODE")
108	mirror:SetTooltipBody([[- Replay/Mirror: Allows the overlay to work when viewing replays or mirroring gameplay from a console.]])
109
110	self.MELEE.MUSIC = self.MELEE.LEFT:Add("Checkbox")
111	self.MELEE.MUSIC:SetText("Music")
112	self.MELEE.MUSIC:Dock(DOCK_TOP)
113
114	self.MELEE.MUSIC:SetTooltipTitle("MELEE MUSIC")
115	self.MELEE.MUSIC:SetTooltipBody([[Enable/Disable custom music for Melee.]])
116
117	function self.MELEE.MUSIC:OnToggle(on)
118		if on then
119			music.onStateChange()
120		else
121			music.kill()
122		end
123	end
124
125	self.MELEE.MUSICLOOP = self.MELEE.LEFT:Add("HorizontalSelect")
126	self.MELEE.MUSICLOOP:Dock(DOCK_TOP)
127
128	self.MELEE.MUSICLOOP:SetTooltipTitle("MUSIC LOOP MODE")
129	self.MELEE.MUSICLOOP:SetTooltipBody([[- Playlist mode: When a song ends, it will play another song in a random order.
130
131-Loop menu: Will play one random song on a loop when in menus.
132
133-Loop stage: Will play one random song on loop when playing on a stage.
134
135-Loop all: Will play one random song on a loop when in the menu system or playing on a stage.
136]])
137
138	LOOPING_OFF = self.MELEE.MUSICLOOP:AddOption("Playlist mode", true) -- 1
139	LOOPING_MENU = self.MELEE.MUSICLOOP:AddOption("Loop menu") -- 2
140	LOOPING_STAGE = self.MELEE.MUSICLOOP:AddOption("Loop stage") -- 3
141	LOOPING_ALL = self.MELEE.MUSICLOOP:AddOption("Loop all") -- 4
142
143	function self.MELEE.MUSICLOOP:OnSelectOption(num)
144		music.onLoopChange(num)
145	end
146
147	local SKIPLABEL = self.MELEE.RIGHT:Add("Label")
148	SKIPLABEL:SetText("Skip track combo")
149	SKIPLABEL:SetTextAlignment("center")
150	SKIPLABEL:SizeToText()
151	SKIPLABEL:SetHeight(24)
152	SKIPLABEL:Dock(DOCK_TOP)
153	SKIPLABEL:SetTextColor(color_white)
154	SKIPLABEL:SetShadowDistance(1)
155	SKIPLABEL:SetShadowColor(color_black)
156	SKIPLABEL:SetFont("fonts/melee-bold.otf", 12)
157
158	self.MELEE.MUSICSKIP = self.MELEE.RIGHT:Add("GCBind")
159	self.MELEE.MUSICSKIP:Dock(DOCK_TOP)
160	self.MELEE.MUSICSKIP:SetTooltipTitle("SKIP TRACK COMBO")
161	self.MELEE.MUSICSKIP:SetTooltipBody([[This button will allow you to a set a button combination on your controller to skip the currently playing music track.
162
163NOTE: This button is only usable when in a supported game.]])
164
165	self.PORTTITLE = self.GENERAL.LEFT:Add("Checkbox")
166	self.PORTTITLE:SetText("Port in title")
167	self.PORTTITLE:Dock(DOCK_TOP)
168	self.PORTTITLE:SetTooltipTitle("PORT IN TITLE")
169	self.PORTTITLE:SetTooltipBody([[Show the current port number being displayed in the application title.]])
170
171	self.ALWAYSPORT = self.GENERAL.LEFT:Add("Checkbox")
172	self.ALWAYSPORT:SetText("Always show port")
173	self.ALWAYSPORT:Dock(DOCK_TOP)
174	self.ALWAYSPORT:SetTooltipTitle("ALWAYS SHOW PORT")
175	self.ALWAYSPORT:SetTooltipBody([[Always show the current port in the bottom left of the overlay window.]])
176
177	function self.PORTTITLE:OnToggle()
178		love.updateTitle(love.getTitleNoPort())
179	end
180
181	self.DPAD = self.GENERAL.RIGHT:Add("Checkbox")
182	self.DPAD:SetText("Show D-Pad")
183	self.DPAD:Dock(DOCK_TOP)
184	self.DPAD:SetTooltipTitle("DIRECTIONAL-PAD")
185	self.DPAD:SetTooltipBody([[Enable/disable the directional pad on the overlay.]])
186
187	self.START = self.GENERAL.RIGHT:Add("Checkbox")
188	self.START:SetText("Show Start")
189	self.START:Dock(DOCK_TOP)
190	self.START:SetTooltipTitle("START BUTTON")
191	self.START:SetTooltipBody([[Enable/disable the start button on the overlay.]])
192
193	self.HIGH_CONTRAST = self.GENERAL.RIGHT:Add("Checkbox")
194	self.HIGH_CONTRAST:SetText("High-contrast")
195	self.HIGH_CONTRAST:Dock(DOCK_TOP)
196	self.HIGH_CONTRAST:SetTooltipTitle("HIGH-CONTRAST")
197	self.HIGH_CONTRAST:SetTooltipBody([[All buttons and joystick-gates with be filled with black for better viewing visibility.
198
19920XX theme is unsupported]])
200
201	self.TRANSPARENCY = self.GENERAL.RIGHT:Add("Slider")
202	self.TRANSPARENCY:SetValue(100)
203	self.TRANSPARENCY:Dock(DOCK_BOTTOM)
204	self.TRANSPARENCY:SetVisible(love.supportsGameCapture())
205	self.TRANSPARENCY:SetTooltipTitle("TRANSPARENCY")
206	self.TRANSPARENCY:SetTooltipBody([[Adjust how transparent the overlay is. This will only function correctly if you are capturing this window in OBS with a "Game Capture" element with transparency enabled.]])
207
208	local TLABEL = self.GENERAL.RIGHT:Add("Label")
209
210	function self.TRANSPARENCY:OnValueChanged(i)
211		TLABEL:SetText(("Transparency - %d%%"):format(i))
212	end
213
214	TLABEL:SetText("Transparency")
215	TLABEL:SizeToText()
216	TLABEL:SetHeight(24)
217	TLABEL:Dock(DOCK_BOTTOM)
218	TLABEL:SetTextColor(color_white)
219	TLABEL:SetShadowDistance(1)
220	TLABEL:SetShadowColor(color_black)
221	TLABEL:SetFont("fonts/melee-bold.otf", 12)
222	TLABEL:SetVisible(love.supportsGameCapture())
223
224	self.BACKGROUNDCOLOR = self.GENERAL.RIGHT:Add("ColorButton")
225	self.BACKGROUNDCOLOR:SetText("Background color")
226	self.BACKGROUNDCOLOR:Dock(DOCK_BOTTOM)
227	self.BACKGROUNDCOLOR:SetVisible(not love.supportsGameCapture())
228	self.BACKGROUNDCOLOR:SetColor(color(34, 34, 34))
229	self.BACKGROUNDCOLOR:SetTooltipTitle("BACKGROUND COLOR")
230	self.BACKGROUNDCOLOR:SetTooltipBody([[Pick a color to change the background color of the overlay window.]])
231
232	self.BACKGROUNDCOLOR.OnClick = function(this)
233		self.COLORSELECT:SetColor(self.BACKGROUNDCOLOR:GetColor())
234		self.COLORSELECT:SetVisible(true)
235		self.COLORSELECT:BringToFront()
236	end
237
238	self.COLORSELECT:SetColorButton(self.BACKGROUNDCOLOR)
239
240	self.CONFIGDIR = self.GENERAL.LEFT:Add("Button")
241	self.CONFIGDIR:SetText("Open config directory")
242	self.CONFIGDIR:Dock(DOCK_BOTTOM)
243	self.CONFIGDIR:SetTooltipTitle("CONFIGURATION DIRECTORY")
244	self.CONFIGDIR:SetTooltipBody([[This button will open the file explorer to M'Overlay's config directory.
245
246This is also the same directory you use to place all your music for Melee.]])
247
248	function self.CONFIGDIR:OnClick()
249		love.system.openURL(("file://%s"):format(love.filesystem.getSaveDirectory()))
250	end
251
252	if love.supportsAttachableConsole() then
253		self.DEBUG = self.GENERAL.LEFT:Add("Checkbox")
254		self.DEBUG:SetText("Debug console")
255		self.DEBUG:Dock(DOCK_BOTTOM)
256		self.DEBUG:SetTooltipTitle("DEBUG CONSOLE")
257		self.DEBUG:SetTooltipBody([[Enable/disable a debug console for developer and debugging purposes.]])
258
259		function self.DEBUG:OnToggle(on)
260			love.console(on)
261		end
262	end
263
264	self.ABOUT = self.MAIN:AddTab("About", "textures/icon.png")
265	self.ABOUT:SetBackgroundColor(color_purple)
266
267	local ICON = self.ABOUT:Add("Image")
268	ICON:SetImage("textures/icon.png")
269	ICON:SetPos(24, 0)
270	ICON:SetSize(96, 96)
271	ICON:CenterVertical()
272
273	local VLABEL = self.ABOUT:Add("Button")
274	VLABEL:SetDrawButton(false)
275	VLABEL:SetText("M'Overlay - " .. love.getMOverlayVersion())
276	VLABEL:SetTextAlignment("center")
277	VLABEL:SetSize(176, 18)
278	VLABEL:Dock(DOCK_RIGHT)
279	VLABEL:SetTextColor(color_white)
280	VLABEL:SetShadowColor(color_black)
281	VLABEL:SetShadowDistance(1)
282	VLABEL:SetFont("fonts/melee-bold.otf", 12)
283
284	function VLABEL:OnClick()
285		love.system.openURL(("https://github.com/bkacjios/m-overlay/tree/v%s"):format(love.getMOverlayVersion()))
286	end
287
288	self.m_sFileName = "config.json"
289
290	--local test = self:Add("ColorPicker")
291	--test:SetSize(256, 256)
292end
293
294function PANEL:UpdateSkins()
295	self.SKINSELECT:UpdateSkins()
296end
297
298function PANEL:ChangeSkin(skin)
299	self.SKINSELECT:ChangeSkin(skin)
300end
301
302function PANEL:GetSkin()
303	return self.SKINSELECT:GetSkin()
304end
305
306function PANEL:GetPort()
307	return self.PORTSELECT:GetPort()
308end
309
310function PANEL:ChangePort(port)
311	self.PORTSELECT:ChangePort(port)
312end
313
314function PANEL:Toggle()
315	self:SetVisible(not self:IsVisible())
316	if not self:IsVisible() then
317		gui.hideTooltip()
318		self:OnClosed()
319	end
320	self:Center()
321end
322
323function PANEL:GetSaveTable()
324	return {
325		["port"] = overlay.getPort(),
326		["skin"] = overlay.getSkin(),
327		["slippi-mode"] = self:GetSlippiMode(),
328		["port-in-title"] = self:IsPortTitleEnabled(),
329		["always-show-port"] = self:AlwaysShowPort(),
330		["high-contrast"] = self:IsHighContrast(),
331		["enable-dpad"] = self:IsDPadEnabled(),
332		["enable-start"] = self:IsStartEnabled(),
333		["debugging"] = self:IsDebugging(),
334		["transparency"] = self:GetTransparency(),
335		["melee-stage-music"] = self:PlayStageMusic(),
336		["melee-stage-music-loop"] = self:GetMusicLoopMode(),
337		["melee-stage-music-skip-buttons"] = self:GetMusicSkipMask(),
338		["melee-music-volume"] = self:GetVolume(),
339		["background-color"] = self:GetBackgroundColor(),
340	}
341end
342
343function PANEL:GetBackgroundColor()
344	return self.BACKGROUNDCOLOR:GetColor()
345end
346
347function PANEL:IsBinding()
348	return self.MELEE.MUSICSKIP:IsBinding()
349end
350
351function PANEL:GetMusicSkipMask()
352	return self.MELEE.MUSICSKIP:GetButtonCombo()
353end
354
355function PANEL:PlayStageMusic()
356	return self.MELEE.MUSIC:IsToggled()
357end
358
359function PANEL:GetMusicLoopMode()
360	return self.MELEE.MUSICLOOP:GetSelection()
361end
362
363function PANEL:SetVolume(volume)
364	return self.MELEE.VOLUME:SetValue(math.clamp(volume, 0, 100))
365end
366
367function PANEL:GetVolume()
368	return self.MELEE.VOLUME:GetValue()
369end
370
371function PANEL:GetSlippiMode()
372	return self.SLIPPI.MODE:GetOption()
373end
374
375function PANEL:IsSlippiNetplay()
376	return self.SLIPPI.MODE:GetOption() == SLIPPI_NETPLAY
377end
378
379function PANEL:IsSlippiReplay()
380	return self.SLIPPI.MODE:GetOption() == SLIPPI_REPLAY
381end
382
383function PANEL:IsPortTitleEnabled()
384	return self.PORTTITLE:IsToggled()
385end
386
387function PANEL:AlwaysShowPort()
388	return self.ALWAYSPORT:IsToggled()
389end
390
391function PANEL:IsHighContrast()
392	return self.HIGH_CONTRAST:IsToggled()
393end
394
395function PANEL:IsDPadEnabled()
396	return self.DPAD:IsToggled()
397end
398
399function PANEL:IsStartEnabled()
400	return self.START:IsToggled()
401end
402
403function PANEL:IsDebugging()
404	return self.DEBUG and self.DEBUG:IsToggled() or false
405end
406
407function PANEL:GetTransparency()
408	return self.TRANSPARENCY and self.TRANSPARENCY:GetValue() or nil
409end
410
411function PANEL:OnClosed()
412	self:SaveSettings()
413end
414
415function PANEL:NeedsWrite()
416	for k,v in pairs(self:GetSaveTable()) do
417		-- Return true if the last known settings state differs from the current
418		if self.m_tSettings[k] == nil or self.m_tSettings[k] ~= v then
419			return true
420		end
421	end
422	return false
423end
424
425function PANEL:SaveSettings()
426	if not self:NeedsWrite() then return end -- Stop if we don't need to write any changes
427	local f, err = filesystem.newFile(self.m_sFileName, "w")
428	if f then
429		log.warn("Writing to %s", self.m_sFileName)
430		notification.warning(("Writing to %s"):format(self.m_sFileName))
431		self.m_tSettings = self:GetSaveTable()
432		f:write(json.encode(self.m_tSettings, true))
433		f:flush()
434		f:close()
435	else
436		log.error("Failed writing to %s (%s)", self.m_sFileName, err)
437		notification.error(("Failed writing to %s (%s)"):format(self.m_sFileName, err))
438	end
439end
440
441function PANEL:LoadSettings()
442	local settings = self:GetSaveTable()
443
444	local f = filesystem.newFile(self.m_sFileName, "r")
445	if f then
446		for k,v in pairs(json.decode(f:read())) do
447			if settings[k] ~= nil then
448				settings[k] = v
449			elseif k == "hide-dpad" then
450				settings["enable-dpad"] = not v
451				log.debug("[CONFIG] Converting old config setting %q", k)
452			elseif k == "slippi-netplay" and v == true then
453				settings["slippi-mode"] = SLIPPI_NETPLAY
454				log.debug("[CONFIG] Converting old config setting %q", k)
455			elseif k == "stage-music" or k == "stage-music-loop" or k == "music-volume" then
456				settings["melee-" .. k] = v
457				log.debug("[CONFIG] Converting old config setting %q to %q", k, "melee-" .. k)
458			else
459				log.debug("[CONFIG] Ignoring old setting config %q", k)
460			end
461		end
462		f:close()
463	end
464
465	if type(settings["melee-stage-music-loop"]) == "boolean" and settings["melee-stage-music-loop"] == true then
466		settings["melee-stage-music-loop"] = LOOPING_STAGE
467	end
468
469	self.m_tSettings = settings
470
471	overlay.setPort(settings["port"])
472	overlay.setSkin(settings["skin"])
473
474	self.PORTTITLE:SetToggle(settings["port-in-title"], true)
475	self.ALWAYSPORT:SetToggle(settings["always-show-port"], true)
476	self.HIGH_CONTRAST:SetToggle(settings["high-contrast"], true)
477	self.DPAD:SetToggle(settings["enable-dpad"], true)
478	self.START:SetToggle(settings["enable-start"], true)
479	if self.DEBUG then
480		self.DEBUG:SetToggle(love.hasConsole() or settings["debugging"] or false)
481	end
482	self.TRANSPARENCY:SetValue(settings["transparency"])
483	self.SLIPPI.MODE:SetOption(settings["slippi-mode"])
484	self.MELEE.MUSIC:SetToggle(settings["melee-stage-music"], true)
485	self.MELEE.MUSICLOOP:SelectOption(settings["melee-stage-music-loop"] or LOOPING_OFF, true)
486	self.MELEE.MUSICSKIP:UpdateButtonCombo(settings["melee-stage-music-skip-buttons"])
487	self.MELEE.VOLUME:SetValue(settings["melee-music-volume"])
488	self.BACKGROUNDCOLOR:SetColor(color(settings["background-color"]))
489end