From 6377a4142fc26f22ed6a51a432b0e1b0a8933e66 Mon Sep 17 00:00:00 2001 From: alterNERDtive Date: Tue, 5 Jul 2022 00:19:04 +0200 Subject: [PATCH] initial commit --- .editorconfig | 14 + .github/FUNDING.yml | 2 + .github/dependabot.yaml | 12 + .github/workflows/create-release.yaml | 44 ++ .github/workflows/push-test.yaml | 29 + .gitignore | 365 ++++++++++ CHANGELOG.md | 3 + Directory.Build.props | 21 + Directory.Build.targets | 6 + ExamplePlugin/ExamplePlugin.cs | 53 ++ ExamplePlugin/ExamplePlugin.csproj | 28 + ExamplePlugin/Properties/Settings.Designer.cs | 26 + ExamplePlugin/Properties/Settings.settings | 6 + .../Properties/launchSettings.sample.json | 11 + LICENSE | 674 ++++++++++++++++++ README.md | 43 ++ VoiceAttack-Framework.sln | 63 ++ VoiceAttack-Framework/GlobalSuppressions.cs | 8 + .../VoiceAttack-Framework.csproj | 44 ++ VoiceAttack-Framework/VoiceAttackPlugin.cs | 81 +++ glider.jpg | Bin 0 -> 10791 bytes stylecop.json | 16 + 22 files changed, 1549 insertions(+) create mode 100644 .editorconfig create mode 100644 .github/FUNDING.yml create mode 100644 .github/dependabot.yaml create mode 100644 .github/workflows/create-release.yaml create mode 100644 .github/workflows/push-test.yaml create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 Directory.Build.props create mode 100644 Directory.Build.targets create mode 100644 ExamplePlugin/ExamplePlugin.cs create mode 100644 ExamplePlugin/ExamplePlugin.csproj create mode 100644 ExamplePlugin/Properties/Settings.Designer.cs create mode 100644 ExamplePlugin/Properties/Settings.settings create mode 100644 ExamplePlugin/Properties/launchSettings.sample.json create mode 100644 LICENSE create mode 100644 README.md create mode 100644 VoiceAttack-Framework.sln create mode 100644 VoiceAttack-Framework/GlobalSuppressions.cs create mode 100644 VoiceAttack-Framework/VoiceAttack-Framework.csproj create mode 100644 VoiceAttack-Framework/VoiceAttackPlugin.cs create mode 100644 glider.jpg create mode 100644 stylecop.json diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..4b826ec --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +[*] +guidelines = 80 +end_of_line = lf +insert_final_newline = true +charset = utf-8-bom + +[*.cs] +guidelines = 80, 120 + +# IDE0021: Use block body for constructors +csharp_style_expression_bodied_constructors = when_on_single_line + +# IDE0024: Use block body for operators +csharp_style_expression_bodied_operators = when_on_single_line diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..969b701 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: alterNERDtive +ko_fi: alterNERDtive diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 0000000..ab33044 --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,12 @@ +version: 2 +updates: + - package-ecosystem: "nuget" + directory: "/" + target-branch: "develop" + schedule: + interval: "daily" + - package-ecosystem: "github-actions" + directory: "/" + target-branch: "develop" + schedule: + interval: "daily" diff --git a/.github/workflows/create-release.yaml b/.github/workflows/create-release.yaml new file mode 100644 index 0000000..560d81b --- /dev/null +++ b/.github/workflows/create-release.yaml @@ -0,0 +1,44 @@ +name: Create release on tag push + +on: + push: + tags: + - 'release/*' + +jobs: + build: + name: Build YAVAPF + runs-on: windows-latest + permissions: + contents: write + + steps: + - name: Checkout source code + uses: actions/checkout@v2 + + - name: Setup .Net + uses: actions/setup-dotnet@v2 + with: + dotnet-version: '6.0.x' + + - name: Restore dependencies + run: dotnet restore + + - name: Build + run: dotnet build -c release + + - name: Run tests + run: dotnet test + + - name: Create NuGet package + run: dotnet pack -c release + + - name: Push NuGet package + run: dotnet nuget push "FIXXME/bin/Release/alterNERDtive.YAVAPF.*.nupkg" -source 'https://api.nuget.org/v3/index.json' -apikey ${{secrets.NUGET_AUTH_TOKEN}} + + - name: Draft release + uses: ncipollo/release-action@v1 + with: + artifacts: "FIXXME/bin/Release/alterNERDtive.YAVAPF.*.nupkg" + bodyFile: "CHANGELOG.md" + draft: true diff --git a/.github/workflows/push-test.yaml b/.github/workflows/push-test.yaml new file mode 100644 index 0000000..2d69950 --- /dev/null +++ b/.github/workflows/push-test.yaml @@ -0,0 +1,29 @@ +name: Run tests on push push + +on: + push + +jobs: + build: + name: Test EDNA + runs-on: windows-latest + permissions: + contents: write + + steps: + - name: Checkout source code + uses: actions/checkout@v2 + + - name: Setup .Net + uses: actions/setup-dotnet@v2 + with: + dotnet-version: '6.0.x' + + - name: Restore dependencies + run: dotnet restore + + - name: Build + run: dotnet build -c release + + - name: Run tests + run: dotnet test diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..883ffeb --- /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 + +# 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/ +[Oo]ut/ +[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 + +/ExamplePlugin/Properties/launchSettings.json diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..30e32c9 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,3 @@ +# devel + +initial release \ No newline at end of file diff --git a/Directory.Build.props b/Directory.Build.props new file mode 100644 index 0000000..410b1ce --- /dev/null +++ b/Directory.Build.props @@ -0,0 +1,21 @@ + + + + $(SolutionDir)StyleCop.ruleset + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + + diff --git a/Directory.Build.targets b/Directory.Build.targets new file mode 100644 index 0000000..bac3667 --- /dev/null +++ b/Directory.Build.targets @@ -0,0 +1,6 @@ + + + 10.0 + enable + + diff --git a/ExamplePlugin/ExamplePlugin.cs b/ExamplePlugin/ExamplePlugin.cs new file mode 100644 index 0000000..2118df5 --- /dev/null +++ b/ExamplePlugin/ExamplePlugin.cs @@ -0,0 +1,53 @@ +// +// Copyright 2022 alterNERDtive. +// +// This file is part of YAVAPF. +// +// YAVAPF is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// YAVAPF is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with YAVAPF. If not, see <https://www.gnu.org/licenses/>. +// + +using System; + +namespace alterNERDtive.Yavapf.Example +{ + public class ExamplePlugin + { + private static readonly VoiceAttackPlugin Plugin; + + static ExamplePlugin() + { + Plugin = new () + { + Name = "Example Plugin", + Version = "0.0.1", + Info = "This is a description", + Guid = "{76FE674F-F729-45FD-A1DD-E53E9E66B360}", + }; + } + + public static string VA_DisplayName() => Plugin.VA_DisplayName(); + + public static string VA_DisplayInfo() => Plugin.VA_DisplayInfo(); + + public static Guid VA_Id() => Plugin.VA_Id(); + + public static void VA_Init1(dynamic vaProxy) => Plugin.VA_Init1(vaProxy); + + public static void VA_Invoke1(dynamic vaProxy) => Plugin.VA_Invoke1(vaProxy); + + public static void VA_Exit1(dynamic vaProxy) => Plugin.VA_Exit1(vaProxy); + + public static void VA_StopCommand() => Plugin.VA_StopCommand(); + } +} diff --git a/ExamplePlugin/ExamplePlugin.csproj b/ExamplePlugin/ExamplePlugin.csproj new file mode 100644 index 0000000..37855b7 --- /dev/null +++ b/ExamplePlugin/ExamplePlugin.csproj @@ -0,0 +1,28 @@ + + + + net48 + alterNERDtive.Yavapf.Example + enable + + + + + + + + + True + True + Settings.settings + + + + + + SettingsSingleFileGenerator + Settings.Designer.cs + + + + diff --git a/ExamplePlugin/Properties/Settings.Designer.cs b/ExamplePlugin/Properties/Settings.Designer.cs new file mode 100644 index 0000000..9a7f3e6 --- /dev/null +++ b/ExamplePlugin/Properties/Settings.Designer.cs @@ -0,0 +1,26 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +namespace alterNERDtive.Yavapf.Example.Properties { + + + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "17.3.0.0")] + internal sealed partial class Settings : global::System.Configuration.ApplicationSettingsBase { + + private static Settings defaultInstance = ((Settings)(global::System.Configuration.ApplicationSettingsBase.Synchronized(new Settings()))); + + public static Settings Default { + get { + return defaultInstance; + } + } + } +} diff --git a/ExamplePlugin/Properties/Settings.settings b/ExamplePlugin/Properties/Settings.settings new file mode 100644 index 0000000..049245f --- /dev/null +++ b/ExamplePlugin/Properties/Settings.settings @@ -0,0 +1,6 @@ + + + + + + diff --git a/ExamplePlugin/Properties/launchSettings.sample.json b/ExamplePlugin/Properties/launchSettings.sample.json new file mode 100644 index 0000000..d8c9ecd --- /dev/null +++ b/ExamplePlugin/Properties/launchSettings.sample.json @@ -0,0 +1,11 @@ +{ + "profiles": { + "ExamplePlugin": { + "commandName": "Executable", + "executablePath": "C:\\Program Files\\VoiceAttack\\VoiceAttack.exe", + "commandLineArgs": "-datadir %TEMP%", + "workingDirectory": "C:\\Program Files\\VoiceAttack\\", + "nativeDebugging": false + } + } +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..dbddda2 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +# EDNA – An Elite Dangerous System Data Library + +EDNA is a library for third party apps that want to access data about star +systems, stations and CMDRs of the game Elite Dangerous. It can query +[EDSM](https://edsm.net), [Spansh](https://spansh.uk) and +[EDTS](http://edts.thargoid.space) for data. + +The general idea is that you usually do not care _where_ your data comes from, +so this will get it for you wherever it can depending on data availability and +API features. + +**THIS IS A HEAVY WIP PROJECT AND *NOT* READY FOR PRODUCTION USE.** Just saying. + +## Why EDNA⁈ + +Why not. I find it quite funny that most Elite-related project are 4 letter +acronyms starting with “ED”. So I stuck to that, and I had just played “Edna & +Harvey: The Breakout” with the kids. It’s not actually an acronym though because +I couldn’t come up with a meaning for NA. + +## TODO for first proper release + +- [x] README +- [ ] Documentation +- [ ] Spansh API + - [ ] system data + - [ ] nearest system + - [ ] station data + - [ ] outdated stations + - [ ] rest (probably out of scope for now) +- [ ] EDSM API + - [x] Systems + - [x] Logs (CMDR data) + - [ ] Stations (probably out of scope for now) +- [x] EDTS API + - [x] system position +- [ ] convenience layer / unification +- [ ] sanity check / refactoring +- [ ] nuget package +- [ ] Github Actions build / package automation + +[![GitHub Sponsors](https://img.shields.io/github/sponsors/alterNERDtive?style=for-the-badge)](https://github.com/sponsors/alterNERDtive) +[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/S6S1DLYBS) diff --git a/VoiceAttack-Framework.sln b/VoiceAttack-Framework.sln new file mode 100644 index 0000000..2a754cb --- /dev/null +++ b/VoiceAttack-Framework.sln @@ -0,0 +1,63 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 17 +VisualStudioVersion = 17.3.32611.2 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "VoiceAttack-Framework", "VoiceAttack-Framework\VoiceAttack-Framework.csproj", "{788DDBA5-E959-4153-8580-4462600F2960}" +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{9E9DD44C-8D0E-4E41-BD7B-3588B94D007D}" + ProjectSection(SolutionItems) = preProject + .editorconfig = .editorconfig + .gitignore = .gitignore + CHANGELOG.md = CHANGELOG.md + Directory.Build.props = Directory.Build.props + Directory.Build.targets = Directory.Build.targets + glider.jpg = glider.jpg + LICENSE = LICENSE + README.md = README.md + stylecop.json = stylecop.json + EndProjectSection +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{1BE45F7D-E6DE-49D2-A906-5CC9CD49B639}" + ProjectSection(SolutionItems) = preProject + .github\FUNDING.yml = .github\FUNDING.yml + .github\workflows\push-test.yaml = .github\workflows\push-test.yaml + EndProjectSection +EndProject +Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{9109DB0F-4765-4C7E-9E65-53C729D6251D}" + ProjectSection(SolutionItems) = preProject + .github\workflows\create-release.yaml = .github\workflows\create-release.yaml + .github\dependabot.yaml = .github\dependabot.yaml + EndProjectSection +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ExamplePlugin", "ExamplePlugin\ExamplePlugin.csproj", "{E390356B-4039-4364-B49C-38A37046A7BD}" + ProjectSection(ProjectDependencies) = postProject + {788DDBA5-E959-4153-8580-4462600F2960} = {788DDBA5-E959-4153-8580-4462600F2960} + EndProjectSection +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {788DDBA5-E959-4153-8580-4462600F2960}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {788DDBA5-E959-4153-8580-4462600F2960}.Debug|Any CPU.Build.0 = Debug|Any CPU + {788DDBA5-E959-4153-8580-4462600F2960}.Release|Any CPU.ActiveCfg = Release|Any CPU + {788DDBA5-E959-4153-8580-4462600F2960}.Release|Any CPU.Build.0 = Release|Any CPU + {E390356B-4039-4364-B49C-38A37046A7BD}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E390356B-4039-4364-B49C-38A37046A7BD}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E390356B-4039-4364-B49C-38A37046A7BD}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E390356B-4039-4364-B49C-38A37046A7BD}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(NestedProjects) = preSolution + {1BE45F7D-E6DE-49D2-A906-5CC9CD49B639} = {9E9DD44C-8D0E-4E41-BD7B-3588B94D007D} + {9109DB0F-4765-4C7E-9E65-53C729D6251D} = {1BE45F7D-E6DE-49D2-A906-5CC9CD49B639} + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {3BD38511-A1FB-4B6C-8463-AE6D8E546AE0} + EndGlobalSection +EndGlobal diff --git a/VoiceAttack-Framework/GlobalSuppressions.cs b/VoiceAttack-Framework/GlobalSuppressions.cs new file mode 100644 index 0000000..ebe7e57 --- /dev/null +++ b/VoiceAttack-Framework/GlobalSuppressions.cs @@ -0,0 +1,8 @@ +// This file is used by Code Analysis to maintain SuppressMessage +// attributes that are applied to this project. +// Project-level suppressions either have no target or are given +// a specific target and scoped to a namespace, type, member, etc. + +using System.Diagnostics.CodeAnalysis; + +[assembly: SuppressMessage("StyleCop.CSharp.NamingRules", "SA1300:Element should begin with upper-case letter", Justification = "because that’s my name", Scope = "namespace", Target = "~N:alterNERDtive.Yavapf")] diff --git a/VoiceAttack-Framework/VoiceAttack-Framework.csproj b/VoiceAttack-Framework/VoiceAttack-Framework.csproj new file mode 100644 index 0000000..a963370 --- /dev/null +++ b/VoiceAttack-Framework/VoiceAttack-Framework.csproj @@ -0,0 +1,44 @@ + + + + net48 + alterNERDtive.YAVAPF + alterNERDtive.YAVAPF + 0.0.1 + alterNERDtive + alterNERDtive + YAVAPF is yet another VoiceAttack plugin framework. + GPL-3.0-or-later + https://alterNERDtive.github.io/YAVAPF + © 2022 alterNERDtive + glider.jpg + + https://github.com/alterNERDtive/YAVAPF + git + VoiceAttack + en + enable + True + Yet Another VoiceAttack Plugin Framework + README.md + True + True + snupkg + + + + + True + + + + True + \ + + + + + + + + diff --git a/VoiceAttack-Framework/VoiceAttackPlugin.cs b/VoiceAttack-Framework/VoiceAttackPlugin.cs new file mode 100644 index 0000000..08e02ba --- /dev/null +++ b/VoiceAttack-Framework/VoiceAttackPlugin.cs @@ -0,0 +1,81 @@ +// +// Copyright 2022 alterNERDtive. +// +// This file is part of YAVAPF. +// +// YAVAPF is free software: you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation, either version 3 of the License, or +// (at your option) any later version. +// +// YAVAPF is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with YAVAPF. If not, see <https://www.gnu.org/licenses/>. +// + +using System; + +namespace alterNERDtive.Yavapf +{ + public class VoiceAttackPlugin + { + public string Name { get; set; } + + public string Version { get; set; } + + public string Info { get; set; } + + public string Guid { get; set; } + + private dynamic? vaProxy; + + public string VA_DisplayName() => $"{this.Name} v{this.Version}"; + + public string VA_DisplayInfo() => this.Info; + + public Guid VA_Id() => new (this.Guid); + + public void VA_Init1(dynamic vaProxy) + { + this.vaProxy = vaProxy; + this.vaProxy.TextVariableChanged += new Action(this.TextVariableChanged); + this.vaProxy.IntegerVariableChanged += new Action(this.IntegerVariableChanged); + this.vaProxy.DecimalVariableChanged += new Action(this.DecimalVariableChanged); + this.vaProxy.BooleanVariableChanged += new Action(this.BooleanVariableChanged); + this.vaProxy.DateVariableChanged += new Action(this.DateVariableChanged); + } + + public void VA_Invoke1(dynamic vaProxy) + { + this.vaProxy = vaProxy; + } + + public void VA_Exit1(dynamic vaProxy) + { + this.vaProxy = vaProxy; + } + + public void VA_StopCommand() + { + } + + private void TextVariableChanged(string name, string from, string to, Guid? internalID = null) + { } + + private void IntegerVariableChanged(string name, int? from, int? to, Guid? internalID = null) + { } + + private void DecimalVariableChanged(string name, decimal? from, decimal? to, Guid? internalID = null) + { } + + private void BooleanVariableChanged(string name, bool? from, bool? to, Guid? internalID = null) + { } + + private void DateVariableChanged(string name, DateTime? from, DateTime? to, Guid? internalID = null) + { } + } +} diff --git a/glider.jpg b/glider.jpg new file mode 100644 index 0000000000000000000000000000000000000000..33e93ff08e15b47098f3d4702006a199d2cc3597 GIT binary patch literal 10791 zcmeHsbzD_jxAxjiZ4g0_Mo~&ax=W-EAl=>F9g>O&5+WdtB9aP9hjdAZ0s@kPNVjy~ zwU6&T$M^fL=k<-h?(Yuxt^Ld~$1}#5W6r(STyvj&I-3H{{U$9Z4L~3eKo22LPCuxj8GU zNvi{($Vo}kx`9R*{5Ju8><$6o6#xcUWtC}Z|EB-d4?;6%S9bt_D1!tpa|<^!5Z?i@ zy_dT)M!x}KVpBT|hQcw}6-*Gs7ctoCJ7)Ra<~tV0U~>mYbI=Bpv$MH_IR>|aINa02 z0>m%{5Qll%Sa^Z>BZ#lqdpOvDcpt>X4i+YE0076s=-n;MtU-Jo#CWdis*)fU1^_HP zs~@oG57^zp8_W{`B%PdnTy3nZ-Dw%km}of!1o&xXExhb4+}&A~P0Z{}T+L}EogAD^ z9DM-b`=k>0f374Ka7V2vtF#--JJ#5*}c5H*laA! z*f0hCL;j(`AC^A{Kg46h#QURmv^Om*O+4(~X)#4LbFz2xaHVx~HZilHW&M8_@xM&` zA*~1Vd?ptIWpH3Y>07a~pRXCr4Tv$DhsczexKb2Mqkau0cSQeF_j8 zu>t4a69cf-9so{+3&8XLSaxmC^3`@N)Kg+@Q4Ioq{eycVGYv7e)fR1Y?Eq!z5u!FkP4>%oP>@i-0A~C=`kebqytgQbL)a z+)-huWYh~(1F9c2i`vJ+#iGID#FEC+#d5?7!Ais`z^cdU$C}4F!aj$66F79Pq0bCVa8{8n=B-~fH zZ*iw_5Ae?8G2=<%>En6eMdRh-HR6rnZK2Uf~y1)1cn5@1c?Nt1n&t}&S9UUKPP$4?B+`k2+6(Uh2I0`8(&Ioo_imLj)tDBa$RCBMK$TCTb&^B}Ni65X%wU z5=RohB<>~NxN!ag_XW)h-WO6Y)Lob&fsxRY$dTBS#E_Jb43Qj?QjtoKT9Do+Eh6nF z-MdI}QT(FC#fXc=7Y8pMlF^b$k=ck!O&%k*`n?QwUL*QAALb zP>fPSDVZr%Dg7v)QT9;oP*GFKP&rd2Q?*d7P?J!LQ`=IqHU$!xI}qL_L9e?rPRW zulQdnyfS(f`zrrc>#L8ic3j<~XQ0=jzeit5zrb*jL5{(fp^#ym5zQ#Z=)#!A_>l?8 z#Lr~Ml+N^l8OqGVY|Wg?{QesB8t*lmYw6eeSP(1%ERHN$EW@mLtP-rAtc9%8Y$R+7 zY$0rwY-{XS*mc<-vUjkbUgx=Pe?9y97{_^z-#9`zYB;`eGIN@7rgDDdLUT!T1#(q! zZE|1Zw&2d-{=`GXqsViQrFTp1lNUFh3te1gcgJuge`=#g=a)Aiqy!{Kog&?cZAE@#NLyQ{=xWFe|t!)F?s~e^Y#< zIDYHuEyr7xN`R7_(j%n_Wd>yz79tjL z7W0-OmT{H~Rw7o9tQM`stP`zQY$R<`Y&LCWZ8L56?3Caf7%SxK+6mgPW-y4@Qr>9@Czpo~fSuUYcH| z-h|$c-aS6dKKFg*eWiV$`@#Lp{F?nQ`3L(?-Ev+$OyDKG*%^`==4+5nYkj zBNHQ!ADBJpisFb$iaLw7jP8x$jmd~b#yZ9hJrsMG7e^T98#nVv@li!QZG1%hc7jnt zXCilE=3|`49*?Jz6q2fvuO!DNAE#KS45r>lEl#6MyPvj~Zl2zsA)Zl`NtGFydHBTU z$)~3>Pb;$Mvl5>npLsr;%ht^9c+USkKZiUgGUp`MF?T9YHLo?FFF(J4vLL1qTIf-@ z_(K21hnF{BRu!=pJuN0Fj(i2Y@_4oM+W7TQiF`?ODSv5E+10YNa-#Bx3P^=d#YUxd z1ol)vM7SKiCpTk)Rnebonn z4>f(lef9lf{Y?Wm2iiZ%ee52*HP|<#G4yFze|YMX`KN^u`;pC2&(Wi?pmD@_#KgIY z#7WA@tj|oJi>G*}>ZWf__k2+$TJIrLoOJk5Om0_Vb;Md`&4OL|MQ z%g)P3D`BgIt7&VDYh~-=>pdIV8?&3Pn`hr1Y>{o{ZgX!p?&m7Lq&c*;q%zMV40tFwk7=goJP#6M^Kp^07I0A`6 zA`mDf9FD|BqOdT6Kw{%yW8q*L7$+D97#8@C1+soO`KK;tjQ}AQBo?v_gAf8xLI{iy za@GpafLj^}41sy!`EP;1aB!h;Fbf1WXkc*;G=RY1DD*ir3KxMffVWYCWd&u6%OF$;qlRSKlFjY(%Aqr@d;J zI*)}W+D6YjC&D_Xu$QW^fGJo144`Ej=PKa$zV;E7qBFv>bO>qr+1wKk-`cDWB)*ae+oH#nz-wlmy(RB}&Wt9;?vR znb4gxz(mGkhLr!fO*7EiPAS1UWq^y*GlnzT&7k3}PqD?LV&c#CP6wjx_fvJ5lT&yf z*IK7Agm|=Ww#u>vMKi*KeyudHutm~!x90@!D5o|wRxU<5+$Q!P_4|Nh4AP-rMJ+xL z0R5j;#!IK|V{td>A|SM&{#RtWM(SvMQF2R$U-*I_^75FG6b*02HZ%#tttLqJ+HT~o z{OHB9uXhD{Ec+!0JdgP$;dgu(uqUW|+}BHhFl-91819pKms#*1;gg*IuuGG#5_R@t&y7iS6r`M9wMj{_B8^0#GN z-`_0}XK(%ATU^VBIZS=+@wNq~DQ4VmA(mDVVku6>tp+w6Jkt5Y^FLPPe)tH`KU5t) z{B*puaQf8qpQ|@o(_{40sEUJ$jX_j7S4B>NmHL42YtbisgtzNjZ%UOD5;hT%X!_Gk zzygg#d^6f)B9N!`zB?ijF~sN-|D7ej3)GAhhX>0acbSEi`F6I3^H9mG$Z977_P3R`mWj+J&R(IisKpK_aKnkZk?Vjua1Kqlyyd;(C0 z2nlm59<@HjJH6Qz4RV}StacbCdHzghoL^(tdT2)I@nsK&o(5oCVgYkZ`YUpCQ1Mq9#_lE0AC zY^ADal%1?kQXT}-(CVA-J4L1}yqexioDvE?nllP=q}}%Z#}0qDxa^%xBJHLjLi|Z# zN#1Vz(Y27FS6~OEAVc7Q;SFBVzQBT5GlQys_XfI^8gu6LGeKOF_oHA6FDox8&5Tl) zuCHQR@6Ii8oQTVOfj)5GRU9i(+X-%9%jm52{4L-W-|WB$pJS)e5c0UjkA8K8>9Fzh zV{N8&8jlUou@701n=UkWk|pQwXG`P0m-D8(d!#fq!SY>i3(xw2 zU~}`PXX?q^L5=Q!Z_SuSjl+6k{BlHA`b+MOo6E@r5T7Kfn9oiMdZ#0A16vxmt_#uB zPbO8Kl*XO`_k!n)J;iR3pLcsDPpMJK!Jkfcx7!+4)9xJ$ z6L7&^AFVD%29603?0ZvN;+h@uEDhwaehHi>0~Ks!eTk-D9Y_|2r4QNPb z)y8evF-)?T_ZiG>dQ|JL6jf*@4(bd@5!q;v5D%&kC~~jnc-)lEL-GG?-atL#m2hA0 z^-ZzH+^sa@OTz9raPA!Om)za0ZC9zcVCKAiTI1wd88K&9G|BwBq|m*<@};|) z;7%jQ!PexiDocK8X|6dbX(@4^!p*_V>Km5cbkUXr`tMtWY27~Ws@82N80_u^ehd1y z8z&=key?YuD3xX;nFh{68^v6SnE<$(GcFy zHQ&j#{Aj@U#o>L9X!z!*VXX*kyxgKV7g)^s*1WKq^z|B3rr2Ib)J z1Rmm4F2kt4Q@rdVCL8tFM-GpBqxU(zrmpoTHV<$6S8iCUA~|q>zR87^`TPeSh|u@= zw##c_&@ENeXT_u{`9d(i z?*aPvdTI}i$@P|m68%}@Afv+nf#(y%>K>2Bo+KnN&g$`ci83n^6X*gvwFPr zeVpy*ugXtoSdYo#gCE@Zi>>-9wQX)zDt5Y@LqME`v+fYa506@h*pN%u4+@f5F1 zy#12h!n3)7$sje15$UBZw$mhJ;$ie`Ca!sqXUu-Q~{chec`5Ex;+vlca*^8}z|LVnN@x_$m40zs|93Jy(O=so| zNc}xE6%PKKX7kq8j!%EvuwWej(;F6ORQXF@ZViKgFuFS=Ic~DLh=B?Qr%!@~;^Y_m z1Ckiu@(K)_Br?D2iFAsmqaSv#dBj{2=~I&PvezzBNG{i*(4nkQv+l(bu8EadD2@6d z3x(;e%*R~oug`!XH07Ft-%<4IOQU!9Izt4;t9JINzKE4mtUrRKcgGmHOwt{x)b9tm zRl6*&3AF~=@_jys@5Lr^yTdzXRr=@)%pjwKSH!fxH?U`&@c4qv5#8-gh(9k;X{4+` zRA|rj1vP$GHqCeAQ`HM0i?L1zmru-iNedIc4bvMgrk0l{_!g8_jOh(1j0_g!rDV}x zHYX91?$8ur%`Yv_MQO)H*k&b%7jmtC>~WT%RLrQ#4DlA9cbyp?_X!Bwaz`>e)#-0+{R2w068YDHU7w> zOTh2a*tp~FUZMW$INL}ZR#uzvf`03giUOu+Ds>IP@|$l3CVMMFHrXR4n5QF!%VeI4 zFfQ88J}N~X#kt;H=KIE4ciJ`Uoy$H;p=PD5%jpVKrr{kX&~Z%n)1zQI5w|b=fbXo*=2=>}BT-f;LDr_wUYIU6 zi1IWyKv)@l(_^r$UM@|2(3_VV;=gM6L=cCYDXpyUrc`rsy2?Hcz}*|hl_56xQE3UL z^vOz~VdCTNb?YO1EB2!bp^Nm~d}#xxFQePhMkZ-%KQg2=i?c{+!qJ6CaX8v$hwr!G7M5*-G#-};#+bxd zC&mv*!@@AfZJDLeK#O}1O4Zv(d%MJxX{5XH1#WmaeCZNXr!j0nCn&Tp^BR3bjn_<9 zGPHtNP3$^l#{9jN$y({rS|Nd?`^V?}S~%Tcm**xGI(hW%D-xXa@EMN{Xjk&0#AAOl zBcPf}BfG$J@TCLCr`2Wj<-M5WEz zrwXML6)bk{cLfiRB~Vu?X`_2H;^?-ao?u!GHdKrhMv-Sgx-*z%sKQ8Vn{Hk-6Do(( z3aQxXat7d<9o0zG|9t2GO3!MC!nZ^TS&!>@0xZ|9x6NA>VNags4Eat)tru=!8fO4$ z4RUXIpKBQAcWk&o&vuw2yzWjl@{mr`!Tj*H;w;C>XmCIAC!a2Qn+(RC0KoQl3RY@; zabxlcZF-9qvR`n@DKK&Z?nraqcPf2-)9=ZgPn1r<(04Z<6o#-`WjspT&2-T^?|QW|KU(9A5Jx04RTt2 z({>G1w>1@S2a{Y-BFRVDnHPANQzTG6HZYoq^$;QTt%!G)A%nJjiuYKcdb%-JvbaAaOG|UF0ZSrP=$4&+z|8#xN&$TxE2{ z#~G&9Lg?2uhl;Q=uu-n#-fUis$5NT#`QN9%7$JX#tB&GJEmqwbb*<0Yl$LBmX}WWC zU*YSzhc?TwTf1e0!p2E8!yGMKLvX3lhA1F?*@$H)n8Tw$LV<5$~bH&t>5)JSw>t=cRt2PsUv6tFb=3Uw@RbynC3rWhTF z3A=(-tE)uW1NC~TUpfR=9IexE?tS8^F&wh)5iQS5ck~MV_AiDkimzQVLBHC@Md2v+ zfgq}mVG8E!0;v;G+JyNk9L5LNF~r4QUKD*HbCKTh4F?Ay@O4kuvyy^bM7v~gJl4g! z##yb2NHADv$cHH=7QMI;5TlG<6fCz5lHN}G5)Q83MPc%Cr7q-lhR937rtK2Nuvwq7 z%(fmcWAblx(Tm)bJfotmvgEY7_y7tNTv9n5E- zyH9s4(NnZp(B3Y<2%hQwerEEMff1zpgM;esT^_7JcKgZ5B6p)>(W_Ln6r+OTd}Z!I zPS%S+WSM(P@D5A<=qDAWt2EQJ2QHpbD)Sz}bt%oRdD>p@XBWzmUv z+tM6Staa#@}R%S{(pBD>TKk{03h!I3IG5A literal 0 HcmV?d00001 diff --git a/stylecop.json b/stylecop.json new file mode 100644 index 0000000..494d901 --- /dev/null +++ b/stylecop.json @@ -0,0 +1,16 @@ +{ + "$schema": "https://raw.githubusercontent.com/DotNetAnalyzers/StyleCopAnalyzers/master/StyleCop.Analyzers/StyleCop.Analyzers/Settings/stylecop.schema.json", + "settings": { + "orderingRules": { + "usingDirectivesPlacement": "outsideNamespace" + }, + "documentationRules": { + "companyName": "alterNERDtive", + "copyrightText": "Copyright {year} {companyName}.\n\nThis file is part of {application}.\n\n{application} is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\n{application} is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with {application}. If not, see .", + "variables": { + "application": "YAVAPF", + "year": "2022" + } + } + } +}