Skip to content

Commit

Permalink
Merge pull request ConfusedPolarBear#16 from jellyfin/meta
Browse files Browse the repository at this point in the history
Update metadata and remove deprecated checkbox method
  • Loading branch information
anthonylavado authored May 26, 2020
2 parents d623136 + 65ad257 commit 9e6ec93
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 23 deletions.
4 changes: 2 additions & 2 deletions Jellyfin.Plugin.Template/Configuration/configPage.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
ApiClient.getPluginConfiguration(TemplateConfig.pluginUniqueId).then(function (config) {
$('#Options').val(config.Options).change();
$('#AnInteger').val(config.AnInteger).change();
$('#TrueFalseSetting').checked(config.TrueFalseSetting).checkboxradio("refresh");
$('#TrueFalseSetting').checked = config.TrueFalseSetting;
$('#AString').val(config.AString).change();
Dashboard.hideLoadingMsg();
});
Expand All @@ -61,7 +61,7 @@
ApiClient.getPluginConfiguration(TemplateConfig.pluginUniqueId).then(function (config) {
config.Options = $('#Options').val();
config.AnInteger = $('#AnInteger').val();
config.TrueFalseSetting = $('#TrueFalseSetting').prop('checked');
config.TrueFalseSetting = $('#TrueFalseSetting').checked;
config.AString = $('#AString').val();
ApiClient.updatePluginConfiguration(TemplateConfig.pluginUniqueId, config).then(function (result) {
Dashboard.processPluginConfigurationUpdateResult(result);
Expand Down
11 changes: 4 additions & 7 deletions Jellyfin.Plugin.Template/Jellyfin.Plugin.Template.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,17 @@
<PropertyGroup>
<TargetFramework>netstandard2.1</TargetFramework>
<RootNamespace>Jellyfin.Plugin.Template</RootNamespace>
<AssemblyVersion>7.0.0</AssemblyVersion>
<FileVersion>7.0.0</FileVersion>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<FileVersion>1.0.0.0</FileVersion>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Jellyfin.Controller" Version="10.5.*" />
<PackageReference Include="Jellyfin.Model" Version="10.5.*" />
<PackageReference Include="Jellyfin.Controller" Version="10.*" />
<PackageReference Include="Jellyfin.Model" Version="10.*" />
</ItemGroup>

<ItemGroup>
<None Remove="Configuration\configPage.html" />
</ItemGroup>

<ItemGroup>
<EmbeddedResource Include="Configuration\configPage.html" />
</ItemGroup>

Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

Awesome! This guide is for you. Jellyfin plugins are written using the dotnet standard framework. What that means is you can write them in any language that implements the CLI or the DLI and can compile to netstandard2.1. The examples on this page are in C# because that is what most of Jellyfin is written in, but F#, Visual Basic, and IronPython should all be compatible once compiled.

## 0. Things you need to get started:
## 0. Things you need to get started

- [Dotnet Core SDK 2.2](https://dotnet.microsoft.com/download)

- An editor of your choice. Some free choices are:

[Visual Studio Code](https://code.visualstudio.com/)
Expand All @@ -15,7 +16,7 @@ Awesome! This guide is for you. Jellyfin plugins are written using the dotnet st

## 0.5. Quickstarts

We have a number of quickstart options available to speed you along the way
We have a number of quickstart options available to speed you along the way.

- [Download the Example Plugin Project](https://github.com/jellyfin/jellyfin-plugin-template/tree/master/Jellyfin.Plugin.Template) from this repository, open it in your IDE and go to [step 3](https://github.com/jellyfin/jellyfin-plugin-template#3-customize-plugin-information)

Expand All @@ -33,7 +34,7 @@ We have a number of quickstart options available to speed you along the way

If you'd rather start from scratch keep going on to step 1. This assumes no specific editor or IDE and requires only the command line with dotnet in the path.

## 1. Initialize your project
## 1. Initialize your Project

Make a new dotnet standard project with the following command, it will make a directory for itself:

Expand Down Expand Up @@ -117,7 +118,9 @@ There are loads of other interfaces that can be used, but you'll need to poke ar
If your plugin doesn't fit perfectly neatly into a predefined interface, never fear, there are a set of interfaces that allow your plugin to extend Jellyfin any which way you please. Here's a quick overview on how to use them

- **IPluginConfigurationPage** - Allows you to have a plugin config page on the dashboard. If you used one of the quickstart example projects, a premade page with some useful components to work with has been created for you! If not you can check out this guide here for how to whip one up.

- **IRestfulService** - Allows you to extend the Jellyfin http API and handle API calls that come in on the routes you define.

- **IServerEntryPoint** - Allows you to run code at server startup that will stay in memory. You can make as many of these as you need and it is wildly useful for loading configs or persisting state.

Likewise you might need to get data and services from the Jellyfin core, Jellyfin provides a number of interfaces you can add as parameters to your plugin constructor which are then made available in your project (you can see the 2 mandatory ones that are needed by the plugin system in the constructor as is).
Expand All @@ -138,8 +141,10 @@ Likewise you might need to get data and services from the Jellyfin core, Jellyfi
- **IXmlSerializer** - Allows you to use the main xml serializer
- **IZipClient** - Allows you to use the core zip client for compressing and decompressing data

## 5. Submit your plugin to the Jellyfin repo
## 5. Submit your Plugin

- Choose a License, Jellyfin recommends [GPLv2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.html). If you would like your plugin to be integrated into Jellyfin and available from the plugin browser you MUST choose a [GPL Compatible License](https://www.gnu.org/licenses/license-list.html#GPLCompatibleLicenses)

- Upload your plugin to github.

- Contact the Jellyfin Team!
18 changes: 8 additions & 10 deletions build.yaml
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
---
name: "jellyfin-plugin-template"
name: "Template"
guid: "eb5d7894-8eef-4b36-aa6f-5d124e828ce1"
version: "1.0.0"
jellyfin_version: "10.5.0"
nicename: "Template"
description: "Short description about your plugin"
overview: >
version: "1.0.0.0"
targetAbi: "10.5.0.0"
overview: "Short description about your plugin"
description: >
This is a longer description that can span more than one
line and include details about your plugin.
category: "General"
owner: "jellyfin"
artifacts:
- "Jellyfin.Plugin.Template.dll"
build_type: "dotnet"
dotnet_configuration: "Release"
dotnet_framework: "netstandard2.1"
- "Jellyfin.Plugin.Template.dll"
changelog: >
changelog

0 comments on commit 9e6ec93

Please sign in to comment.