Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
arabcoders committed Jan 15, 2024
1 parent 32c1860 commit 6d02b7d
Showing 1 changed file with 29 additions and 13 deletions.
42 changes: 29 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,31 +3,47 @@
![Build Status](https://github.com/ArabCoders/emby-custom-metadata-db/actions/workflows/build-validation.yml/badge.svg)
![MIT License](https://img.shields.io/github/license/ArabCoders/emby-custom-metadata-db.svg)

This project is to make a custom database for my custom shows. You can clone and change what's needed to make it work for your use case.
This is a plugin for [Emby Media Server](https://emby.media) that purely here to generate unique custom IDs for TV series. to work with
my other two plugins for [Jellyfin](https://github.com/arabcoders/jf-custom-metadata-db) and [Plex](https://github.com/arabcoders/cmdb.bundle).

# Server code
It doesn't matter what server language you use, you need few rules to follow The plugin will request data from the API using GET with the following query string `?type={type}&query={folderName}`.
**This plugin require server that respond with a unique ID for a given TV series name in the following format.**

The API Must response with `http status code 404` for no-match. and `http status code 200` for match. The body of the `200 Response` *MUST* be in JSON format with the following structure:

```json
```json5
[
{
"id": "show_id",
"title": "title",
},...
"id": "jp-bded21fb4b",
"title": "Show Real title",
"match": [
"Matchers"
]
},
...
]
```
There are more fields but which can be found in the `DTO` object. However, they are not supported at the moment.

## Build and Installing from source
## Server implementation

For a quick server implementation please refer to [this page](https://github.com/arabcoders/cmdb.bundle?tab=readme-ov-file#server-implementation).

# Installation

Go to the Releases page and download the latest release.

Copy the `CustomMetadataDB.dll` file to the Emby plugins directory. You can find your directory by going to Dashboard, and noticing the Paths section. Mine is the root folder of the default Metadata directory.

## Building from source
1. Clone or download this repository.
2. Ensure you have .NET Core SDK setup and installed.
3. Build plugin with following command.
```
dotnet publish --configuration CustomMetadataDB --output bin
```
4. Copy `CustomMetadataDB.dll` from the `bin` directory to emby plugins directory.
5. Restart emby
6. If performed correctly you will see a plugin named CMetadataDB in `Dashboard -> Plugins`.
5. Restart emby.
If performed correctly you will see a plugin named CMetadataDB in `Dashboard -> Plugins`.
## Change the API URL
go to `Dashboard -> Plugins -> Custom Metadata DB -> URL for the custom database:` and change the URL to your server URL, then click on `Save`.

0 comments on commit 6d02b7d

Please sign in to comment.