Browse Source

Started moving mod descriptions to MarkDown instead of raw TMP

pull/46/head
Anairkoen Schno 5 years ago
parent
commit
5d65f12a29
6 changed files with 250 additions and 5 deletions
  1. +8
    -1
      BSIPA-ModList/BSIPA-ModList.csproj
  2. +3
    -0
      BSIPA-ModList/Plugin.cs
  3. +17
    -0
      BSIPA-ModList/PostBuild.msbuild
  4. +204
    -0
      BSIPA-ModList/UI/ViewControllers/MarkdownView.cs
  5. +11
    -3
      BSIPA-ModList/UI/ViewControllers/ModInfoViewController.cs
  6. +7
    -1
      BSIPA-ModList/manifest.json

+ 8
- 1
BSIPA-ModList/BSIPA-ModList.csproj View File

@ -78,6 +78,7 @@
<Compile Include="UI\ViewControllers\BackButtonNavigationController.cs" /> <Compile Include="UI\ViewControllers\BackButtonNavigationController.cs" />
<Compile Include="UI\ViewControllers\DownloadProgressViewController.cs" /> <Compile Include="UI\ViewControllers\DownloadProgressViewController.cs" />
<Compile Include="UI\FloatingNotification.cs" /> <Compile Include="UI\FloatingNotification.cs" />
<Compile Include="UI\ViewControllers\MarkdownView.cs" />
<Compile Include="UI\ViewControllers\ModCells.cs" /> <Compile Include="UI\ViewControllers\ModCells.cs" />
<Compile Include="UI\ViewControllers\ModInfoViewController.cs" /> <Compile Include="UI\ViewControllers\ModInfoViewController.cs" />
<Compile Include="UI\ViewControllers\ModListController.cs" /> <Compile Include="UI\ViewControllers\ModListController.cs" />
@ -94,6 +95,9 @@
<EmbeddedResource Include="manifest.json" /> <EmbeddedResource Include="manifest.json" />
</ItemGroup> </ItemGroup>
<ItemGroup> <ItemGroup>
<PackageReference Include="CommonMark.NET">
<Version>0.15.1</Version>
</PackageReference>
<PackageReference Include="SemanticVersioning"> <PackageReference Include="SemanticVersioning">
<Version>1.2.0</Version> <Version>1.2.0</Version>
</PackageReference> </PackageReference>
@ -112,12 +116,15 @@
<Target Name="AfterBuild"> <Target Name="AfterBuild">
<Message Text="Packing..." Importance="normal" /> <Message Text="Packing..." Importance="normal" />
<ItemGroup> <ItemGroup>
<BadFiles Include="$(OutputPath)**/*" Exclude="$(OutputPath)**/$(AssemblyName).*" />
<CMark Include="$(OutputPath)CommonMark.*" />
<BadFiles Include="$(OutputPath)**/*" Exclude="$(OutputPath)**/$(AssemblyName).*;@(CMark)" />
</ItemGroup> </ItemGroup>
<Delete Files="@(BadFiles)" /> <Delete Files="@(BadFiles)" />
<Move SourceFiles="@(CMark)" DestinationFolder="$(OutputPath)Libs/" />
<ItemGroup> <ItemGroup>
<UnBadFiles Include="$(OutputPath)*" /> <UnBadFiles Include="$(OutputPath)*" />
</ItemGroup> </ItemGroup>
<Move SourceFiles="@(UnBadFiles)" DestinationFolder="$(OutputPath)Plugins/" /> <Move SourceFiles="@(UnBadFiles)" DestinationFolder="$(OutputPath)Plugins/" />
<Exec Command="&quot;$(MSBuildBinPath)\MSBuild.exe&quot; &quot;$(MSBuildProjectDirectory)\PostBuild.msbuild&quot; /property:OPath=$(OutputPath) /property:Configuration=$(Configuration) /property:SolDir=$(SolutionDir)" />
</Target> </Target>
</Project> </Project>

+ 3
- 0
BSIPA-ModList/Plugin.cs View File

@ -3,12 +3,15 @@ using UnityEngine.SceneManagement;
using IPALogger = IPA.Logging.Logger; using IPALogger = IPA.Logging.Logger;
using BSIPA_ModList.UI; using BSIPA_ModList.UI;
using UnityEngine; using UnityEngine;
using IPA.Logging;
namespace BSIPA_ModList namespace BSIPA_ModList
{ {
internal static class Logger internal static class Logger
{ {
internal static IPALogger log { get; set; } internal static IPALogger log { get; set; }
internal static IPALogger md => log.GetChildLogger("MarkDown");
} }
public class Plugin : IBeatSaberPlugin public class Plugin : IBeatSaberPlugin


+ 17
- 0
BSIPA-ModList/PostBuild.msbuild View File

@ -0,0 +1,17 @@
<?xml version="1.0" encoding="utf-8"?>
<Project DefaultTargets="PostBuild" xmlns="http://schemas.microsoft.com/developer/msbuild/2003" ToolsVersion="4.0">
<PropertyGroup>
<OPath></OPath>
<SolDir></SolDir>
</PropertyGroup>
<UsingTask TaskName="AssemblyRename" AssemblyFile="$(SolDir)BuildTools\AssemblyRenameStep\bin\$(Configuration)\AssemblyRenameStep.dll" />
<Target Name="PostBuild">
<Message Text="Relocating" Importance="normal" />
<ItemGroup>
<ToRename Include="$(OPath)Libs\**\*.dll" />
</ItemGroup>
<AssemblyRename Assemblies="@(ToRename)" />
</Target>
</Project>

+ 204
- 0
BSIPA-ModList/UI/ViewControllers/MarkdownView.cs View File

@ -0,0 +1,204 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using UnityEngine;
using CommonMark;
using CommonMark.Syntax;
using UnityEngine.UI;
using TMPro;
using CustomUI.BeatSaber;
namespace BSIPA_ModList.UI.ViewControllers
{
[RequireComponent(/*typeof(ScrollRect),*/ typeof(RectTransform))]
public class MarkdownView : MonoBehaviour
{
private class TagTypeComponent : MonoBehaviour
{
internal BlockTag Tag;
}
private string markdown = "";
public string Markdown
{
get => markdown;
set
{
markdown = value;
UpdateMd();
}
}
public RectTransform rectTransform => GetComponent<RectTransform>();
//private ScrollRect view;
private RectTransform content;
private CommonMarkSettings settings;
public MarkdownView()
{
settings = CommonMarkSettings.Default.Clone();
settings.AdditionalFeatures = CommonMarkAdditionalFeatures.All;
settings.RenderSoftLineBreaksAsLineBreaks = false;
settings.UriResolver = ResolveUri;
}
public Func<string, bool> HasEmbeddedImage;
private string ResolveUri(string arg)
{
var name = arg.Substring(3);
if (!arg.StartsWith("!::") && !arg.StartsWith("w::"))
{ // !:: means embedded, w:: means web
// this block is for when neither is specified
// check if its embedded
if (HasEmbeddedImage != null && HasEmbeddedImage(arg))
return "!::" + arg;
else
return "w::" + arg;
}
return arg;
}
protected void Awake()
{
content = new GameObject("Content Wrapper").AddComponent<RectTransform>();
content.SetParent(transform);
var contentLayout = content.gameObject.AddComponent<LayoutElement>();
var contentFitter = content.gameObject.AddComponent<ContentSizeFitter>();
contentFitter.horizontalFit = ContentSizeFitter.FitMode.PreferredSize;
contentFitter.verticalFit = ContentSizeFitter.FitMode.Unconstrained;
contentLayout.preferredWidth = 100f; // to be adjusted
content.sizeDelta = new Vector2(100f,100f);
/*view = GetComponent<ScrollRect>();
view.content = content;
view.vertical = true;
view.horizontal = false;
view.verticalScrollbarVisibility = ScrollRect.ScrollbarVisibility.AutoHide;
view.horizontalScrollbarVisibility = ScrollRect.ScrollbarVisibility.AutoHide;*/
}
private void UpdateMd()
{
Clear();
var doc = CommonMarkConverter.Parse(markdown, settings);
Stack<RectTransform> layout = new Stack<RectTransform>();
layout.Push(content);
TextMeshProUGUI currentText = null;
foreach (var node in doc.AsEnumerable())
{
Logger.md.Debug($"node {node}");
if (node.Block != null)
{
var block = node.Block;
void BlockNode(string name, float spacing, bool isVertical)
{
var type = isVertical ? typeof(VerticalLayoutGroup) : typeof(HorizontalLayoutGroup);
if (node.IsOpening)
{
Logger.md.Debug($"Creating block container {name}");
currentText = null;
var go = new GameObject(name, typeof(RectTransform), type);
var vlayout = go.GetComponent<RectTransform>();
vlayout.SetParent(layout.Peek());
go.AddComponent<TagTypeComponent>().Tag = block.Tag;
layout.Push(vlayout);
if (isVertical)
{
var vl = go.GetComponent<VerticalLayoutGroup>();
vl.childControlHeight = vl.childControlWidth =
vl.childForceExpandHeight = vl.childForceExpandWidth = false;
vl.spacing = spacing;
}
else
{
var hl = go.GetComponent<HorizontalLayoutGroup>();
hl.childControlHeight = hl.childControlWidth =
hl.childForceExpandHeight = hl.childForceExpandWidth = false;
hl.spacing = spacing;
}
}
else if (node.IsClosing)
{
currentText = null;
layout.Pop();
}
}
switch (block.Tag)
{
case BlockTag.Document:
BlockNode("DocumentRoot", 10f, true);
break;
case BlockTag.SetextHeading:
BlockNode("Heading1", .1f, false);
break;
case BlockTag.AtxHeading:
BlockNode("Heading2", .1f, false);
break;
case BlockTag.Paragraph:
BlockNode("Paragraph", .1f, false);
break;
// TODO: add the rest of the tag types
}
}
else if (node.Inline != null)
{ // inline element
var inl = node.Inline;
switch (inl.Tag)
{
case InlineTag.String:
if (currentText == null)
{
Logger.md.Debug($"Adding new text element");
var btt = layout.Peek().gameObject.GetComponent<TagTypeComponent>().Tag;
currentText = BeatSaberUI.CreateText(layout.Peek(), "", Vector2.zero);
//var le = currentText.gameObject.AddComponent<LayoutElement>();
switch (btt)
{
case BlockTag.List:
case BlockTag.ListItem:
case BlockTag.Paragraph:
currentText.fontSize = 3.5f;
currentText.enableWordWrapping = true;
break;
case BlockTag.AtxHeading:
currentText.fontSize = 4f;
currentText.enableWordWrapping = true;
break;
case BlockTag.SetextHeading:
currentText.fontSize = 4.5f;
currentText.enableWordWrapping = true;
break;
// TODO: add other relevant types
}
}
Logger.md.Debug($"Appending '{inl.LiteralContent}' to current element");
currentText.text += inl.LiteralContent;
break;
}
}
}
}
private void Clear()
{
foreach (Transform child in content)
Destroy(child.gameObject);
}
}
}

+ 11
- 3
BSIPA-ModList/UI/ViewControllers/ModInfoViewController.cs View File

@ -1,4 +1,5 @@
using CustomUI.BeatSaber;
using BSIPA_ModList.UI.ViewControllers;
using CustomUI.BeatSaber;
using CustomUI.MenuButton; using CustomUI.MenuButton;
using IPA.Loader; using IPA.Loader;
using IPA.Updating.BeatMods; using IPA.Updating.BeatMods;
@ -182,10 +183,17 @@ namespace BSIPA_ModList.UI
titleText.fontSize = 6f; titleText.fontSize = 6f;
authorText = BeatSaberUI.CreateText(rectTransform, controller.Author, new Vector2(11f, 22f)); authorText = BeatSaberUI.CreateText(rectTransform, controller.Author, new Vector2(11f, 22f));
authorText.fontSize = 4.5f; authorText.fontSize = 4.5f;
/*
descText = BeatSaberUI.CreateText(rectTransform, controller.Description, new Vector2(-4.5f, 12f)); descText = BeatSaberUI.CreateText(rectTransform, controller.Description, new Vector2(-4.5f, 12f));
descText.fontSize = 3.5f; descText.fontSize = 3.5f;
descText.enableWordWrapping = true; descText.enableWordWrapping = true;
descText.overflowMode = TextOverflowModes.ScrollRect;
descText.overflowMode = TextOverflowModes.ScrollRect;*/
var mdv = new GameObject("MarkDown Desc").AddComponent<MarkdownView>();
mdv.rectTransform.anchoredPosition = new Vector2(-4.5f, 12f);
mdv.rectTransform.SetParent(rectTransform);
mdv.Markdown = controller.Description;
icon = new GameObject("Mod Info View Icon", typeof(RectTransform)).AddComponent<Image>(); icon = new GameObject("Mod Info View Icon", typeof(RectTransform)).AddComponent<Image>();
icon.gameObject.SetActive(false); icon.gameObject.SetActive(false);
@ -328,5 +336,5 @@ namespace BSIPA_ModList.UI
#endif #endif
} }
#endif #endif
}
}
} }

+ 7
- 1
BSIPA-ModList/manifest.json View File

@ -1,7 +1,13 @@
{ {
"$schema": "https://raw.githubusercontent.com/nike4613/ModSaber-MetadataFileSchema/master/Schema.json", "$schema": "https://raw.githubusercontent.com/nike4613/ModSaber-MetadataFileSchema/master/Schema.json",
"author": "DaNike", "author": "DaNike",
"description": "An in-game interface client for BSIPA.",
"description": [
"## An in-game interface client for BSIPA.",
"",
"***",
"",
"Look, ma! Markdown! Its **[CommonMark](w::https://commonmark.org/)**!"
],
"gameVersion": "0.13.2", "gameVersion": "0.13.2",
"id": "BSIPA Mod List", "id": "BSIPA Mod List",
"name": "BSIPA Mod List", "name": "BSIPA Mod List",


Loading…
Cancel
Save