# [PlexAniSync](https://github.com/RickDB/PlexAniSync/) Mapping Assistant TheMovieDB/TheTVDB Mapping Assistant for [PlexAniSync](https://github.com/RickDB/PlexAniSync/), specifically, for contribution to the [custom mappings](https://github.com/RickDB/PlexAniSync-Custom-Mappings) project. Assistant - Metadata selection

### Repositories [![RickDB/PlexAniSync - GitHub](https://github-readme-stats.vercel.app/api/pin/?username=RickDB&repo=PlexAniSync&bg_color=161B22&text_color=c9d1d9&title_color=0877d2&icon_color=0877d2&border_radius=8&hide_border=true)](https://github.com/RickDB/PlexAniSync/) [![RickDB/PlexAniSync-Custom-Mappings - GitHub](https://github-readme-stats.vercel.app/api/pin/?username=RickDB&repo=PlexAniSync-Custom-Mappings&bg_color=161B22&text_color=c9d1d9&title_color=0877d2&icon_color=0877d2&border_radius=8&hide_border=true)](https://github.com/RickDB/PlexAniSync-Custom-Mappings/) ## Guide

### Step 1: Prerequisites Make sure you have `Node.js` and `npm` installed on your machine. If not, you can download and install them from [Node.js official website](https://nodejs.org/). ### Step 2: Clone the Repository Clone the repository to your local machine using the following command: ```bash git clone https://github.com/Soitora/PlexAniSync-Mapping-Assistant.git ``` ### Step 3: Navigate to Project Directory Change into the project directory: ```bash cd PlexAniSync-Mapping-Assistant ``` ### Step 4: Install Dependencies Run the following command to install project dependencies: ```bash npm install ``` ### Step 5: Create .env file Copy the provided `.env.example` file to a new file named `.env`: ```bash cp .env.example .env ``` ### Step 6: Edit .env File Open the `.env` file in a text editor and fill in the environment variables with appropriate values.

### Step 7: Configuration You can copy `config/default.yaml.example` as `config/default.yaml` to use custom settings. Read [here](https://github.com/node-config/node-config/wiki/Configuration-Files) for more regarding configuration files. #### Settings: - `preferMetadata` - Possible values: `tmdb`, `tvdb` - `preferMedia` - Possible values: `tv`, `movie` - `copyResults` - Possible values: `true`, `false` - `saveResults` - Possible values: `true`, `false` - `inputFilePath` - A valid path to a TXT input file, see the README example. - `outputFilePath` - A valid path for the output YAML files, see the README example. #### Default config: ```yaml userConfig: preferMetadata: "tmdb" preferMedia: "tv" copyResults: "true" saveResults: "false" inputFilePath: "batch/input.txt" outputFilePath: "batch/output/" ``` #### Examples: ##### Changing metadata agent This is useful if you for example only want to use TVDB, and maybe always save results to a file as well, then you can change ```yaml userConfig: preferMetadata: "tvdb" saveResults: "true" ``` ##### Changing output paths This is useful if you for example you want the processed files to be output to a folder on your Desktop ```yaml userConfig: inputFilePath: "C:/Users/USER/Desktop/Scraper/input.txt" outputFilePath: "C:/Users/USER/Desktop/Scraper/" ``` ### Step 8: Run the Assistant You can now run the mapping assistant using the following command: ```bash npm run assistant ``` ### Auto-scraping (Optional) If you would prefer to input a large number of IDs, and have the program output a file for you, you can do it using this script. Make sure that you fill `batch\input.txt` with a newline-seperated list of IDs. ```bash npm run auto ``` ### Debugging (Optional) If you need to debug and test towards API directly, you can use the following command: ```bash npm run debug ``` ### Testing (Optional) To run tests to make sure the API is spitting out the correct information, use the following command: ```bash npm test ```

## Scripts

- `assistant`: Runs the assistant script - `debug`: Runs the debug script to see raw outputs of APIs

## Issues If you have any issues, please open a new issue in the [Issues](https://github.com/Soitora/PlexAniSync-Mapping-Assistant/issues) section of this repository. ### Credits Thank you to all the people who have contributed!

PlexAniSync Mapping Assistant contributors

## License

Copyright © 2023 Soitora

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.