Skip to content

Latest commit

 

History

History
90 lines (50 loc) · 2 KB

README.md

File metadata and controls

90 lines (50 loc) · 2 KB
Raw

Movies-Hunter Bot

A web bot used by Movies-Hunter (mine) to extract data on the Internet for your movies:

  1. It scans directories recursively in order to find potential movies.
  2. Then, it uses the power of Google Search to find an AlloCiné code.
  3. Finally, it extracts data from AlloCiné api, downloads poster + trailer and generates a thumbnail.
  4. Next time, it will be able to use its own database to save time.

Data is saved in data/db.json. Posters, thumbnails and trailers are available in data.

Requirements

Getting started

Go to the project's directory and build it:

npm install

To run the bot:

npm start

You can also create a cron job to launch it periodically.

Configuration

In the project's root, you can see config.yml which allows you to make your own configuration:

Directories

directories:
    - /Users/matthieu/Movies
    - /Users/matthieu/Documents/Films

In this part, directories contains paths that bot will explore to find potential movies. You can add as many as paths you want while they are absolute and unique.

Make sure you don't add the same path twice or children of an existing directory! Duplicates would be added in database...

Extensions

extensions:
    - mkv
    - avi
    - iso

Here, you can define filename extensions (lowercase) which will be analyzed by the bot. Files only are supported!

Tags usage

If you want to add tags on your files, use {{tag}} notation anywhere in a filename.

For example, Le Triomphe de Babar 1990 {{cartoon}} {{elephant}}.mkv will save ['cartoon', 'elephant'] in database.

Special tags are used by the bot to do particular stuff:

  • {{local}}: to save a movie without fetching data.
  • {{ignore}}: to ignore a file.
  • {{reset}}: to reset a specific movie.

Reset

If you've got an issue and need to reset everything:

npm run reset