ToxicMushroom/Penumbra
1
0
Fork 0
mirror of https://github.com/xivdev/Penumbra.git synced 2025-12-12 18:27:24 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add help for inheritance.

Browse source
This commit is contained in:
Ottermandias 2022-05-13 17:27:21 +02:00
parent 1fd31f30ef
commit 4a206a633e
3 changed files with 75 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

2
OtterGui

@ -1 +1 @@
Subproject commit c3d87107549b92408c6b45f9a76228d052f24c5a
Subproject commit cbc29200e8b80d264c8a326cdc62e841e12d1c53

22
Penumbra/UI/Classes/ModFileSystemSelector.cs
View file

@ -369,16 +369,10 @@ public sealed partial class ModFileSystemSelector : FileSystemSelector< Mod, Mod
private static void DrawHelpPopup()
{
ImGui.SetNextWindowPos( ImGui.GetMainViewport().GetCenter(), ImGuiCond.Always, Vector2.One / 2 );
ImGui.SetNextWindowSize( new Vector2( 1000 * ImGuiHelpers.GlobalScale, 34 * ImGui.GetTextLineHeightWithSpacing() ) );
using var popup = ImRaii.Popup( "ExtendedHelp", ImGuiWindowFlags.NoResize | ImGuiWindowFlags.NoMove | ImGuiWindowFlags.Modal );
if( !popup )
ImGuiUtil.HelpPopup( "ExtendedHelp", new Vector2( 1000 * ImGuiHelpers.GlobalScale, 33.5f * ImGui.GetTextLineHeightWithSpacing() ), () =>
{
return;
}
ImGui.Dummy( Vector2.UnitY * ImGui.GetTextLineHeight() );
ImGui.Text( "Mod Selector" );
ImGui.TextUnformatted( "Mod Selector" );
ImGui.BulletText( "Select a mod to obtain more information or change settings." );
ImGui.BulletText( "Names are colored according to your config and their current state in the collection:" );
using var indent = ImRaii.PushIndent();
@ -391,7 +385,8 @@ public sealed partial class ModFileSystemSelector : FileSystemSelector< Mod, Mod
"newly imported during this session. Will go away when first enabling a mod or when Penumbra is reloaded." );
ImGuiUtil.BulletTextColored( ColorId.HandledConflictMod.Value(),
"enabled and conflicting with another enabled Mod, but on different priorities (i.e. the conflict is solved)." );
ImGuiUtil.BulletTextColored( ColorId.ConflictingMod.Value(), "enabled and conflicting with another enabled Mod on the same priority." );
ImGuiUtil.BulletTextColored( ColorId.ConflictingMod.Value(),
"enabled and conflicting with another enabled Mod on the same priority." );
ImGuiUtil.BulletTextColored( ColorId.FolderExpanded.Value(), "expanded mod folder." );
ImGuiUtil.BulletTextColored( ColorId.FolderCollapsed.Value(), "collapsed mod folder" );
indent.Pop( 1 );
@ -413,17 +408,12 @@ public sealed partial class ModFileSystemSelector : FileSystemSelector< Mod, Mod
indent.Pop( 1 );
ImGui.BulletText( "Use the expandable menu beside the input to filter for mods fulfilling specific criteria." );
ImGui.Dummy( Vector2.UnitY * ImGui.GetTextLineHeight() );
ImGui.Text( "Mod Management" );
ImGui.TextUnformatted( "Mod Management" );
ImGui.BulletText( "You can create empty mods or import TTMP-based mods with the buttons in this row." );
ImGui.BulletText(
"You can import penumbra-based mods by moving the corresponding folder into your mod directory in a file explorer, then rediscovering mods." );
ImGui.BulletText(
"If you enable Advanced Options in the Settings tab, you can toggle Edit Mode to manipulate your selected mod even further." );
ImGui.Dummy( Vector2.UnitY * ImGui.GetTextLineHeight() );
ImGui.SetCursorPosX( 400 * ImGuiHelpers.GlobalScale );
if( ImGui.Button( "Understood", ImGuiHelpers.ScaledVector2( 200, 0 ) ) )
{
ImGui.CloseCurrentPopup();
}
} );
}
}

31
Penumbra/UI/ConfigWindow.CollectionsTab.Inheritance.cs
View file

@ -3,7 +3,6 @@ using System.Collections.Generic;
using System.Linq;
using System.Numerics;
using Dalamud.Interface;
using Dalamud.Interface.Components;
using ImGuiNET;
using OtterGui;
using OtterGui.Raii;
@ -204,7 +203,35 @@ public partial class ConfigWindow
_newInheritance = null;
}
ImGuiComponents.HelpMarker( tt );
ImGui.SameLine();
if( ImGuiUtil.DrawDisabledButton( FontAwesomeIcon.QuestionCircle.ToIconString(), _window._iconButtonSize, "What is Inheritance?",
false, true ) )
{
ImGui.OpenPopup( "InheritanceHelp" );
}
ImGuiUtil.HelpPopup( "InheritanceHelp", new Vector2( 1000 * ImGuiHelpers.GlobalScale, 21 * ImGui.GetTextLineHeightWithSpacing() ), () =>
{
ImGui.NewLine();
ImGui.TextWrapped( "Inheritance is a way to use a baseline of mods across multiple collections, without needing to change all those collections if you want to add a single mod." );
ImGui.NewLine();
ImGui.TextUnformatted( "Every mod in a collection can have three basic states: 'Enabled', 'Disabled' and 'Unconfigured'." );
ImGui.BulletText( "If the mod is 'Enabled' or 'Disabled', it does not matter if the collection inherits from other collections." );
ImGui.BulletText( "If the mod is unconfigured, those inherited-from collections are checked in the order displayed here, including sub-inheritances." );
ImGui.BulletText( "If a collection is found in which the mod is either 'Enabled' or 'Disabled', the settings from this collection will be used." );
ImGui.BulletText( "If no such collection is found, the mod will be treated as disabled." );
ImGui.BulletText( "Highlighted collections in the left box are never reached because they are already checked in a sub-inheritance before." );
ImGui.NewLine();
ImGui.TextUnformatted( "Example" );
ImGui.BulletText( "Collection A has the Bibo+ body and a Hempen Camise mod enabled." );
ImGui.BulletText( "Collection B inherits from A, leaves Bibo+ unconfigured, but has the Hempen Camise enabled with different settings than A." );
ImGui.BulletText( "Collection C also inherits from A, has Bibo+ explicitly disabled and the Hempen Camise unconfigured." );
ImGui.BulletText( "Collection D inherits from C and then B and leaves everything unconfigured." );
using var indent = ImRaii.PushIndent();
ImGui.BulletText( "B uses Bibo+ settings from A and its own Hempen Camise settings." );
ImGui.BulletText( "C has Bibo+ disabled and uses A's Hempen Camise settings." );
ImGui.BulletText( "D has Bibo+ disabled and uses A's Hempen Camise settings, not B's. It traversed the collections in Order D -> (C -> A) -> (B -> A)." );
} );
}
// Draw the combo to select new potential inheritances.