From c2cefa260924b10c35c78bf4acae4a7f52b28bad Mon Sep 17 00:00:00 2001 From: David Korth Date: Tue, 22 Nov 2022 01:51:01 -0500 Subject: [PATCH] NETWORK.md: Mention metered/unmetered networks. Windows 10 supports indicating metered networks since RTM (2015), but only through Windows Runtime. Windows 10 v2004 added a standard WinAPI method, GetNetworkConnectivityHint(), which is what we'll be targetting. If there's an easy way to implement support for the WinRT version without breaking support for older versions of Windows, I can switch over to that later on. On Linux, NetworkManager's org.freedesktop.NetworkManager D-Bus interface has a Metered property, which indicates if the active connection is metered (or is guessed to be metered). --- NETWORK.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/NETWORK.md b/NETWORK.md index c4060d9cd..8eed8a35d 100644 --- a/NETWORK.md +++ b/NETWORK.md @@ -3,14 +3,30 @@ The ROM Properties Page Shell Extension has functions to access various Internet databases in order to download artwork. -This functionality can be disabled by using the `rp-config` utility, -or by setting the following value in the configuration file: +This functionality can be adjusted by using the `rp-config` utility, which +adjusts the following values in the configuration file: ``` [Downloads] -ExtImageDownload=false +ExtImageDownload=true +ImgBandwidthUnmetered=HighRes +ImgBandwidthMetered=NormalRes ``` +Set ExtImgDownload to false to disable all image downloads. + +The ImgBandwidthUnmetered and ImgBandwidthMetered keys can be set to one +of the following values: +* None: Disable image downloading on this network type. +* NormalRes: Download normal-resolution images. +* HighRes: Download high-resolution images. + +Metered network detection is supported on the following systems: +* Windows 10 v2004 or later +* Linux systems, when using NetworkManager + +On other systems, rom-properties will assume the network is unmetered. + The configuration file is located at: * Linux: `~/.config/rom-properties/rom-properties.conf` * Windows: `%APPDATA%\rom-properties\rom-properties.conf`