rohm1 / CatalogScanner

Scans Animal Crossing: New Horizon catalog from video of user scrolling through.

Home Page:https://nook.lol

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

CatalogScanner

Script to scan video of user scrolling through their AC:NH Nook Shop catalog or DIY recipes list.

This is the source code for the Twitter bot @CatalogScanner, which is an automated version of this.

Installation

This script requires Python 3 and Tesseract-OCR to work.

You can then install the required libraries using pip and requirements.txt:

cd CatalogScanner
python3 -m venv .env
.env/Scripts/activate
pip install -r requirements.txt

Usage

Before using this script, you need to create a valid video file. There are two types of videos

Nook Shopping Catalog

  1. Open Nook Shopping (ATM or phone app)
  2. Select desired catalog and section
  3. Scroll to the bottom using the right analog stick (page scrolling)
  4. Hold down "Capture" button on left joycon to record the last 30s

DIY Recipes

  1. Open DIY recipes list (phone app)
  2. Select desired section
  3. Scroll to the bottom using the left analog stick (item scrolling)
  4. Hold down "Capture" button on left joycon to record the last 30s

Critters

  1. Navigate to the Critterpedia phone app
  2. Make sure you are in List Mode (not Display Mode)
  3. Move through every section to view all the critters
  4. Hold down "Capture" button on left joycon to record the last 30s

Trimming and exporting video

  1. Go to Switch's Album gallery and select your video
  2. Press A and select "Trim"
  3. Cut the video to the start/end of the scrolling and save
  4. Export the video either through Twitter or with an SDcard

Scanning the video

Once you have your video file, you can pass it as the first argument to the script:

python scanner.py catalog.mp4

By default, it will detect the video type (catalog or recipes), but you can force on with --mode.

You can use --for_sale to filter out items that are not purchasable, and you can use --locale to adjust the parsed language.

By default, the script prints out the name of all the items found in your catalog video.

Credits

The item name data comes from:

About

Scans Animal Crossing: New Horizon catalog from video of user scrolling through.

https://nook.lol

License:MIT License


Languages

Language:Python 100.0%