TubeArchivist-JF 插件使用教程

TubeArchivist-JF 插件使用教程

tubearchivist-jfTube Archivist Jellyfin Integration项目地址:https://gitcode.com/gh_mirrors/tu/tubearchivist-jf

1. 项目的目录结构及介绍

TubeArchivist-JF 插件的目录结构如下：

tubearchivist-jf-plugin/
├── images/
├── Directory.Build.props
├── LICENSE
├── README.md
├── TubeArchivistMetadata.sln
├── build.yaml
├── jellyfin.ruleset
├── manifest.json
├── TubeArchivistMetadata/
│   ├── Properties/
│   ├── Controllers/
│   ├── Models/
│   ├── Views/
│   ├── TubeArchivistMetadata.csproj
│   ├── Plugin.cs
│   └── ...
└── ...

目录介绍：

• images/: 存放项目相关的图片资源。
• Directory.Build.props: 构建属性文件。
• LICENSE: 项目的许可证文件，采用 GPL-3.0 许可证。
• README.md: 项目说明文档。
• TubeArchivistMetadata.sln: 项目的解决方案文件。
• build.yaml: 构建配置文件。
• jellyfin.ruleset: 代码规则集文件。
• manifest.json: 插件的清单文件。
• TubeArchivistMetadata/: 插件的主要代码目录，包含控制器、模型、视图等。

2. 项目的启动文件介绍

项目的启动文件是 TubeArchivistMetadata/Plugin.cs，该文件是插件的入口点，负责初始化和配置插件。

// Plugin.cs
using Jellyfin.Plugin.TubeArchivist.Configuration;
using MediaBrowser.Common.Configuration;
using MediaBrowser.Common.Plugins;
using MediaBrowser.Model.Plugins;
using MediaBrowser.Model.Serialization;

namespace Jellyfin.Plugin.TubeArchivist
{
    public class Plugin : BasePlugin<PluginConfiguration>, IPlugin
    {
        public Plugin(IApplicationPaths applicationPaths, IXmlSerializer xmlSerializer)
            : base(applicationPaths, xmlSerializer)
        {
            Instance = this;
        }

        public override string Name => "TubeArchivistMetadata";

        public override Guid Id => Guid.Parse("your-guid-here");

        public static Plugin Instance { get; private set; }
    }
}

3. 项目的配置文件介绍

项目的配置文件是 TubeArchivistMetadata/Configuration/PluginConfiguration.cs，该文件定义了插件的配置选项。

// PluginConfiguration.cs
namespace Jellyfin.Plugin.TubeArchivist.Configuration
{
    public class PluginConfiguration : BasePluginConfiguration
    {
        public string CollectionDisplayName { get; set; }
        public string TubeArchivistInstanceAddress { get; set; }
        public string TubeArchivistApiKey { get; set; }
        public int OverviewsLength { get; set; }
    }
}

配置选项介绍：

• CollectionDisplayName: 媒体库的显示名称。
• TubeArchivistInstanceAddress: TubeArchivist 实例的地址。
• TubeArchivistApiKey: TubeArchivist API 密钥。
• OverviewsLength: 频道和视频描述的长度。

以上是 TubeArchivist-JF 插件的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

tubearchivist-jfTube Archivist Jellyfin Integration项目地址:https://gitcode.com/gh_mirrors/tu/tubearchivist-jf