tarkov-scanner v3.0.3

Tarkov scanner

Prerequisites

Windows 10

1. npm install --global windows-build-tools
2. npm install --global node-gyp

Windows 7

1. https://www.microsoft.com/en-us/download/details.aspx?id=40773
2. npm install --global windows-build-tools
3. npm install --global node-gyp

Installing and running

1. Create a folder you wanna run in
2. create settings.json in current folder
3. npx tarkov-scanner

settings.json

You need to create a file named settings.json in the same folder as the scanner. At the very least, the file should contain MYSQL_USERNAME and MYSQL_PASSWORD values for inserting price information into the database. If any settings are absent from your settings.json file, the default values will be used (which is probably OK). Below is an example settings.json file with the default values followed by an explanation of each:

{
    "MYSQL_USERNAME": "[db username]",
    "MYSQL_PASSWORD": "[db password]",
    "SCANNER_NAME": "[default is computer hostname]",
    "DISTRUST_TRADER_UNLOCKS": true,
    "EXAMINE": false,
    "AUTOSTART_DELAY": 1000,
    "BATCH_SIZE": 50,
    "MAX_PRICE_IMAGE_SCANS": 10,
    "MAX_SEARCH_START_TIME_MS": 1500,
    "MAX_SEARCH_TIME_MS": 1500,
    "MAX_PRICE_START_TIME_MS": 1500,
    "MAX_PRICE_TIME_MS": 1500,
    "CLICK_DELAY": 17,
    "FRAME_MS": 17,
    "MAX_UNLOCK_TIP_PAUSE": 700,
    "OCR_WORKERS": 2,
    "SEARCH_FILTERS": {
        "offersFrom": "players",
    },
    "TRADER_SCAN_DAY": false,
    "DEBUG": false,
    "SKIP_PRICE_INSERT": false,
    "LIMIT_ITEM": ""
}

SCANNER_NAME: Identifies the prices this canner inserts into the DB. Different from MYSQL_USERNAME because one user can run multiple scanners with different names using the same DB credentials.

DISTRUST_TRADER_UNLOCKS: If the EFT account you are using for scanning has traders leveled up above level 1 and/or has a significant number of quets completed, this should remain set to true. The scanner uses the unavailability of items from traders to determine the level required to buy those items from traders. If your traders are leveled up and you have access to more items, the scanner will think those items are available at trader level 1. This will result in bad data! This setting can be changed to false only if you are using an account that was leveled up to level 10 with no traders leveld up and no extra quests completed.

EXAMINE: Set to true to automatically middle-click item images while searching for items.

AUTOSTART_DELAY: After the scanner is running and detects the flea market screen is present at the required screen resolution (1920x1080), it will wait this amount of time before setting up for scanning and again before beginning scanning.

BATCH_SIZE: When you are scanning, the scanner will "check out" the most stale items from the database to scan first. This setting determines the number of items the scanner checks out at a single time. Once the scanner processes those items, it will pull another batch.

MAX_PRICE_IMAGE_SCANS: The process of searching for items and taking screenshots takes a little less time than scanning those screenshots for prices (especially on slower hardware). Because the price scanning is done asynchronously from the item searching, this can create a backlog of prices to scan. With a big enough of a backlog, this can cause significant slowdowns and even crashes. This setting determines the number of image scanners that can begin before the scanner takes a pause to wait for those images to all be processed before continuing with item searching.

MAX_SEARCH_START_TIME_MS, MAX_SEARCH_TIME_MS, MAX_PRICE_START_TIME_MS, MAX_PRICE_TIME_MS: These settings determine the amount of time (in miliseconds) the scanner will wait for certain interface events before declaring a "timeout" to prevent the scanner from getting stuck. Slower hardware and network connections may require increasing these default values if the scanner output window is mentioning a lot of timeouts.

CLICK_DELAY: The amount of time (in miliseconds) the scanner will wait both before mouse clicks. The default value of 17 is meant to approximate one frame for a scanner running at 60 FPS. If it appears the scanner isn't properly registering mouse clicks, you might want to try to increase this value.

FRAME_MS: Determines the "tick rate" for waiting for certain interface events. The default value of 17 approximates a single frame at 60 FPS. There's no need to check for updates more frequently than the screen is updating, so it may be useful to set this to approximately match your game FPS while viewing the flea market. The basic formula is 1000 / FPS.

MAX_UNLOCK_TIP_PAUSE: When scanning trader prices and there's a locked price, the scanner will hover the mouse over the offer so that a tooltip describing how to unlock that offer becomes visible. This setting is the maximum number of miliseconds to wait for that tip to become visible so the scanner can capture it. Likely necessary to increase this value on slower hardware. However, sometimes price lists show "locked" offers from players. These prices do not display a tip when the cursor is hovered over them, so this setting can introduce some unnecessary delay if the scanner is scanning player and trader prices simultaneously. When scanning only trader prices, setting this to a higher value should not introduce any unnecessary delay.

OCR_WORKERS: The number of workers in each pool to work on OCR tasks. If your computer has a significant number of cores, you could consider increasing this number for faster price scanning.

SEARCH_FILTERS: When the scanner begins, it will set the flea market search filters according to these settings. offersFrom determines whether you filter by offers from anyone, traders, or players. If you include trader prices, be careful that DISTRUST_TRADER_UNLOCKS is set appropriatelely!

TRADER_SCAN_DAY: Can be set from 0-6, corresponding to Sunday-Saturday. If it's this day, the scanner will switch to scanning trader prices until all items have been scanned for trader prices within the last 24 hours. Once the day is over or all items have been scanned for trader prices, the scanner reverts to its previous SEARCH_FILTERS.offersFrom setting.

EFT_RESTART_HOURS: The number of hours EFT can be running before the scanner restarts the game and continues scanning. The default value is 24.

DEBUG: Enables some additional debugging output. Includes saving occasional screenshots, which incurs a performance penalty. Generally recommended to be left off.

SKIP_PRICE_INSERT: The scanner will function normally, but will not insert any found prices into the DB. Useful for testing and debugging.

LIMIT_ITEM: Can be set to the id value of an item, which will result in the scanner retrieving and processing only that one item. useful for testing and debugging.