Giter VIP home page Giter VIP logo

titlecardmaker's Introduction

logo TitleCardMaker

Docker Build GitHub Develop Commits Discord Support

An automated title card maker for Plex.

Table of Contents

Description

TitleCardMaker is a program and Docker container written in Python that automates the creation of customized title cards (which are image previews of an episode of TV) for use in personal media services like Plex, Emby, or Jellyfin.

TitleCardMaker can be automated such that everything can be pulled without manual intervention. All your series can be read from Sonarr or Plex; episode data can be pulled from Sonarr, Plex or TheMovieDatabase; images from TheMovieDatabase or Plex; and TitleCardMaker can even utilize an episode's watch status within Plex to create "spoiler free" versions of title cards automatically, as shown below:

card unblurring process

All configuration/automation of the TitleCardMaker is done via YAML files, and the actual image creation is done using the open-source and free image library called ImageMagick.

Getting Started

Read the Getting Started page on the Wiki for the traditional install, or the Getting Started on Docker page to install using Docker.

If you're using Unraid, there is a template available for easy setup - just search titlecardmaker on the Unraid Community Apps store.

Usage and Troubleshooting

Assuming you're using the default preference filename, invoking the Maker is as simple as:

pipenv run python main.py --run

For invocation and configuration details, read here.

If you have trouble getting the Maker working, or have a problem, create an issue on GitHub!

Examples

Below are some examples of each style of title card that can be created automatically by the TitleCardMaker:

Built-in Card Types

Anime Cutout Frame Landscape Logo Olivier Poster Roman Standard Star Wars

The above cards are, in order, the anime, cutout, frame, landscape, logo, olivier, poster, roman, standard, and the star wars title cards - the textless card is not shown.

User-Created Card Types

The TitleCardMaker can also use user-created and maintained card types hosted on the companion GitHub, an example of each type is shown below:

The above cards are, in order, Yozora/BarebonesTitleCard, Beedman/GradientLogoTitleCard, Yozora/RetroTitleCard, Yozora/SlimTitleCard, Wdvh/StarWarsTitleOnly, Wdvh/WhiteTextAbsolute, lyonza/WhiteTextBroadcast, Wdvh/WhiteTextStandard, Wdvh/WhiteTextTitleOnly, and azuravian/TitleColorMatch

Other Features

In addition to title card creation and management, the TitleCardMaker can also be used for other image-creation functionality. For example, the mini maker - a.k.a. mini_maker.py - can be used to "manually" create collection posters, genre cards, movie posters, show summaries, and season posters. An example of each is shown below:

Example Collection Poster Example Genre Card Example Movie Poster Example Genre Card Example Genre Card

This is largely done via the command-line, and is described on the wiki here.

Contributing

If you'd like to contribute - whether that's a suggested feature, a bug fix, or anything else - please do so on GitHub by creating an issue, or join the Discord. The best way for me to manage technical aspects of the project is on GitHub.

Support

This has taken a pretty substantial amount of effort, so if you find this project useful you can support me on BuyMeACoffee, or become a GitHub sponsor - I would really appreciate it!

titlecardmaker's People

Contributors

collinheist avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.