Skip to content

Commit

Permalink
Minor house-keeping
Browse files Browse the repository at this point in the history
  • Loading branch information
steinerd committed Apr 13, 2022
1 parent 5be2fa1 commit b445b48
Show file tree
Hide file tree
Showing 10 changed files with 203 additions and 14 deletions.
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
**Version**
<!-- Version Number, easist way to find out is to find the DLL in %localappdata%\Loupedeck\Plugins\AudioSwitcher\% and right-click it to inspect it's properties. -->

**Submitting a...**
<!-- Please check ONE, or write-in additional option if options provided are not applicable -->
[ ] Bug report
[ ] Feature request

**Current behavior:**
<!-- Describe how the bug manifests. Leave blank if feature -->

**Expected behavior:**
<!-- Describe what the behavior would be without the bug. Leave blank if feature -->

**Steps to reproduce:**
<!-- Please explain the steps required to duplicate the issue, especially if you are able to provide a sample application. Leave blank if feature -->

**Other information:**
<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->
39 changes: 39 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

## How Has This Been Tested? [Optional]

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

- [ ] Test A
- [ ] Test B

**Test Configuration**:
* Firmware version:
* Hardware:
* Toolchain:
* SDK:

## Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published in downstream modules
- [ ] I have checked my code and corrected any misspellings
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Anthony Steiner

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
14 changes: 14 additions & 0 deletions LoupedeckPackage.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
type: plugin4
name: RemoteApps
displayName: RemoteApps
version: 1.0.0
author: Steinerd.com
copyright: Copyright (c) 2022 Anthony Steiner

supportedDevices:
- LoupedeckCt
- LoupedeckLive

pluginFileName: RemoteAppsPlugin.dll
pluginFolderWin: ./bin/win/
pluginFolderMac: ./bin/mac/
65 changes: 64 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,64 @@
RemoteAppsPlugin
# RemoteApps Loupedeck Plugin
[![License](http://img.shields.io/:license-MIT-blue.svg?style=flat)](LICENSE)
![forks](https://img.shields.io/github/forks/Steinerd/Loupedeck.RemoteAppsPlugin?style=flat)
![stars](https://img.shields.io/github/stars/Steinerd/Loupedeck.RemoteAppsPlugin?style=flat)
![issues](https://img.shields.io/github/issues/Steinerd/Loupedeck.RemoteAppsPlugin?style=flat)
[![downloads](https://img.shields.io/github/downloads/Steinerd/Loupedeck.RemoteAppsPlugin/latest/total?style=flat)](https://github.com/Steinerd/Loupedeck.RemoteAppsPlugin/compare)


--------

# Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Support](#support)
- [Contributing](#contributing)
- [License](#license)

# Installation

<details><summary><b>Loupedeck Installation</b></summary>


1. Go to [latest release](https://github.com/Steinerd/Loupedeck.RemoteAppsPlugin/releases/latest), and download the `lplug4` file to you computer
1. Open (normally double-click) to install, the Loupedeck software should take care of the rest
1. Restart Loupedeck (if not handled by the installer)
1. In the Loupedeck interface, enable **RemoteApps** by clicking <ins>Manage plugins</ins>
1. Check the RemoteApps box on to enable
1. Drag the desired control onto your layout

Once click it will bring you to a dynamic playback device selection page.
</details>

<details><summary><b>IDE Installation</b></summary>
Made with Visual Studio 2022, C# will likely only compile in VS2019 or greater.

Assuming Loupedeck is already installed on your machine, make sure you've stopped it before you debug the project.

Debugging _should_ build the solution, which will then output the DLL, config, and pdb into your `%LocalAppData%\Loupedeck\Plugins` directory.

If all goes well, Loupedeck will then open and you can then debug.

</details>

# Usage

First, follow the __Loupedeck Installation__ instructions above.

Just drag and drop the "Remote Apps" control onto your layout.

# Support

[Submit an issue](https://github.com/Steinerd/Loupedeck.RemoteAppsPlugin/issues/new)

Fill out the template to the best of your abilities and send it through.

# Contribute

Easily done. Just [open a pull request](https://github.com/Steinerd/Loupedeck.RemoteAppsPlugin/compare).

Don't worry about specifics, I'll handle the minutia.

# License
The MIT-License for this plugin can be reviewed at [LICENSE](LICENSE) attached to this repo.
19 changes: 16 additions & 3 deletions RemoteAppsPlugin.sln
Original file line number Diff line number Diff line change
@@ -1,10 +1,23 @@

Microsoft Visual Studio Solution File, Format Version 12.00
# Visual Studio Version 16
VisualStudioVersion = 16.0.30128.74
# Visual Studio Version 17
VisualStudioVersion = 17.1.32328.378
MinimumVisualStudioVersion = 10.0.40219.1
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "RemoteAppsPlugin", "RemoteAppsPlugin\RemoteAppsPlugin.csproj", "{8F32CD70-8A6C-4369-A3BC-3ABFFC8733F4}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{1E53451E-31A7-4B98-9EB7-398A06864E73}"
ProjectSection(SolutionItems) = preProject
build-plugin.ps1 = build-plugin.ps1
LICENSE = LICENSE
LoupedeckPackage.yaml = LoupedeckPackage.yaml
README.md = README.md
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".github", ".github", "{0C179F79-C216-430C-A866-22579106F348}"
ProjectSection(SolutionItems) = preProject
.github\ISSUE_TEMPLATE.md = .github\ISSUE_TEMPLATE.md
.github\PULL_REQUEST_TEMPLATE.md = .github\PULL_REQUEST_TEMPLATE.md
EndProjectSection
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down
9 changes: 3 additions & 6 deletions RemoteAppsPlugin/RemoteAppsFolder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,9 @@ public override IEnumerable<String> GetButtonPressActionNames()
PluginDynamicFolder.NavigateUpActionName,
};

if (RemoteAppsPlugin.CurrentRemoteApps.Count() > 0)
{
return systemButtons.Concat(RemoteAppsPlugin.CurrentRemoteApps.Select(s => this.CreateCommandName(s.Name)));
}

return systemButtons.Concat(new[] { this.CreateCommandName("Nothing\nFound") });
return RemoteAppsPlugin.CurrentRemoteApps.Count() > 0
? systemButtons.Concat(RemoteAppsPlugin.CurrentRemoteApps.Select(s => this.CreateCommandName(s.Name)))
: systemButtons.Concat(new[] { this.CreateCommandName("Nothing\nFound") });
}

public override BitmapImage GetCommandImage(String actionParameter, PluginImageSize imageSize)
Expand Down
4 changes: 1 addition & 3 deletions RemoteAppsPlugin/RemoteAppsPlugin.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,7 @@
<Reference Include="PluginApi, Version=2.0.0.0, Culture=neutral, processorArchitecture=MSIL">
<SpecificVersion>False</SpecificVersion>
<HintPath>C:\Program Files (x86)\Loupedeck\Loupedeck2\PluginApi.dll</HintPath>
</Reference>
<Reference Include="RdRemoteAppsParser, Version=1.1.1.0, Culture=neutral, processorArchitecture=MSIL">
<HintPath>..\packages\RdRemoteAppsParser.1.1.1\lib\netstandard2.0\RdRemoteAppsParser.dll</HintPath>
<Private>False</Private>
</Reference>
<Reference Include="System" />
<Reference Include="System.Core" />
Expand Down
1 change: 0 additions & 1 deletion RemoteAppsPlugin/packages.config
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@
<packages>
<package id="Costura.Fody" version="4.1.0" targetFramework="net472" />
<package id="Fody" version="6.0.0" targetFramework="net472" developmentDependency="true" />
<package id="RdRemoteAppsParser" version="1.1.1" targetFramework="net472" />
</packages>
26 changes: 26 additions & 0 deletions build-plugin.ps1
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
$version = "1.0"
$project = "RemoteApps"
$dllName = "RemoteAppsPlugin.dll"
$dllPath = "$($env:LOCALAPPDATA)\Loupedeck\Plugins\$project"
$buildPath = ".builds"
$outputFileName = "$project"
$zipPath = "$buildPath\$outputFileName.zip"
$pluginName = "$outputFileName.lplug4"
$loupedeckYaml = "LoupedeckPackage.yaml"
$cwd = Get-Location

New-Item -Path "$buildPath" -Force -Name "bin" -ItemType "directory" > $null
New-Item -Path "$buildPath\bin" -Force -Name "win" -ItemType "directory" > $null
New-Item -Path "$buildPath\bin" -Force -Name "mac" -ItemType "directory" > $null

Copy-Item $loupedeckYaml -Force -Destination $buildPath > $null
Copy-Item "$dllPath\$dllName" -Force -Destination "$buildPath\bin\win\$dllName" > $null

$compress = @{
Path = "$buildPath\*"
CompressionLevel = "Fastest"
DestinationPath = $zipPath
}
Compress-Archive @Compress > $null

Rename-Item $zipPath -Force -NewName $pluginName > $null

0 comments on commit b445b48

Please sign in to comment.