MultiPoolMiner

MultiPoolMiner®

created by aaronsace, uselessguru and grantemsley

WEBSITE: MultiPoolMiner.io

GITHUB: https://github.com/MultiPoolMiner/

REDDIT: /r/multipoolminer/

TWITTER: @multipoolminer

Licensed under the GNU General Public License v3.0 - Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. https://github.com/MultiPoolMiner/MultiPoolMiner/blob/master/LICENSE

README.md is based on README.txt - updated on 10/11/2019 (dd/mm/yyyy) - latest version can be found here: https://github.com/MultiPoolMiner/MultiPoolMiner/blob/master/README.txt

FEATURE SUMMARY

• Monitors crypto mining pools and coins in real-time and finds the most profitable for your machine
• Controls any miner that is available via command line
• Supports benchmarking, multiple platforms (AMD, NVIDIA and CPU) and mining on A Hash Pool, BlazePool, BlockMasters, Hash Refinery, MiningPoolHub, Nicehash, YiiMP, ZergPool and Zpool pools
• Includes Watchdog Timer to detect and handle miner failures
• Comprehensive web GUI with dashboard and balances overview
• Power usage is part of the profibility calculation (optional)
• API port is configurable, default is 3999
• Invalid share detection; miner gets marked failed if the configured ration of accepted / bad shares is exceeded

Any bitcoin donations are greatly appreciated: 1MsrCoAt8qM53HUMsUxvy9gMj3QVbHLazH

INSTALLATION

1. Download the latest RELEASE (.zip package) from https://github.com/MultiPoolMiner/MultiPoolMiner/releases
2. Extract it to your Desktop (MultiPoolMiner will NOT work from folders such as "C:\Program Files")
3. Make sure you have all pre-requisites installed/updated from the IMPORTANT NOTES section below.
4. Right-click on the (required) Start.bat file and open it with a Notepad application. Multiple start.bat files are included as examples.
5. Edit the Start.bat file with your details (such as YOUR username, wallet address, region, worker name, device type). New users should NOT edit anything else. Please see COMMAND LINE OPTIONS below for specification and further details.
6. Save and close the Start.bat file you just edited.
7. Launch the Start.bat file you just edited.
8. Let the benchmarking finish (you will be earning shares even during benchmarking).
9. Optional: Download, install and configure HWiNFO64, this is required if you want to make power usage a part of the profit calculation. See ConfigHWinfo64.pdf for details.

Done. You are all set to mine the most profitable coins and maximise your profits using MultiPoolMiner.

IMPORTANT NOTES

• It is not recommended but to upgrade from a previous version of MultiPoolMiner, you may simply copy the 'Stats' folder.
• Having PowerShell 6.2 installed is now a requirement. Windows 64bit, All other versions
• Microsoft .NET Framework 4.5.1 or later is required for MultiPoolMiner to function properly. Web Installer
• CCMiner (NVIDIA cards only) may need 'MSVCR120.dll' if you don't already have it: https://www.microsoft.com/en-gb/download/details.aspx?id=40784. Make sure that you install both the x86 and the x64 versions.
• CCMiner (NVIDIA cards only) may need 'VCRUNTIME140.DLL' if you don't already have it: https://www.microsoft.com/en-us/download/details.aspx?id=48145. Make sure that you install both the x86 and the x64 versions.
• It is highly recommended to set Virtual Memory size in Windows to at least 16 GB in multi-GPU systems: Computer Properties -> Advanced System Settings -> Performance -> Advanced -> Virtual Memory
• Please see the FAQ section on the bottom of this page before submitting bugs and feature requests on Github. https://github.com/MultiPoolMiner/MultiPoolMiner/issues
• Logs and Stats are produced in text format; use them when submitting issues.
• Currently mining with up to 6 GPUs is fully supported. Where required advanced users can create additional or amend current miner files to support mining with more than 6 graphics cards.

COMMAND LINE OPTIONS

(case-insensitive - except for wallet addresses (e.g. BTC), see Sample Usage section below for an example)

Listed in alphabetical order. Note: For basic operation not all parameters must be defined through start.bat.

-AllowedBadShareRatio Allowed ratio of bad shares (total / bad) as reported by the miner. If the ratio exceeds the configured threshold then the miner will marked as failed. Allowed values: 0.00 - 1.00. Default of 0 disables this check

-API_Key Required only if you are mining at MiningPoolHub. Adding this parameter / key pair allows MPM to gather the balances at the pool. The API_Key can be found in the MiningPoolHub Account detail page.

-APIPort Port for the MPM API and web GUI. The miner port range will start from APIPort +1. Default is 3999. 0 disables the API.

-Algorithm Supported algorithms sorted by pool can be found at https://multipoolminer.io/algorithms. Use commas to separate multiple values.

The following algorithms are currently supported:

Bitcore, Blakecoin, Blake2s, BlakeVanilla, C11, CryptoNightV7, CryptoNightHeavy, Ethash, X11, Decred, Equihash, Groestl, HMQ1725, HSR, JHA, Keccak, Lbry, Lyra2RE2, Lyra2z, MyriadGroestl, NeoScrypt, Pascal, Phi, Phi2, Phi1612, Polytimos, Quark, Qubit, Scrypt, SHA256, Sib, Skunk, Skein, Timetravel, Tribus, Veltor, X11, X12, X11evo, X16R, X16S, X17, Yescrypt

*Note that the list of supported algorithms can change depending on the capabilities of the supported miner binaries. Some algos are now being mined with ASICs and are no longer profitable when mined with CPU/GPU and will get removed from MPM.

Special parameters:

• Ethash2gb - can be profitable for older GPUs that have 2GB or less GDDR memory. It includes ethash coins that have a DAG file size of less than 2GB (and will be mined when most profitable). Ethereum and a few other coins have surpassed this size therefore cannot be mined with older cards.
• ethash3gb - can be profitable for older GPUs that have 3GB or less GDDR memory. It includes ethash coins that have a DAG file size of less than 3GB (and will be mined when most profitable). Ethereum and a few other coins have surpassed this size therefore cannot be mined with older cards.
• decrednicehash - if you want to include non-dual, non-Claymore Decred mining on Nicehash. NiceHash created their own implementation of Decred mining protocol.

Note that the pool selected also needs to support the required algorithm(s) or your specified pool (-PoolName) will be ignored when mining certain algorithms. The -Algorithm command is higher in execution hierarchy and can override pool selection. This feature comes handy when you mine on Zpool but also want to mine ethash coins (which is not supported by Zpool). WARNING! If you add all algorithms listed above, you may find your earnings spread across multiple pools regardless what pool(s) you specified with the -PoolName command.

-BasePowerUsage Additional base power usage (in Watt) for running the computer, monitor etc. regardless of mining hardware. Allowed values: 0.0 - 999, default is 0

-BenchmarkInterval MultiPoolMiner's update interval in seconds during benchmarks / power metering. This is a universal timer for running the entire script (downloading/processing APIs, calculation etc). It determines how long a benchmark is run for each miner file (miner/algorithm/coin). Default is 60. Note: This value correlates with -MinHashRateSamples. If you set -MinHashRateSamples too high, then MPM cannot get enough samples for reliable measurement (recommendation: 10 or more). In this case increase the benchmark interval length.

-CoinName [Zcash, ZeroCoin etc.] Limit mining to the listed coins only; this is also a per-pool setting (see Advanced Configuration). Use commas to separate multiple values. Note: Only the pools ending in ...-Coin expose all coin names in their API. Check the web dashboard / pools to see which pools expose which values.

-ConfigFile [Path\ConfigFile.txt] The default config file name is '.\Config.txt' If the config file does not exist MPM will create a config file with default values. If the file name does not have an extension MPM will add .txt file name extension. By default MPM will use the values from the command line. If you hardcode config values directly in the config file, then these values will override the command line parameters (see Advanced Configuration).

-Currency [BTC, USD, EUR, GBP, ETH ...] Choose the default currency or currencies your profit stats will be shown in. Use commas to separate multiple values. Important: MultiPoolMiner will use the first currency in the list as main currency. All profit / earning numbers will be displayed in the main (=first in the list) currency. Note: Instead af BTC you can also use mBTC (= BTC / 1000).

-CurrencySymbol [BTC, LTC, ZEC etc.] Limit mining to the listed currency only; this is also a per-pool setting (see Advanced Configuration). Use commas to separate multiple values. Note: Only the pools ending in ...-Coin expose all currency symbols in their API. Check the web dashboard / pools to see which pools expose which values.

-Dashboard Launch web dashboard after MPM start.

-Delay Specify the number of seconds required to pass before opening each miner. It is useful when cards are more sensitive to switching and need some extra time to recover (eg. clear DAG files from memory)

-DeviceName Choose the relevant GPU(s) and/or CPU mining. [CPU, GPU, GPU#02, AMD, NVIDIA, AMD#02, OpenCL#03#02 etc.]. Use commas to separate multiple values.

-DisableDevFeeMining Disable miner developer fees (Note: not all miners support turning off their built in fees, others will reduce the hashrate). This is also a per-miner setting (see Advanced Configuration).

-DisableDeviceDetection All miner by default create separate instances for each card model. To disable add -DisableDeviceDetection to your start batch file. This decreases profit. Note: Changing this parameter this will trigger some benchmarking.

-DisableEstimateCorrection Some pools overestimate the projected profits. By default MPM will reduce the projected algo price by a correction factor (actual_last24h / estimate_last24h) to counter pool the overestimated prices. Note: Not all pools include the information required for this to work in their API (currently know are MiningPoolHub & Nicehash). For these pools this setting is ignored. This is also a per-miner setting (see Advanced Configuration).

-DisableMinersWithDevFee Use only miners that do not have a dev fee built in.

-Donate Donation of mining time in minutes per day to aaronsace. Default is 24, minimum is 10 minutes per day (less than 0.7% fee). If Interval is set higher than the donation time, the interval will prime. The downloaded miner software can have their own donation system built in. Check the readme file of the respective miner used for more details.

-ExcludeAlgorithm Similar to the -Algorithm command but it is used to exclude unwanted algorithms. Supported algorithms sorted by pool can be found at https://multipoolminer.io/algorithms. Use commas to separate multiple values. This is also a per-pool setting (see Advanced Configuration).

**-ExcludeCoin