SpykerNZ / one-pace-for-plex

This project helps adapt One Pace to a format plex can read.
84 stars 9 forks source link

One Pace for Plex

This guide explains how to set up One Pace for Plex

Features:

Final Result

Specific One Pace show available in your Plex library.

One Pace Series View

Show split into the different One Pace seasons.

One Pace Seasons View

Requirements

Install Instructions

1. Copy Folder Structure

Download this repo as a zip file then copy the "One Pace" folder to your Anime or TV folder as used in Plex.

    └───media
        ├───anime
        │   ├───One Pace
        ├───movies
        └───tvshows

2. Download One Pace Episodes

Download all the One Pace episodes you wish to add and place them in their respective season folders.

    └───media
        ├───anime
        │   ├───One Pace    
        │   │   ├───Season 01
        │   │   │   ├───[One Pace][1] Romance Dawn 01 [1080p][FB72C13F].mkv     
        │   │   │   └───One Pace - S01E01 - Romance Dawn, the Dawn of an Adventure.nfo           
        │   │   └───Season 02
        │   │       ├───[One Pace][8-11] Orange Town 01 [1080p][2388DB63].mkv    
        │   │       └───One Pace - S02E01 - Enter Nami.nfo      
        ├───movies
        └───tvshows

3. Download Missing One Piece Episodes

One Pace does not currently cover the entire series. Thus, you will need to add missing episodes to fill out your collection.

Current missing episodes:

See the One Pace Episode Spreadsheet for up-to-date information on what episodes are available. Check column Q to see which original One Piece episodes need to be added to your library.

Place the missing episodes in their respective season folders.

    └───media
        ├───anime
        │   ├───One Pace    
        │   │   └───Season 07
        │   │       ├───One Piece - 46 - Chase Straw Hat! Little Buggy's Big Adventure!.mkv     
        │   │       ├───One Pace - S07E46 - Chase Straw Hat! Little Buggy's Big Adventure!.nfo           
        │   │       ├───One Piece - 47 - The Wait is Over! The Return of Captain Buggy!.mkv    
        │   │       └───One Pace - S07E47 - The Wait is Over! The Return of Captain Buggy!.nfo      
        ├───movies
        └───tvshows

4. File Renaming

Option A - Windows Executable

This approach uses an executable to rename all your files.

  1. Copy rename.exe, seasons.json and exceptions.json to your One Pace directory. (from /dist/ folder)
    └───media
        └───anime
            └───One Pace
                ├───Season 01
                └───Season 02
                └───rename.exe
                └───seasons.json
                └───exceptions.json
  1. Open executable to run.

  2. Your files will be renamed automagically!

  3. Check output to see what files were renamed.

Option B - Python

This approach uses python to rename all your files, which is a bit more complex but allows for more flexibility.

  1. Copy the rename.py, seasons.json and exceptions.json file to your One Pace directory. (from /dist/ folder)
    └───media
        └───anime
            └───One Pace
                ├───Season 01
                └───Season 02
                └───rename.py
                └───seasons.json
                └───exceptions.json
  1. Open a shell/powershell terminal.

  2. Change directory to where your One Pace script folder is: cd /media/anime/One Pace/

  3. Run the script in dry-run mode to see what change would occur (you can try with Docker or Python): a) Python: python3 rename.py --dry-run or python rename.py --dry-run b) Docker: docker run --rm -v "$PWD":/data -w="/data" python:3 python rename.py --dry-run

  4. Once you are okay with the changes you see, remove the --dry-run flag from the command and run it again. Your files will be renamed to the corresponding One Piece episode, i.e.: "[One Pace][1] Romance Dawn 01 [1080p][FB72C13F].mkv" -> "One Pace - S01E01 - Romance Dawn, the Dawn of an Adventure.mkv"

[^1]: Inside 'exceptions.json' you can map any file name to a specific episode number. It looks in your specified season directory to see if any of the .mkv files have matching text in their filenames, then renames it as the corresponding episode number if found. If you have some strange episode naming, you may need to modify this json and add your episode filenames.

5. Install XBMCnfoTVImporter

You need to install XBMCnfoTVImporter for plex in order to scan in One Pace. Follow the instructions and install.

6. Scan In Plex

You need to swap to the XBMCnfoTVImporter agent in Plex to scan your new One Pace folder.

  1. Open Plex
  2. Navigate to your anime library
  3. Click 'Manage Library' -> 'Edit...'
  4. Click on the 'Advanced' tab
  5. Click the 'Agent' dropdown box. (and note what you have set to currently so that you can change it back)
  6. Select the 'XBMCnfoTVImporter' option. (If this does not exist XBMCnfoTVImporter may not be installed correctly)
  7. Click "Save Changes"
  8. Click "Scan Library Files"
  9. One Pace should get scanned into your library
  10. Once it is complete, change your agent back to what you had originally!

Notes:

Acknowledgements