Scrolling two-column credits work

This commit is contained in:
Nick 2022-08-13 14:45:04 -04:00
parent 97f104852a
commit 8b2880248d
6 changed files with 251 additions and 3 deletions

View File

@ -0,0 +1,18 @@
{
"credits": [
"xen#Mod Director\n#Programmer",
"Bwc9876#Mod Manager\n#Programmer\n#Dev Ops",
"FreezeDriedMangos#Programmer\n#Dev Tool Creator",
"MegaPiggy#Programmer",
"JohnCorby#Programmer",
"Hawkbat#Programmer",
"Trifid#Tester\n#Programmer",
"Nageld#Programmer",
"Ernesto#Fish",
"with help from#Raicuparta\n#dgarroDC\n#jtsalomo\n#and the modding community",
"Based off Marshmallow made by#Mister_Nebula",
"with help from#AmazingAlek\n#Raicuparta\n#and the Outer Wilds discord server",
" ",
"This work is unofficial Fan Content"
]
}

View File

@ -24,5 +24,9 @@ namespace NewHorizons.External.Configs
/// </summary>
public AchievementInfo[] achievements;
/// <summary>
/// Credits info for this mod. A list of contributors and their roles separated by #. For example: xen#New Horizons dev.
/// </summary>
public string[] credits;
}
}

View File

@ -0,0 +1,164 @@
using System.Collections.Generic;
using System.Xml;
using UnityEngine;
using Logger = NewHorizons.Utility.Logger;
namespace NewHorizons.Handlers
{
public static class CreditsHandler
{
private static Dictionary<string, string[]> _creditsInfo;
public static void RegisterCredits(string sectionName, string[] entries)
{
if (_creditsInfo == null) _creditsInfo = new();
Logger.LogVerbose($"Registering credits for {sectionName}");
_creditsInfo[sectionName] = entries;
}
public static void AddCredits(Credits credits)
{
Logger.LogVerbose($"Adding to credits");
var creditsAsset = credits._creditsAsset;
var xml = new XmlDocument();
xml.LoadXml(creditsAsset.xml.text);
foreach (var pair in _creditsInfo)
{
AddCreditsSection(pair.Key, pair.Value, ref xml);
}
var outerXml = xml.OuterXml.Replace("/n", "&#xD;&#xA;");
creditsAsset.xml = new TextAsset(outerXml);
}
private static void AddCreditsSection(string sectionName, string[] entries, ref XmlDocument xml)
{
var finalCredits = xml.SelectSingleNode("Credits/section");
// Fade credits look wrong right now bc it works with just one column not two
/*
var nodeFade = CreateCreditsFromList(xml, sectionName, entries, true);
finalCredits.InsertAfter(nodeFade, finalCredits.ChildNodes[0]);
*/
var fastCredits = NodeWhere(finalCredits.ChildNodes, "MainScrollSection");
var nodeScroll = CreateCreditsFromList(xml, sectionName, entries, false);
fastCredits.InsertBefore(nodeScroll, fastCredits.ChildNodes[0]);
}
private static XmlNode NodeWhere(XmlNodeList list, string name)
{
foreach(XmlNode node in list)
{
try
{
if (node.Attributes[0].Value == name) return node;
}
catch { }
}
return null;
}
private static XmlNode CreateCreditsFromList(XmlDocument doc, string title, string[] entries, bool fade)
{
var rootSection = MakeNode(doc, "section", fade ? new Dictionary<string, string>()
{
{ "platform", "All" },
{ "type", "Fade" },
{ "fadeInTime", "1.3" },
{ "displayTime", "10" },
{ "fadeOutTime", "1.4" },
{ "waitTime", "0.5" },
{ "padding-bottom", "-8" },
{ "spacing", "16" }
} : new Dictionary<string, string>()
{
{ "platform", "All" },
{ "type", "Scroll" },
{ "scrollDuration", "214" },
{ "spacing", "12" },
{ "width", "1590" }
});
var titleLayout = MakeNode(doc, "layout", new Dictionary<string, string>()
{
{ "type", fade ? "SingleColumnFadeCentered" : "SingleColumnScrollCentered" }
});
var titleNode = MakeNode(doc, "title", new Dictionary<string, string>()
{
{"text-align", "UpperCenter" },
{"height", "122" }
});
titleNode.InnerText = title;
titleLayout.AppendChild(titleNode);
var type = fade ? "SingleColumnFadeCentered" : "TwoColumnScrollAlignRightLeft";
var xmlText = $"<layout type=\"{type}\" spacer-base-height=\"10\">\n";
for (int i = 0; i < entries.Length; i++)
{
var entry = entries[i];
if (fade) entry = entry.Split('#')[0];
xmlText += $"{entry}\n";
if (fade)
{
if (i == entries.Length - 1) xmlText += "<spacer height = \"295\" />\n";
else xmlText += "<spacer />\n";
}
}
xmlText += "</layout>";
rootSection.AppendChild(titleLayout);
rootSection.AppendChild(StringToNode(doc, xmlText));
return rootSection;
}
private static XmlNode StringToNode(XmlDocument docContext, string text)
{
var doc = new XmlDocument();
doc.LoadXml(text);
// ArgumentException: The node to be inserted is from a different document context.
var importedNode = docContext.ImportNode(doc.DocumentElement, true);
return importedNode;
}
private static XmlNode MakeNode(XmlDocument doc, string nodeType, Dictionary<string, string> attributes)
{
var xmlNode = doc.CreateElement(nodeType);
if (attributes != null)
{
foreach (var pair in attributes)
{
var attribute = doc.CreateAttribute(pair.Key);
attribute.Value = pair.Value;
xmlNode.Attributes.Append(attribute);
}
}
return xmlNode;
}
internal class CreditsInfo
{
string sectionName;
string[] entries;
internal CreditsInfo(string sectionName, string[] entries)
{
this.sectionName = sectionName;
this.entries = entries;
}
}
}
}

View File

@ -198,6 +198,8 @@ namespace NewHorizons
AchievementHandler.Init();
VoiceHandler.Init();
LoadAddonManifest("Assets/addon-manifest.json", this);
}
public void OnDestroy()
@ -507,9 +509,7 @@ namespace NewHorizons
// Has to go before translations for achievements
if (File.Exists(folder + "addon-manifest.json"))
{
var addonConfig = mod.ModHelper.Storage.Load<AddonConfig>("addon-manifest.json");
AchievementHandler.RegisterAddon(addonConfig, mod as ModBehaviour);
LoadAddonManifest("addon-manifest.json", mod);
}
if (Directory.Exists(folder + @"translations\"))
{
@ -523,6 +523,18 @@ namespace NewHorizons
}
}
private void LoadAddonManifest(string file, IModBehaviour mod)
{
Logger.LogError($"{mod.ModHelper.Manifest.Name}");
var addonConfig = mod.ModHelper.Storage.Load<AddonConfig>(file);
if (addonConfig.achievements != null) AchievementHandler.RegisterAddon(addonConfig, mod as ModBehaviour);
if (addonConfig.credits != null) CreditsHandler.RegisterCredits(mod.ModHelper.Manifest.Name, addonConfig.credits);
}
private void LoadTranslations(string folder, IModBehaviour mod)
{
var foundFile = false;

View File

@ -0,0 +1,33 @@
using HarmonyLib;
using NewHorizons.Utility;
using System;
namespace NewHorizons.Patches.CreditsScene
{
[HarmonyPatch]
public static class CreditsEntryPatches
{
[HarmonyPrefix]
[HarmonyPatch(typeof(CreditsEntry), nameof(CreditsEntry.SetContents))]
public static bool CreditsEntry_SetContents(CreditsEntry __instance, string[] __0)
{
var columnTexts = __0;
for (int i = 0; i < __instance._columns.Length; i++)
{
// Base method throws out of bounds exception sometimes (_columns length doesn't match columnTexts length)
// Trim also NREs sometimes because of the TrimHelper class Mobius has idk
try
{
__instance._columns[i].text = columnTexts[i].Trim();
}
catch
{
// Error occurs when column 2 is empty
__instance._columns[i].text = " ";
}
}
return false;
}
}
}

View File

@ -0,0 +1,17 @@
using HarmonyLib;
using NewHorizons.Handlers;
namespace NewHorizons.Patches.CreditsScene
{
[HarmonyPatch]
public static class CreditsPatches
{
[HarmonyPrefix]
[HarmonyPatch(typeof(Credits), nameof(Credits.Start))]
public static void Credits_Start(Credits __instance)
{
CreditsHandler.AddCredits(__instance);
}
}
}