mirror of
https://github.com/goatcorp/Dalamud.git
synced 2026-02-19 14:27:45 +01:00
initial implementation of new auto-update UX
This commit is contained in:
goat
parent
c926a13848
commit
8d18940108
17 changed files with 1115 additions and 229 deletions
|
|
@ -21,7 +21,7 @@ namespace Dalamud.Interface.Internal.Windows.Settings;
|
|||
/// </summary>
|
||||
internal class SettingsWindow : Window
|
||||
{
|
||||
private SettingsTab[]? tabs;
|
||||
private readonly SettingsTab[] tabs;
|
||||
|
||||
private string searchInput = string.Empty;
|
||||
private bool isSearchInputPrefilled = false;
|
||||
|
|
@ -42,6 +42,16 @@ internal class SettingsWindow : Window
|
|||
};
|
||||
|
||||
this.SizeCondition = ImGuiCond.FirstUseEver;
|
||||
|
||||
this.tabs =
|
||||
[
|
||||
new SettingsTabGeneral(),
|
||||
new SettingsTabLook(),
|
||||
new SettingsTabAutoUpdates(),
|
||||
new SettingsTabDtr(),
|
||||
new SettingsTabExperimental(),
|
||||
new SettingsTabAbout()
|
||||
];
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
|
|
@ -75,15 +85,6 @@ internal class SettingsWindow : Window
|
|||
/// <inheritdoc/>
|
||||
public override void OnOpen()
|
||||
{
|
||||
this.tabs ??= new SettingsTab[]
|
||||
{
|
||||
new SettingsTabGeneral(),
|
||||
new SettingsTabLook(),
|
||||
new SettingsTabDtr(),
|
||||
new SettingsTabExperimental(),
|
||||
new SettingsTabAbout(),
|
||||
};
|
||||
|
||||
foreach (var settingsTab in this.tabs)
|
||||
{
|
||||
settingsTab.Load();
|
||||
|
|
@ -142,7 +143,7 @@ internal class SettingsWindow : Window
|
|||
flags |= ImGuiTabItemFlags.SetSelected;
|
||||
this.setActiveTab = null;
|
||||
}
|
||||
|
||||
|
||||
using var tab = ImRaii.TabItem(settingsTab.Title, flags);
|
||||
if (tab)
|
||||
{
|
||||
|
|
@ -152,10 +153,14 @@ internal class SettingsWindow : Window
|
|||
settingsTab.OnOpen();
|
||||
}
|
||||
|
||||
// Don't add padding for the about tab(credits)
|
||||
using var padding = ImRaii.PushStyle(ImGuiStyleVar.WindowPadding, new Vector2(2, 2),
|
||||
settingsTab is not SettingsTabAbout);
|
||||
using var borderColor = ImRaii.PushColor(ImGuiCol.Border, ImGui.GetColorU32(ImGuiCol.ChildBg));
|
||||
using var tabChild = ImRaii.Child(
|
||||
$"###settings_scrolling_{settingsTab.Title}",
|
||||
new Vector2(-1, -1),
|
||||
false);
|
||||
true);
|
||||
if (tabChild)
|
||||
settingsTab.Draw();
|
||||
}
|
||||
|
|
@ -281,25 +286,15 @@ internal class SettingsWindow : Window
|
|||
|
||||
private void SetOpenTab(SettingsOpenKind kind)
|
||||
{
|
||||
switch (kind)
|
||||
this.setActiveTab = kind switch
|
||||
{
|
||||
case SettingsOpenKind.General:
|
||||
this.setActiveTab = this.tabs[0];
|
||||
break;
|
||||
case SettingsOpenKind.LookAndFeel:
|
||||
this.setActiveTab = this.tabs[1];
|
||||
break;
|
||||
case SettingsOpenKind.ServerInfoBar:
|
||||
this.setActiveTab = this.tabs[2];
|
||||
break;
|
||||
case SettingsOpenKind.Experimental:
|
||||
this.setActiveTab = this.tabs[3];
|
||||
break;
|
||||
case SettingsOpenKind.About:
|
||||
this.setActiveTab = this.tabs[4];
|
||||
break;
|
||||
default:
|
||||
throw new ArgumentOutOfRangeException(nameof(kind), kind, null);
|
||||
}
|
||||
SettingsOpenKind.General => this.tabs[0],
|
||||
SettingsOpenKind.LookAndFeel => this.tabs[1],
|
||||
SettingsOpenKind.AutoUpdates => this.tabs[2],
|
||||
SettingsOpenKind.ServerInfoBar => this.tabs[3],
|
||||
SettingsOpenKind.Experimental => this.tabs[4],
|
||||
SettingsOpenKind.About => this.tabs[5],
|
||||
_ => throw new ArgumentOutOfRangeException(nameof(kind), kind, null),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,254 @@
|
|||
using System.Collections.Generic;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Linq;
|
||||
using System.Numerics;
|
||||
|
||||
using CheapLoc;
|
||||
using Dalamud.Configuration.Internal;
|
||||
using Dalamud.Interface.Colors;
|
||||
using Dalamud.Interface.Components;
|
||||
using Dalamud.Interface.Internal.DesignSystem;
|
||||
using Dalamud.Interface.Utility;
|
||||
using Dalamud.Interface.Utility.Raii;
|
||||
using Dalamud.Plugin.Internal;
|
||||
using Dalamud.Plugin.Internal.AutoUpdate;
|
||||
using Dalamud.Plugin.Internal.Types;
|
||||
|
||||
using ImGuiNET;
|
||||
|
||||
namespace Dalamud.Interface.Internal.Windows.Settings.Tabs;
|
||||
|
||||
[SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "Internals")]
|
||||
public class SettingsTabAutoUpdates : SettingsTab
|
||||
{
|
||||
private AutoUpdateBehavior behavior;
|
||||
private bool checkPeriodically;
|
||||
private string pickerSearch = string.Empty;
|
||||
private List<AutoUpdatePreference> autoUpdatePreferences = [];
|
||||
|
||||
public override SettingsEntry[] Entries { get; } = Array.Empty<SettingsEntry>();
|
||||
|
||||
public override string Title => Loc.Localize("DalamudSettingsAutoUpdates", "Auto-Updates");
|
||||
|
||||
public override void Draw()
|
||||
{
|
||||
ImGuiHelpers.SafeTextColoredWrapped(ImGuiColors.DalamudWhite, Loc.Localize("DalamudSettingsAutoUpdateHint",
|
||||
"Dalamud can update your plugins automatically, making sure that you always " +
|
||||
"have the newest features and bug fixes. You can choose when and how auto-updates are run here."));
|
||||
ImGuiHelpers.ScaledDummy(2);
|
||||
|
||||
ImGuiHelpers.SafeTextColoredWrapped(ImGuiColors.DalamudGrey, Loc.Localize("DalamudSettingsAutoUpdateDisclaimer1",
|
||||
"You can always update your plugins manually by clicking the update button in the plugin list. " +
|
||||
"You can also opt into updates for specific plugins by right-clicking them and selecting \"Always auto-update\"."));
|
||||
ImGuiHelpers.SafeTextColoredWrapped(ImGuiColors.DalamudGrey, Loc.Localize("DalamudSettingsAutoUpdateDisclaimer2",
|
||||
"Dalamud will never bother you about updates while you are not idle."));
|
||||
|
||||
ImGuiHelpers.ScaledDummy(8);
|
||||
|
||||
ImGuiHelpers.SafeTextColoredWrapped(ImGuiColors.DalamudWhite, Loc.Localize("DalamudSettingsAutoUpdateBehavior",
|
||||
"When the game starts..."));
|
||||
var behaviorInt = (int)this.behavior;
|
||||
ImGui.RadioButton(Loc.Localize("DalamudSettingsAutoUpdateNone", "Do not check for updates automatically"), ref behaviorInt, (int)AutoUpdateBehavior.None);
|
||||
ImGui.RadioButton(Loc.Localize("DalamudSettingsAutoUpdateNotify", "Only notify me of new updates"), ref behaviorInt, (int)AutoUpdateBehavior.OnlyNotify);
|
||||
ImGui.RadioButton(Loc.Localize("DalamudSettingsAutoUpdateMainRepo", "Auto-update main repository plugins"), ref behaviorInt, (int)AutoUpdateBehavior.UpdateMainRepo);
|
||||
ImGui.RadioButton(Loc.Localize("DalamudSettingsAutoUpdateAll", "Auto-update all plugins"), ref behaviorInt, (int)AutoUpdateBehavior.UpdateAll);
|
||||
this.behavior = (AutoUpdateBehavior)behaviorInt;
|
||||
|
||||
if (this.behavior == AutoUpdateBehavior.UpdateAll)
|
||||
{
|
||||
var warning = Loc.Localize(
|
||||
"DalamudSettingsAutoUpdateAllWarning",
|
||||
"Warning: This will update all plugins, including those not from the main repository.\n" +
|
||||
"These updates are not reviewed by the Dalamud team and may contain malicious code.");
|
||||
ImGuiHelpers.SafeTextColoredWrapped(ImGuiColors.DalamudOrange, warning);
|
||||
}
|
||||
|
||||
ImGuiHelpers.ScaledDummy(8);
|
||||
|
||||
ImGui.Checkbox(Loc.Localize("DalamudSettingsAutoUpdatePeriodically", "Periodically check for new updates while playing"), ref this.checkPeriodically);
|
||||
ImGuiHelpers.SafeTextColoredWrapped(ImGuiColors.DalamudGrey, Loc.Localize("DalamudSettingsAutoUpdatePeriodicallyHint",
|
||||
"Plugins won't update automatically after startup, you will only receive a notification while you are not actively playing."));
|
||||
|
||||
ImGuiHelpers.ScaledDummy(5);
|
||||
ImGui.Separator();
|
||||
ImGuiHelpers.ScaledDummy(5);
|
||||
|
||||
ImGuiHelpers.SafeTextColoredWrapped(ImGuiColors.DalamudWhite, Loc.Localize("DalamudSettingsAutoUpdateOptedIn",
|
||||
"Per-plugin overrides"));
|
||||
|
||||
ImGuiHelpers.SafeTextColoredWrapped(ImGuiColors.DalamudWhite, Loc.Localize("DalamudSettingsAutoUpdateOverrideHint",
|
||||
"Here, you can choose to receive or not to receive updates for specific plugins. " +
|
||||
"This will override the settings above for the selected plugins."));
|
||||
|
||||
if (this.autoUpdatePreferences.Count == 0)
|
||||
{
|
||||
ImGuiHelpers.ScaledDummy(20);
|
||||
|
||||
using (ImRaii.PushColor(ImGuiCol.Text, ImGuiColors.DalamudGrey))
|
||||
{
|
||||
ImGuiHelpers.CenteredText(Loc.Localize("DalamudSettingsAutoUpdateOptedInHint2",
|
||||
"You did not override auto-updates for any plugins yet."));
|
||||
}
|
||||
|
||||
ImGuiHelpers.ScaledDummy(2);
|
||||
}
|
||||
else
|
||||
{
|
||||
ImGuiHelpers.ScaledDummy(5);
|
||||
|
||||
var pic = Service<PluginImageCache>.Get();
|
||||
|
||||
var windowSize = ImGui.GetWindowSize();
|
||||
var pluginLineHeight = 32 * ImGuiHelpers.GlobalScale;
|
||||
Guid? wantRemovePluginGuid = null;
|
||||
|
||||
foreach (var preference in this.autoUpdatePreferences)
|
||||
{
|
||||
var pmPlugin = Service<PluginManager>.Get().InstalledPlugins
|
||||
.FirstOrDefault(x => x.EffectiveWorkingPluginId == preference.WorkingPluginId);
|
||||
|
||||
var btnOffset = 2;
|
||||
|
||||
if (pmPlugin != null)
|
||||
{
|
||||
var cursorBeforeIcon = ImGui.GetCursorPos();
|
||||
pic.TryGetIcon(pmPlugin, pmPlugin.Manifest, pmPlugin.IsThirdParty, out var icon, out _);
|
||||
icon ??= pic.DefaultIcon;
|
||||
|
||||
ImGui.Image(icon.ImGuiHandle, new Vector2(pluginLineHeight));
|
||||
|
||||
if (pmPlugin.IsDev)
|
||||
{
|
||||
ImGui.SetCursorPos(cursorBeforeIcon);
|
||||
ImGui.PushStyleVar(ImGuiStyleVar.Alpha, 0.7f);
|
||||
ImGui.Image(pic.DevPluginIcon.ImGuiHandle, new Vector2(pluginLineHeight));
|
||||
ImGui.PopStyleVar();
|
||||
}
|
||||
|
||||
ImGui.SameLine();
|
||||
|
||||
var text = $"{pmPlugin.Name}{(pmPlugin.IsDev ? " (dev plugin" : string.Empty)}";
|
||||
var textHeight = ImGui.CalcTextSize(text);
|
||||
var before = ImGui.GetCursorPos();
|
||||
|
||||
ImGui.SetCursorPosY(ImGui.GetCursorPosY() + (pluginLineHeight / 2) - (textHeight.Y / 2));
|
||||
ImGui.TextUnformatted(text);
|
||||
|
||||
ImGui.SetCursorPos(before);
|
||||
}
|
||||
else
|
||||
{
|
||||
ImGui.Image(pic.DefaultIcon.ImGuiHandle, new Vector2(pluginLineHeight));
|
||||
ImGui.SameLine();
|
||||
|
||||
var text = Loc.Localize("DalamudSettingsAutoUpdateOptInUnknownPlugin", "Unknown plugin");
|
||||
var textHeight = ImGui.CalcTextSize(text);
|
||||
var before = ImGui.GetCursorPos();
|
||||
|
||||
ImGui.SetCursorPosY(ImGui.GetCursorPosY() + (pluginLineHeight / 2) - (textHeight.Y / 2));
|
||||
ImGui.TextUnformatted(text);
|
||||
|
||||
ImGui.SetCursorPos(before);
|
||||
}
|
||||
|
||||
ImGui.SameLine();
|
||||
ImGui.SetCursorPosX(windowSize.X - (ImGuiHelpers.GlobalScale * 320));
|
||||
ImGui.SetCursorPosY(ImGui.GetCursorPosY() + (pluginLineHeight / 2) - (ImGui.GetFrameHeight() / 2));
|
||||
|
||||
string OptKindToString(AutoUpdatePreference.OptKind kind)
|
||||
{
|
||||
return kind switch
|
||||
{
|
||||
AutoUpdatePreference.OptKind.NeverUpdate => Loc.Localize("DalamudSettingsAutoUpdateOptInNeverUpdate", "Never update this"),
|
||||
AutoUpdatePreference.OptKind.AlwaysUpdate => Loc.Localize("DalamudSettingsAutoUpdateOptInAlwaysUpdate", "Always update this"),
|
||||
_ => throw new ArgumentOutOfRangeException(),
|
||||
};
|
||||
}
|
||||
|
||||
ImGui.SetNextItemWidth(ImGuiHelpers.GlobalScale * 250);
|
||||
if (ImGui.BeginCombo(
|
||||
$"###autoUpdateBehavior{preference.WorkingPluginId}",
|
||||
OptKindToString(preference.Kind)))
|
||||
{
|
||||
foreach (var kind in Enum.GetValues<AutoUpdatePreference.OptKind>())
|
||||
{
|
||||
if (ImGui.Selectable(OptKindToString(kind)))
|
||||
{
|
||||
preference.Kind = kind;
|
||||
}
|
||||
}
|
||||
|
||||
ImGui.EndCombo();
|
||||
}
|
||||
|
||||
ImGui.SameLine();
|
||||
ImGui.SetCursorPosX(windowSize.X - (ImGuiHelpers.GlobalScale * 30 * btnOffset) - 5);
|
||||
ImGui.SetCursorPosY(ImGui.GetCursorPosY() + (pluginLineHeight / 2) - (ImGui.GetFrameHeight() / 2));
|
||||
|
||||
if (ImGuiComponents.IconButton($"###removePlugin{preference.WorkingPluginId}", FontAwesomeIcon.Trash))
|
||||
{
|
||||
wantRemovePluginGuid = preference.WorkingPluginId;
|
||||
}
|
||||
|
||||
if (ImGui.IsItemHovered())
|
||||
ImGui.SetTooltip(Loc.Localize("DalamudSettingsAutoUpdateOptInRemove", "Remove this override"));
|
||||
}
|
||||
|
||||
if (wantRemovePluginGuid != null)
|
||||
{
|
||||
this.autoUpdatePreferences.RemoveAll(x => x.WorkingPluginId == wantRemovePluginGuid);
|
||||
}
|
||||
}
|
||||
|
||||
void OnPluginPicked(LocalPlugin plugin)
|
||||
{
|
||||
var id = plugin.EffectiveWorkingPluginId;
|
||||
if (id == Guid.Empty)
|
||||
throw new InvalidOperationException("Plugin ID is empty.");
|
||||
|
||||
this.autoUpdatePreferences.Add(new AutoUpdatePreference(id));
|
||||
}
|
||||
|
||||
bool IsPluginDisabled(LocalPlugin plugin)
|
||||
=> this.autoUpdatePreferences.Any(x => x.WorkingPluginId == plugin.EffectiveWorkingPluginId);
|
||||
|
||||
bool IsPluginFiltered(LocalPlugin plugin)
|
||||
=> !plugin.IsDev;
|
||||
|
||||
var pickerId = DalamudComponents.DrawPluginPicker(
|
||||
"###autoUpdatePicker", ref this.pickerSearch, OnPluginPicked, IsPluginDisabled, IsPluginFiltered);
|
||||
|
||||
const FontAwesomeIcon addButtonIcon = FontAwesomeIcon.Plus;
|
||||
var addButtonText = Loc.Localize("DalamudSettingsAutoUpdateOptInAdd", "Add new override");
|
||||
ImGuiHelpers.CenterCursorFor(ImGuiComponents.GetIconButtonWithTextWidth(addButtonIcon, addButtonText));
|
||||
if (ImGuiComponents.IconButtonWithText(addButtonIcon, addButtonText))
|
||||
{
|
||||
this.pickerSearch = string.Empty;
|
||||
ImGui.OpenPopup(pickerId);
|
||||
}
|
||||
|
||||
base.Draw();
|
||||
}
|
||||
|
||||
public override void Load()
|
||||
{
|
||||
var configuration = Service<DalamudConfiguration>.Get();
|
||||
|
||||
this.behavior = configuration.AutoUpdateBehavior ?? AutoUpdateBehavior.None;
|
||||
this.checkPeriodically = configuration.CheckPeriodicallyForUpdates;
|
||||
this.autoUpdatePreferences = configuration.PluginAutoUpdatePreferences;
|
||||
|
||||
base.Load();
|
||||
}
|
||||
|
||||
public override void Save()
|
||||
{
|
||||
var configuration = Service<DalamudConfiguration>.Get();
|
||||
|
||||
configuration.AutoUpdateBehavior = this.behavior;
|
||||
configuration.CheckPeriodicallyForUpdates = this.checkPeriodically;
|
||||
configuration.PluginAutoUpdatePreferences = this.autoUpdatePreferences;
|
||||
|
||||
base.Save();
|
||||
}
|
||||
}
|
||||
|
|
@ -3,6 +3,7 @@
|
|||
using CheapLoc;
|
||||
using Dalamud.Game.Text;
|
||||
using Dalamud.Interface.Internal.Windows.Settings.Widgets;
|
||||
using Dalamud.Plugin.Internal.AutoUpdate;
|
||||
|
||||
namespace Dalamud.Interface.Internal.Windows.Settings.Tabs;
|
||||
|
||||
|
|
@ -20,9 +21,8 @@ public class SettingsTabGeneral : SettingsTab
|
|||
Loc.Localize("DalamudSettingsChannelHint", "Select the chat channel that is to be used for general Dalamud messages."),
|
||||
c => c.GeneralChatType,
|
||||
(v, c) => c.GeneralChatType = v,
|
||||
warning: (v) =>
|
||||
validity: (v) =>
|
||||
{
|
||||
// TODO: Maybe actually implement UI for the validity check...
|
||||
if (v == XivChatType.None)
|
||||
return Loc.Localize("DalamudSettingsChannelNone", "Do not pick \"None\".");
|
||||
|
||||
|
|
@ -62,12 +62,6 @@ public class SettingsTabGeneral : SettingsTab
|
|||
c => c.PrintPluginsWelcomeMsg,
|
||||
(v, c) => c.PrintPluginsWelcomeMsg = v),
|
||||
|
||||
new SettingsEntry<bool>(
|
||||
Loc.Localize("DalamudSettingsAutoUpdatePlugins", "Auto-update plugins"),
|
||||
Loc.Localize("DalamudSettingsAutoUpdatePluginsMsgHint", "Automatically update plugins when logging in with a character."),
|
||||
c => c.AutoUpdatePlugins,
|
||||
(v, c) => c.AutoUpdatePlugins = v),
|
||||
|
||||
new SettingsEntry<bool>(
|
||||
Loc.Localize("DalamudSettingsSystemMenu", "Dalamud buttons in system menu"),
|
||||
Loc.Localize("DalamudSettingsSystemMenuMsgHint", "Add buttons for Dalamud plugins and settings to the system menu."),
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue