From ab0b5783f2b44874976e7c84e244ef1b6996f894 Mon Sep 17 00:00:00 2001 From: Anna Clemens Date: Sat, 6 Mar 2021 16:20:14 -0500 Subject: [PATCH] chore: initial commit --- .gitignore | 365 ++++++++++++++++++++++++++ DalamudPython.sln | 16 ++ DalamudPython/Commands.cs | 101 +++++++ DalamudPython/DalamudPackager.targets | 10 + DalamudPython/DalamudPython.csproj | 41 +++ DalamudPython/DalamudPython.yaml | 6 + DalamudPython/FodyWeavers.xml | 3 + DalamudPython/ILRepack.targets | 17 ++ DalamudPython/Plugin.cs | 57 ++++ 9 files changed, 616 insertions(+) create mode 100644 .gitignore create mode 100644 DalamudPython.sln create mode 100644 DalamudPython/Commands.cs create mode 100644 DalamudPython/DalamudPackager.targets create mode 100755 DalamudPython/DalamudPython.csproj create mode 100644 DalamudPython/DalamudPython.yaml create mode 100644 DalamudPython/FodyWeavers.xml create mode 100644 DalamudPython/ILRepack.targets create mode 100644 DalamudPython/Plugin.cs diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1db30bf --- /dev/null +++ b/.gitignore @@ -0,0 +1,365 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# Packaging +pack/ + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd diff --git a/DalamudPython.sln b/DalamudPython.sln new file mode 100644 index 0000000..0967444 --- /dev/null +++ b/DalamudPython.sln @@ -0,0 +1,16 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "DalamudPython", "DalamudPython\DalamudPython.csproj", "{DF4A2D36-F4C1-4B6F-92BB-1C7B01FE79C2}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {DF4A2D36-F4C1-4B6F-92BB-1C7B01FE79C2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {DF4A2D36-F4C1-4B6F-92BB-1C7B01FE79C2}.Debug|Any CPU.Build.0 = Debug|Any CPU + {DF4A2D36-F4C1-4B6F-92BB-1C7B01FE79C2}.Release|Any CPU.ActiveCfg = Release|Any CPU + {DF4A2D36-F4C1-4B6F-92BB-1C7B01FE79C2}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/DalamudPython/Commands.cs b/DalamudPython/Commands.cs new file mode 100644 index 0000000..65592b9 --- /dev/null +++ b/DalamudPython/Commands.cs @@ -0,0 +1,101 @@ +using System; +using System.Collections.Generic; +using System.IO; + +namespace DalamudPython { + public class Commands { + public static readonly Dictionary All = new() { + ["/python"] = "Run a line of Python", + ["/py"] = "Alias for /python", + ["/pyprint"] = "Run a line of Python and print the result to the chat window", + ["/pyadd"] = "Add a line of Python to a temporary script", + ["/pyexecute"] = "Run the temporary script", + ["/pyreset"] = "Clear the temporary script", + ["/pyload"] = "Read the contents of a file relative to the config folder and run them as a Python script", + }; + + private Plugin Plugin { get; } + + private string? Script { get; set; } + + public Commands(Plugin plugin) { + this.Plugin = plugin; + } + + public void OnCommand(string name, string args) { + switch (name) { + case "/python": + case "/py": + case "/pyprint": + this.OneLiner(name, args); + break; + case "/pyadd": + this.Add(args); + break; + case "/pyexecute": + this.RunScript(args); + break; + case "/pyreset": + this.Script = null; + break; + case "/pyload": + this.LoadFile(args); + break; + } + } + + private void Add(string args) { + this.Script ??= ""; + this.Script += args + "\n"; + } + + private void RunScript(string args) { + var script = this.Script; + if (script == null) { + return; + } + + var print = args == "print"; + + try { + this.Execute(script, print); + } finally { + this.Script = null; + } + } + + private void Execute(string script, bool print) { + var scope = this.Plugin.Engine.CreateScope(); + scope.SetVariable("interface", this.Plugin.Interface); + var fullScript = $@"import clr +from Dalamud import * +from Dalamud.Plugin import * +from Lumina import * +from Lumina.Excel.GeneratedSheets import * +{script}"; + var result = this.Plugin.Engine.Execute(fullScript, scope); + + if (!print) { + return; + } + + this.Plugin.Interface.Framework.Gui.Chat.Print(result.ToString()); + } + + private void OneLiner(string name, string args) { + var print = name == "/pyprint"; + this.Execute(args, print); + } + + private void LoadFile(string args) { + if (string.IsNullOrWhiteSpace(args)) { + return; + } + + var scriptPath = Path.Combine(this.Plugin.ConfigDirectory, args); + var script = File.ReadAllText(scriptPath); + + this.Execute(script, false); + } + } +} diff --git a/DalamudPython/DalamudPackager.targets b/DalamudPython/DalamudPackager.targets new file mode 100644 index 0000000..41f4094 --- /dev/null +++ b/DalamudPython/DalamudPackager.targets @@ -0,0 +1,10 @@ + + + + + diff --git a/DalamudPython/DalamudPython.csproj b/DalamudPython/DalamudPython.csproj new file mode 100755 index 0000000..b2dc036 --- /dev/null +++ b/DalamudPython/DalamudPython.csproj @@ -0,0 +1,41 @@ + + + + net48 + latest + enable + + + + + $(AppData)\XIVLauncher\addon\Hooks\dev\Dalamud.dll + False + + + $(AppData)\XIVLauncher\addon\Hooks\dev\ImGui.NET.dll + False + + + $(AppData)\XIVLauncher\addon\Hooks\dev\Lumina.dll + False + + + $(AppData)\XIVLauncher\addon\Hooks\dev\Lumina.Excel.dll + False + + + + + + + all + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + + + diff --git a/DalamudPython/DalamudPython.yaml b/DalamudPython/DalamudPython.yaml new file mode 100644 index 0000000..8e72df1 --- /dev/null +++ b/DalamudPython/DalamudPython.yaml @@ -0,0 +1,6 @@ +author: ascclemens +name: Python REPL +description: |- + Allows you to use Dalamud via Python in the chat box. + + Supports one-liners, printing results to chat, or making full scripts over multiple commands. diff --git a/DalamudPython/FodyWeavers.xml b/DalamudPython/FodyWeavers.xml new file mode 100644 index 0000000..f1dea8f --- /dev/null +++ b/DalamudPython/FodyWeavers.xml @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/DalamudPython/ILRepack.targets b/DalamudPython/ILRepack.targets new file mode 100644 index 0000000..272ed9a --- /dev/null +++ b/DalamudPython/ILRepack.targets @@ -0,0 +1,17 @@ + + + + + + + + + + diff --git a/DalamudPython/Plugin.cs b/DalamudPython/Plugin.cs new file mode 100644 index 0000000..80522ba --- /dev/null +++ b/DalamudPython/Plugin.cs @@ -0,0 +1,57 @@ +using System; +using System.IO; +using System.Reflection; +using Dalamud.Game.Command; +using Dalamud.Plugin; +using IronPython.Hosting; +using Microsoft.Scripting.Hosting; + +namespace DalamudPython { + public class Plugin : IDalamudPlugin { + public string Name => "DalamudPython"; + + public DalamudPluginInterface Interface { get; private set; } = null!; + + public ScriptEngine Engine { get; } = Python.CreateEngine(); + + private Commands Commands { get; set; } = null!; + + public string ConfigDirectory => Path.Combine(new[] { + Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), + "XIVLauncher", + "pluginConfigs", + this.Name, + }); + + public void Initialize(DalamudPluginInterface pluginInterface) { + this.Interface = pluginInterface ?? throw new ArgumentNullException(nameof(pluginInterface)); + + // set a global variable for the plugin interface + this.Engine.Runtime.Globals.SetVariable("interface", this.Interface); + // load Dalamud, Lumina, and ImGuiNET + this.Engine.Runtime.LoadAssembly(Assembly.GetAssembly(typeof(DalamudPluginInterface))); + this.Engine.Runtime.LoadAssembly(Assembly.GetAssembly(typeof(Lumina.Lumina))); + this.Engine.Runtime.LoadAssembly(Assembly.GetAssembly(typeof(Lumina.Excel.IExcelRow))); + this.Engine.Runtime.LoadAssembly(Assembly.GetAssembly(typeof(Lumina.Excel.GeneratedSheets.Achievement))); + this.Engine.Runtime.LoadAssembly(Assembly.GetAssembly(typeof(ImGuiNET.ImGui))); + + this.Commands = new Commands(this); + + foreach (var command in Commands.All) { + this.Interface.CommandManager.AddHandler(command.Key, new CommandInfo(this.Commands.OnCommand) { + HelpMessage = command.Value, + }); + } + + Directory.CreateDirectory(this.ConfigDirectory); + } + + public void Dispose() { + foreach (var name in Commands.All.Keys) { + this.Interface.CommandManager.RemoveHandler(name); + } + + this.Engine.Runtime.Shutdown(); + } + } +}