If you plan to mine through Nicehash, you need to register an account with them (https://www.nicehash.com/register). NiceHash will provide you with an extra NiceHash wallet/bitcoin address (RainbowMiner will ask for this address during the setup or configuration process). Payout via Bitcoin-Lightning channel is possible. If you want to see balance details, first create a new API key (My Settings->API-Key) with "Wallet permission->View.." and "Mining permission->View.." enabled. Second add API key, API secret and Organizazion ID to pools.config.txt

The miner can be setup to mine any coin or currency, that is listed at the respective pool. The pool will then payout to the given non-BTC wallet address. Take into account, that non-BTC payouts depend heavily on that coin being mined. If the pool has not or is not mining that currency, the payouts will be delayed until the pool has mined the blocks. Read the pools websites, about the mineability and reliability of a currency. It's recommended to use BTC as any other coin could be removed at anytime and payouts will not occur. The pools Minerpool, MinerRocks, PocketWhale, Ravenminer and Yiimp do not have auto-exchange to BTC. Please be careful, what you choose to mine.

All ZergPool modules make use of the "Anycast" type stratum addresses ".mine.zergpool.com". If you want to let you miner use one of the specific stratum regions "na","eu" and "asia", set the "Region" parameter of the respective ZergPool module in pools.config.txt to the desired region code.

MINERS

• The RainbowMiner contains a list of well approved miners in the directory "Miners"
• The miner Excavator mines on NiceHash pool, only
• Miners Excavator & Excavator1.4.4 run in their own miner window, even if you select to hide miner windows.
• Each miner's algorithm can be fine tuned for each device in your mining rig

Special finetuning

The following miners can be fine tuned, using config files. Most of the config files are being generated upon the first start of the miner. All config files will be written once, only, and kept through miner updates. To let RainbowMiner recreate those files, they will have to be deleted.

ALGORITHMS

RainbowMiner uses a built-in hash table to convert different algorithm names to unique and beautified, internal representations. Because of this, you do not have to care too much about how to write an algorithm, when directly editing the Config\config.txt or using command line parameters. E.g. cryptonight-v7, cryptonight/1, cryptonightv7 would all be converted to CryptonightV7.

Special notes for Equihash

The different Equihash algorithms are distinguished using the following Parameters: (n, k). For example, the classic Equihash first used by Zcash used n = 200 and k = 9, so it became Equihash (200, 9). For BEAM and ZEL a new variant EquihashR has been introduced. These add an extra parameter (r).

The n, k and r values create enormous differences in the minimum memory requirement, and create enormous differences in how the actual mining software is coded in order to do the mining.

RainbowMiner uses the following naming convention:

• Equihash16x5 = Equihash (96, 5)
• Equihash20x9 = Equihash (200, 9)
• Equihash21x9 = Equihash (210, 9)
• Equihash24x5 = Equihash (144,5), e.g. BTG
• Equihash24x7 = Equihash (192,7), e.g. ZEROcoin
• EquihashR25x4 = Equihash (125,4), e.g. ZelHash
• EquihashR25x5 = Equihash (150,5), e.g. GRIMM
• EquihashR25x5x3 = Equihash (150,5,3), e.g. BEAM

The new numbers (16x5, 20x9, ..) describe the number of bits matched in each round for the algorithm, and provide a relative measure of the "hardness" of the algorithm (the numbers can be calculated, using n and k: n/(k+1) ) For EquihashR the parameter (r) will be added to the algorithm name. For r=0, nothing will be added.

RainbowMiner's built-in hash table makes it possible for you, to use many different algorithmnames. E.g. equihash-144_5, equihash1445, equihash-btg, equihash144btg will all be represented by Equihash24x5. BeamHash will be represented by EquihashR25x5x3

OVERCLOCKING OVERVIEW

There are two ways to adjust overclocking values in RainbowMiner:

• Option1: MSI Afterburner profiles
  • recommended for mining rigs with max. 6 identical GPUs
  • to enable, set "MSIAprofile" to the number of your default AB profile ([C]onfiguration->[C]ommon)
  • MSI Afterburner profiles are addressed by number 1-5
• Option2: custom overclocking profiles
  • recommended for mining rigs with more than 6 or mixed GPUs
  • to enable, set "EnableOCProfiles" to "1" ([C]onfiguration->[C]ommon)
  • custom profiles have freely defined names (it differs from option 1!)
  • important: set a default profile for each GPU group ([C]onfiguration->[D]evices). Use the name of the profiles (look into ocprofiles.config.txt, if in doubt)
  • independent of MSI Afterburner

If you do not want to use the overclocking features in RainbowMiner: set both, "EnableOCProfiles" and "MSIAprofile", to "0" ([C]onfiguration->[C]ommon)

Frequently asked questions

Just wondering what would happen if in miners.config I set the ocprofile to a clock and then set it different within AF under the same profile number. Would one trump the other? If so which one would override?

Only one of the two OC options can be enabled at a time:

The differences:

I set the ocprofile to a clock and then set it different within AF under the same profile number

• MSI Afterburner profiles are fixed to a maximum of five and is being selected by their number 1 to 5 in parameter "MSIprofile" in miners.config.txt"
• ocprofiles are unlimited in amount, you decide what their names are. RainbowMiner comes with an example ocprofiles.config.txt, where the profiles are named "Profile1", "Profile", .. "Profile9". The profile is being selected by the full name in parameter "OCprofile" in miners.config.txt (for example "Profile2")

My overclocking settings do not work on Linux

• check config.txt, if "EnableOCProfiles" is set to 1

• are you running a headless system (without monitor), then set "EnableLinuxHeadless" to "1"

• open a linux shell and start ocdaemon status - it should report Running. If not, run ./install.sh again.

• open a linux shell and cd to IncludesLinux/bash within your RainbowMiner folder - start ./getxauth.sh and see, if the XAUTHORITY path matches your system's. If not, enter your system's path into parameter "LinuxXAuthority" in config.txt.

  "EnableOCProfiles": "1", "EnableLinuxHeadless": "1",

OC OPTION1: MSI AFTERBURNER PROFILES

Overclocking option, recommended for unique GPU mining rigs with maximum 6 GPU

Introduction

MSI Afterburner allows to configure up to five profiles. Each of which defines the exact overclocking parameters for any number of GPU. RainbowMiner will never change these values, but it can be defined for miners/algorithms/devices, that another profile than the default should be used during mining (miners.config.txt, fields "MSIAprofile"). RainbowMiner comes with some miner/algorithm presets, already.

Enable Profile Switching

By default, the profile switching is disabled. To enable MSI Afterburner profile switching:

• check or set the path to MSIA (config.txt, field "MSIApath")
• set the profile number, you want to be used as default (config.txt, field "MSIAprofile")

Explanation of operation

RainbowMiner's default setup has already preset some Profile fields for the following algorithms (miners.config.txt, fields "MSIAprofile"):

• ClaymoreEthash-Keccak, NeoScrypt => Profile 3
• Lyra2Re2, Lyra2z, X16r, X16s => Profile 4
• ClaymoreEthash-Blake2s, ClaymoreEthash-Pascal => Profile 5

Remember: no overclocking values will be changed by RainbowMiner! It will switch your preset profiles, only.

I recommend you set the following profile setup in MSI Afterburner, so that you can use the default setup of RainbowMiner. The overclocking values in brackets (core clock/memory clock) are those I use for my GTX 1070 and are only for illustration.

• Profile 1: no oc (e.g. +0/+0)
• Profile 2: max. core / max. memory oc (e.g. +100/+400), good for most miners
• Profile 3: max. core / half memory oc (e.g. +100/+200), recm. for claymore ethash-keccak, neoscrypt
• Profile 4: max. core / low memory oc (e.g. +100/-500), recm. for lyra2re2, lyra2z, x16r, x16s
• Profile 5: max. core / reduced memory oc (e.g. +100/+350), recm. for claymore ethash-blake2s, claymore ethash-pascal

Be careful when playing with OC, since this can damage your devices. RainbowMiner will not be responsible, if you kill your devices.

OC OPTION2: CUSTOM OVERCLOCKING PROFILES

Recommended for mining rigs with more than 6 GPU or different GPU

Introduction

Each miner/device/algorithm combination can have it's own overclocking values set by RainbowMiner. To enable: set "EnableOCProfiles" to "1" in your config.txt or use the [C]onfiguration->[C]ommon.

!! It is important, that you coose a default profile for each GPU device in your devices.config.txt !!

You can edit the file directly: put the name of your custom default profile into field "DefaultOCprofile" Alternatively, the devices can be changed using [C]onfiguration->[D]evices

1. setup overclocking profiles

Use [C]onfiguration->[O]C-Profiles to edit, create and delete overclocking profiles. Values for PowerLimit (%), ThermalLimit (°C), MemoryClockBoost (MHz), CoreClockBoost (MHz), LockMemoryClock (MHz), LockCoreClock (MHz) and LockVoltagePoint (µV) (see hint below) can be defined. You may name the profiles like you want. Hint: Use the complete profile's names, when editing the config files directly. Of course you may also edit the ocprofiles.config.txt file directly.

Hint: LockVoltagePoint can only be set, if EnableOCvoltage is set to 1 in your config.txt (or use [C]onfiguration->[C]ommon to change)

2. set one default profile for each GPU group

With the help of [C]onfiguration->[D]evices it is very easy to choose a default profile for each GPU group used. The values can be edited directly in file devices.config.txt, too. Put the names of the default profiles into the property "DefaultOCprofile".

3. assign profiles to miner-device-algorithms

The assignment is done, using either [C]onfiguration->[M]iners or directly edited into the miners.config.txt file. Find your miner, the device it will use, plus the algorithm and put the profile's name into the field "OCprofile"

COPY CURRENT CONFIGURATION TO NEW RIGS

RainbowMiner comes with an easy setup configuration.

1. get a setup.json

Open http://localhost:4000 on your current rig and click "Get setup.json" (or directly enter http://localhost:4000/setup.json into your internet browser) and you will get a setup.json file, containing your current rig's configuration files.

2. install RainbowMiner

Extract a current RainbowMiner zip onto your new mining rig and copy the setup.json into the RainbowMiner folder. Run install.bat/install.sh to get missing system libraries, then run Start.bat/start.sh.

Now RainbowMiner will ask, if it should import the data from the setup.json. That's it!

Hint: the setup.json contains an autostart section.

Change this to control the setup behavior.

"Autostart": {
  "Enable": "0",
  "ConfigName": "All",
  "DeviceName": "GPU",
  "WorkerName": ""
},

Settings of the "Autostart" section explained:

• "Enable" setting this to "1" will force RainbowMiner to skip the import questionnaire during start. It will import all data and begin mining at once.
• "ConfigName" define which of the config file's should be imported. A well approved combination would be "Config,Coins,Pools". "All" will import all possible modules.
• "DeviceName" define which devices RainbowMiner should use. Possible values are CPU, GPU, NVIDIA, AMD (and even GPU#00, GPU#01, ..). Leave empty to start without devices.
• "WorkerName" define the workername of the new rig. If left empty, the rig's machinename will be used as workername, automatically.

ADVANCED CONFIGURATION

RainbowMiner has a configuration function built-in: to change any parameter of the script, press key "C", while the script is running. There is no more need to edit the following config files directly.

Config files are found in directory Config

• config.txt = general settings, wallet, etc.
• pools.config.txt = pool setup, set a different wallet, workername for each pool and coin
• miners.config.txt = individually add arguments to miner (selected by name and device names and algorithm)
• devices.config.txt = control algorithms and miners to be used by specific devices
• algorithms.config.txt = globally adjust algorithms, like min. hashrate, timetofind etc.
• coins.config.txt = globally adjust specific coins, like min. hashrate, timetofind etc.
• ocprofiles.confit.txt = setup custom overclocking profiles
• autoexec.config.txt = add executables/commands to be executed when RainbowMiner starts

Note: if you have not started the Start.bat yet, there will be no config files! Start it first! Config files are in JSON format. Look here to get an idea, how they work: https://www.tutorialspoint.com/json/index.htm Be careful, when editing these files. Every comma counts!

Config\config.txt

The config file will contain variables to reflect default values. You can safely replace those variables with values.

An example:

"StartPaused": "$StartPaused",
"Interval": "$Interval",

Basic setup

• Wallet = your general BTC wallet address
• WorkerName = your desired worker name
• Currency = currencies, you want to be shown [default=BTC,USD,EUR]
• Region = your region, [default=US]
• UIstyle = set to "full" for complete listing, set to "lite" for reduced listing [default=full]
• UIsorting = set to "profit" in order to force UI sorting by profit, set to "biased" for internal biased profits [default=biased]
• UIProfitColumns = configure columns of miner profit tables in UI [default=Miner,Fee,Algorithm,Speed,Diff,Power,Profit,TTF,Accuracy,Pool,PoolFee,Wallet]
• UIFullBenchmarkList = Show non-extended benchmarks in minerlist [default=0]
• APIPort = enter a free web-interface port localhost: [default=4000]
• APIThreads = Enter number of possible, parallel API threads (0=automatic, see notes) [default=0]
• APIauth = set to "1" for username/password auth on localhost [default=0]
• APIuser = enter an username for localhost accessibility
• APIpassword = enter a password for localhost accessibility
• APIlockConfig = set to "1" to lock config and disable save via API/localhost [default=0]
• APImaxLoginAttemps = Maximum number of failed login attempts, until IP gets blocked (0=turn off) [default=3]
• APIblockLoginAttemptsTime = Enter timespan, that an IP gets blocked, after the defined failed login attempts (units allowed, e.h. 1h=one hour, default unit is s=seconds) [default=30m]
• APIallowIPs = Restrict access to the API to specific IP addresses [default=]
• EnableAutoUpdate = set to 1 if you want RainbowMiner to be updated automatically [default=1]
• EnableUpdateDuringPause = set to 1 if you want RainbowMiner to be updated automatically, even if it is paused [default=1]
• EnableUpdateWhenScheduled = set to 1 if the automatic updates should be scheduled: set EnableUpdate to 1 for a schedule in scheduler.config.txt (also, EnableAutoUpdate must be set to 1) [default=0]
• EnableAutoAlgorithmAdd = set to 1 if Rainbowminer should add all newly added algorithms to your config.txt, during (automatic) update
• EnableMinerStatus = set to 1 to enable central monitoring
• MinerStatusURL = url to central monitoring server [default=https://rbminer.net]
• MinerStatusKey = your unique miner status key (get one at https://rbminer.net, you can reuse MPM keys)
• MinerStatusEmail = if your miningrig goes offline at https://rbminer.net/monitoring, a warning will be sent to this email-address. Leave empty, if you do not want notifications.
• PushOverUserKey = if your miningrig goes offline at https://rbminer.net/monitoring, a notification will be sent via https://pushover.net, using your pushover user key. Leave empty, if you do not want this.
• MinerStatusMaxTemp = maximum allowed GPU temperature, triggers push message, if above [default=90]
• MinerStatusMaxCrashesPerHour = maximum allowed crashes per hour, triggers push message, if above [default=5]
• DiskMinGB = minimum free disk space in GB, triggers push message, if below [default=5]

Notes for the automatic values for APIThreads:

• if the RunMode is set to "Server", the thread count will be set to the number of CPU threads (with a maximum of 8)
• otherwise, the thread count will be set to the number of CPU cores (with a maximum of 2)

Select devices

• DeviceName = list of device descriptors, with which you want to mine [default=gpu]
  • click ListDevices.bat to find out which devices are available
  • out of this table, models, vendors and names can be used to select
  • for mining on all GPUs, use "gpu"
  • for mining on all Nvidia GPUs use "nvidia"
  • for mining on all AMD GPUs use "amd"
  • for mining on CPU, use "cpu"
  • examples:
    • "nvidia"
    • "gtx1070,gtx1080,cpu"
    • "cpu,gpu"
    • "gpu#01,gpu#03"
• ExcludeDeviceName = list of device descriptors to exclude from mining (see DeviceName for explanation)
• CPUMiningThreads = enter the number of softwarethreads being used by CPU miners. Adds "-t [threads]" to commandline of cpuminer forks
• CPUMiningAffinity = enter a hex number to define CPU mining core affinity (e.g. 0xAAAA). Adds "--cpu-affinity [affinity]" to commandline of cpuminer forks
• GPUMiningAffinity = enter a hex number to define GPU miner's CPU core affinity for validating results (e.g. 0xAAAA). Especially useful, when mining CPU and GPU in parallel.

If you defined CPUMiningThreads or CPUMiningAffinity, you may override the values for single miner, by adding your own "-t" and "--cpu-affinity" to the field Params in miners.config.txt. ClaymoreCPU, FireIce and JceminerCpu are not affected by these settings. They can be finetuned by editing config files (see section MINERS)

The affinity values define bitmasks, bit 0 = Core 0, bit 1 = Core 1, etc. The bitmasks are built from right to left.

Some examples:

0 or 1 - 1 CPU/Core on or off.
10 - Core/CPU 2 On, 1 Off.
100 - Core/CPU 3 On, 1 and 2 off.
101010 - Odd cores on, even off, 6 core.
10101010 - Odd cores on, even off, 8 core.
10101010101 - Even cores on, Odds off, 12 core.

To convert those binary 0/1 values into a hex number, you may use this Bin/Hex Converter.

Select algorithms

• Algorithm = list of algorithms, you want to mine [default=bitcore,blake2s,c11,cryptonightheavy,cryptonightv7,ethash,equihash,hmq1725,hsr,keccak,keccakc,lyra2re2,lyra2z,neoscrypt,pascal,phi,skein,skunk,timetravel,tribus,x16r,x16s,x17,vit,xevan,yescrypt,yescryptr16]
• ExcludeAlgorithm = list of algorithms, you want to exclude from mining
• ExcludeCoin = list of coins, you want to exclude from mining
• ExcludeFromWatchdog = list of algorithms or miner, you want to exclude from the watchdog
• DisableUnprofitableAlgolist = set to "1" if you do not want to use the list of unprofitable algorithms, provided live by RainbowMiner. [default=0]
• DisableUnprofitableCpuAlgolist = set to "1" if you do not want to use the list of unprofitable CPU algorithms, provided live by RainbowMiner (if you want to mine some GPU algorithms on your CPU). [default=0]
• EnableNeverProfitableAlgos = set to "1" if you want to mine all possible algorithms, even those that are considered never profitable. This setting overrides DisableUnprofitableCpuAlgolist [default=0]

Note: RainbowMiner uses two list of unprofitable algorithms. The lists are both maintained actively online and updated every hour. Both lists are active, by default. This avoids running benchmarks for algorithms, that normally don't turn into good profit.

• unprofitable.json = contains mostly ASIC algorithms with very low GPU mining profitability. This list is also in use as emergency switch-off for coins/algorithms, for which the pools fail to provide valid numbers. This avoids mining to rogue coins/algorithms.
• unprofitable-cpu.json = contains mostly GPU algorithms, with very low CPU mining profitability. If you like and want to mine one of these algorithms on your CPU, set "DisableUnprofitableCpuAlgolist": "1", in config.txt. There is no drawback, just low profits :)

Select miners

• MinerName = list of miner, you want to use for mining (see directory Miners, without .ps1, e.g. CcminerAlexis78.ps1 -> CcminerAlexis78)
• ExcludeMinerName = list of miner names, you want to exclude from mining
• ExcludeMinersWithFee = exclude all miners, that have a developer fee built-in [default=0]
• PreferMinerName = list of miner names, that you prefer (see PreferMinerMargin)
• PreferMinerMargin = Choose one of your preferred miners, if it's hashrate is not lower than xx% of the top miner's (in percent) [default=5]
• EnableCheckMiningConflict = Enable conflict check if running CPU hungry GPU miners (for weak CPUs) [default=0]
• EnableEthashZombieMode = Enable Ethash mining with slower hashrate, even if the current DAG size doesn't fit into the GPU memory [default=0]
• EnableMinersToSaveDAG = Allow miners to save DAGs to disk (currently TTminer only), costs a lot of space but speeds up the startup [default=0]
• DisableDualMining = set to 1, if you want to disable all dual mining [default=0]
• EnableDualMiningDuringRentals = set to 1, if dual mining during rentals should be allowed [default=0]
• *DisableZeroWattMiners = set to 1 to disable all miners that report 0-Watt [default=0]
• IgnoreFees = set to 1, if you do not want RainbowMiner to account the pool- and miner fees [default=0]
• ShowMinerWindow = show (1) or do not show (0) miner windows. Note: excavator will always run in an extra window [default=0]
• FastestMinerOnly = set to 1 to reduce list by only showing the fastest miner [default=1]
• DisableExtendInterval = during benchmark, some miners will run longer to find an accurate hashrate. Set to 1 to disable the extended times (this is not recommended, as it may result in inaccurate hashrates or failed some miners) [default=0]

Select pools

• PoolName = list of pool names, you want to use for mining [default=nicehash,zergpool]
• ExcludePoolName = list of pool names, you want to exclude from mining
• ShowPoolBalances = set to 1 to let RainbowMiner show your current pool balances [default=1]
• ShowPoolBalancesDetails = set to 0 if coin balances at a pool should be added up to BTC [default=1]
• ShowPoolBalancesExcludedPools = set to 1 to let RainbowMiner try to fetch balances from not used pools in addition to the currently activated pools [default=0]
• ExcludeCoinsymbolBalances = Exclude coinsymbols from balances. Leave empty for none [default=MAX,MUSIC]
• ShowWalletBalances = set to 1 to let RainbowMiner fetch and show available wallet balances [default=1]
• WalletBalances = enter list of which coin's wallets should be listed. Leave empty for all [default=]
• PoolDataWindow = set global default for all pool data windows [default=estimate_current]
• PoolStatAverage = set global default for all pool moving average live price trend [default=Minute_10]
• PoolStatAverageStable = set global default for all pool moving average stable price trend [default=Week]
• EnableErrorRatio = Enable yiimp pool price auto-correction [default=1]
• MaxErrorRatio = Maximum error ratio for yiimp pool price auto-correction [default=1.5]

Select mining mode

• MiningMode = possible values are "legacy", "device" and "combo", see explanation below
  • "legacy": one miner will handle all devices of one vendor together. Only NVIDIA, INTEL, AMD, CPU are possible to select.
  • "device" (default): each device group (e.g. GTX1070, RX570, CPU..) will get the most profitable miner to work on the different algorithm. If you have three different device groups, there will be three miners launched.
  • "combo": in addition to "device" mode, all possible combinations of device groups are taken into account. E.g. if all device types are considered most profitable for one specific miner, only one instance of the miner will be launched. Device types will only be combined for specific algorithm, if they have exactly equal params configured in miners.config.txt (the strings have to match). The combination of devices will be monitored separately: if the combo is less efficient than single miners, it will be deactivated automatically.
• EnableResetVega = set to 1 to always reset Vega Gpus before mining

Setup network operations

• RunMode = possible values are "standalone", "server", "client"
  • "standalone": this mining rig will handle everything on it's own
  • "server": this mining rig will act as server in a multiple rig setup
  • "client": this mining rig will not create network traffic but pull the data from the server rig

For Client (Runmode=client) setup:

• ServerName = enter the server's machinename or ip
• ServerPort = enter the server's ports
• ServerUser = enter the server's username (if auth)
• ServerPassword = enter the server's password
• EnableServerConfig = set to "1" to use the server's config files on this rig
• EnableServerPools = set to "1" to use the server's pool/coins/balance statistics and mine exactly to those pools (except for MiningRigRentals) Note: With this setting, it is possible to let the server rig control pools/coins/balance data of the client. This reduces network traffic significantly, but overrides the local pool setup. MiningRigRentals is excluded - this pool always runs locally.
• ServerConfigName = list of config files to be downloaded if "EnableServerConfig" is set to "1". Possible values are "algorithms","coins","config","miners","ocprofiles","pools"
• ExcludeServerConfigVars = list of parameter names in config.txt or pools.config.txt, that should -not- be overwritten with server values (best is to leave it as is). For pools.config.txt:
  • pools:<poolname> = protect all values of pool "poolname"
  • pools:<poolname>:<variablename> = protect "variablename" in pool "poolname"
• EnableServerExcludeList = set to "1" to always use the server's "ExcludeServerConfigVars", instead of the local one in config.txt

For Server (Runmode=server) setup:

• make sure to set APIport, APIauth, APIuser, APIpassword, APIallowIPs

Set electricity cost handling

• PowerPrice = price of 1kW/h (kilowatt per hour) that your electricity supplier charges [default=0]

• PowerOffset = power offset to allow consideration for overhead power [default=0]

• OctopusTariffCode = if you live in the UK and are an Octopus customer, you can let RainbowMiner pull the variable energy prices. Just enter your current trariff code. It's in the format E-1R-{product_code}-{region_code}, where product code is something like SILVER-2017-1, AGILE-18-02-21, ... and region code is a capital letter, range A to P

• PowerPriceCurrency = currency of your PowerPrice [default=USD]

• FixedCostPerDay = cumulative fixed costs per day (in power price currency) [default=0]

• UsePowerPrice = set to (1), if electricity cost and/or fixed cost should be subtracted from profits [default=0]

• CheckProfitability = if no more miners are profitable and this is set to (1), RainbowMiner will idle, until profitability returns. UsePowerPrice needs to be (1) and a PowerPrice greater than zero must be set for this function to work. [default=0]

• ProfitabilityLevel = profitability level in BTC in case CheckProfitability is set to 1 (e.g. -0.00002) [default=0]

• EnableMiningHeatControl = set to (1), if the mining heat control should be enabled [default=0]

• MiningHeatControl = set to a value 0..5 in steps of 0.1, to control heat over profit (2=default, 0=max.profit, 5=max.heat). A "PowerPrice" must be set for this function to work. [default=2]

  If "EnableMiningHeatControl" is enabled, the following formula is being used to calculate:

  Heat value=revenue-miner fee-powercost*(3 - MiningHeatControl)

  • "0" = min. heat
  • "2" = max. profit
  • "3" = max. revenue, best heat efficiency
  • "5" = max. heat

  A good start is to try values in the range of 2 to 3

Technical/Other

• Interval = timing interval in seconds of RainbowMiner [default=60]
• BenchmarkInterval = timing interval in seconds, used for benchmarks [default=60]
• RestartRBMTimespan = restart RainbowMiner after a timespan, units allowed: m=minutes, h=hours, d=days, w=weeks, default is s=seconds, leave empty or set to 0 to disable [default=0]
• RestartRBMMemory = restart RainbowMiner if memory usage exceeds this value, units allowed, e.g. 1.2G = 1.2 Gigabytes, default is bytes, set to 0 to disable [default=16G]
• EnableFastlaneBenchmark = set to 1 if you want to skip all benchmarks and download (very inaccurate) hashrate and powerdraw values from rbminer.net instead [default=0]
• FastlaneBenchmarkTypeCPU = if EnableFastlaneBenchmark="1": choose the value-set for CPU miners (avg, min or max) [default=avg]
• FastlaneBenchmarkTypeGPU = if EnableFastlaneBenchmark="1": choose the value-set for GPU miners (avg, min or max) [default=avg]
• EnableFastlaneBenchmarkMissing = if EnableFastlaneBenchmark="1": set to 1 if you want to benchmark all device/miners/algos not found on rbminer.net [default=1]
• MaxCrashesDuringBenchmark = maximum number of crashes allowed, until a benchmark fails [default=2]
• MinimumMiningIntervals = minimum number of intervals a miner will run, before switching will be allowed [default=1]
• SSL = configure ssl usage: 0=prefer non-SSL over SSL pools, 1=prefer SSL over non-SSL pools, 2=use SSL pools only [default=0]
• Proxy = set your proxy address here, if you are using one
• EnableCurl = set to 1 to use cURL instead of the build-in web requests (enable this, if you get frequent "Asyncloader is crashed" warnings) [default=0]
• Delay = extra delay in secondes, between switching to avoid blue screen [default=0]
• Watchdog = use (1) or do not use (0) watchdog [default=1]
• UseTimeSync = set to 1, if RainbowMiner should adjust the windows clock by rtp [default=1]
• WebsitesForOnlineCheck = list of websites, that RainbowMiner pings for testing the internet connection [default=www.google.com,www.amazon.com,www.baidu.com,www.coinbase.com,rbminer.net]
• SwitchingPrevention = finetune the switching prevention algorithm. Set to zero to disable [default=2]
• PoolSwitchingHysteresis = prevention of pool-to-pool hopping: the higher, the less switching (in %, 0 to disable, can be overwritten per pool) [default=3]
• MinerSwitchingHysteresis = prevention of on-pool miner-to-miner hopping: the higher, the less switching (in %, 0 to disable) [default=3]
• MaxRejectedShareRatio = set max. allowed ratio "bad shares/found shares" until a miner gets disabled [default=0.3]
• EnableFastSwitching = set to 1 to remove switching prevention completely. Expect a lot of switching [default=0]
• HashrateWeight = adjust weight of pool hashrates on the profit comparison in % (0..100, 0=disable) [default=20]
• HashrateWeightStrength = adjust the strength of the weight (integer, 0=no weight, 100=linear, 200=square) [default=50]
• PoolAccuracyWeight = adjust weight of pool accuracy on the profit comparison in % (0..100, 0=disable) [default=15]
• MinerFaultToleranceGPU = set the GPU miner fault tolerance in % (10..100) [default=10]
• MinerFaultToleranceCPU = set the CPU miner fault tolerance in % (10..100) [default=25]
• MaxAllowedLuck = if luck (= time_since_last_block / time_to_find_one_block) is greater than that number, increase the penalty up to 100% (0=disable, inactive for solo pools) [default=3]
• MaxTimeSinceLastBlock = if time_since_last_block is greater than that number, increase the penalty up to 100% (0=disable, time-units allowed in input, inactive for solo pools) [default=12h]
• ProfitSpikeProtection = prevent profit files to be updated, if the actual value is greater than the avg. profit x this factor (0 to disable) [default=0]
• RebootOnGPUFailure = (currently disabled)
• EnableOCProfiles = set to 1, if you plan to use custom overclocking profiles [default=0]
• EnableOCVoltage = set to 1, if you plan to set voltage for overclocking [default=0]
• EnableOCFullReset = set to 1, to reset all possible overclocking settings (instead of the prior set values, only), when a miner is closed. [default=1]
• EnableOCLinuxForcePState = set to 1, to force all GPU into their workload powerstate to avoid crashes due to P2-P0 switching [default=1]
• EnableOCLinuxSetAllPStates = set to 1, to set mem/core clock offsets to all PStates, instead to the highest, only [default=0]
• OCResetInterval = set the interval to reset the overclocking settings of running miners, in seconds (0 to disable) [default=0]
• MaxActivityDays = set max. days for localhost's Activity history [default=2]
• MSIApath = absolute windows path to MSI Afterburner executable [default=c:\Program Files (x86)\MSI Afterburner\MSIAfterburner.exe]
• MSIAprofile = default MSI Afterburner profile (1-5), set to 0 to disable [default=2]
• NVSMIpath = absolute windows path to Nvidia smi tools [default=c:\Program Files\NVIDIA Corporation\NVSMI]
• EnableLinuxMinerNiceness = set to 1 to enable nice command for miners
• LinuxMinerNiceness = enter the level for miner niceness from -20 = least nice to 19 = super nice [defaul=19]
• EnableLinuxHeadless = if set to 1, miner-startscripts and overclocking-scripts will include DISPLAY+XAUTHORITY settings
• LinuxDisplay = default Linux DISPLAY for headless operation [default=:0]
• LinuxXAuthority = default Linux XAUTHORITY for headless operation (needed for overclocking). [default=RainbowMiner will guess]
• MiningPriorityCPU = process priority for CPU miners (-2..2) [default=-2]
• MiningPriorityGPU = process priority for GPU miners (-2..2) [default=-1]
• AutoexecPriority = process priority for commands started via autoexec.txt (-2..2) [default=0]
• EthPillEnable = set to "revA" or "revB" (read Wiki for more information on revA/revB), or "disable" to stop using the EthPill for Ethereum mining [default=disable]
• RemoteAPI = set to 1 to enable accessibility of API within your network [default=0]
• Donate = set the minutes, you want RainbowMiner to work for the developer (min. is 10 minutes, equals to 0.7%) [default=24]
• EnableAutoMinerPorts = set to 1, if miners get into conflict with the ports in use
• StaticCPUMinerPort = enter a static API port number for all CPU miners (0=use default ports) [default=0]
• StaticGPUMinerPort = enter a static API port number for all GPU miners (0=use default ports) [default=0]
• DisableAPI = set to 1, if no localhost API is needed
• DisableAsyncLoader = set to 1, if all net access should happen synchronous (used for debugging)
• DisableInternetCheck = set to 1, in case you get "Internet is down" messages, even if the internet is available [default=0]
• DisableMSIAmonitor = set to 1, to fully disable MSI Afterburner monitoring (if more than six AMD GPU are used for mining)
• Quickstart = set to 1 to read all pool data from cache during startup (speeds up first start, but balance data may be out of date)
• StartPaused = set to 1 to start RainbowMiner in pause mode (no mining, you will have to press "P" to enable mining)
• EnablePauseOnActivity = set to 1 to automatically send RainbowMiner into pause mode, if user input is detected (also see ResumeOnInactivitySeconds) [default=0]
• EnablePauseOnBattery = set to 1 to automatically send RainbowMiner into pause mode, if notebook runs on battery (Windows only) [default=0]
• ResumeOnInactivitySeconds = seconds of no user input, until RainbowMiner leaves pause-on-activity mode (0 = never) [default=300]
• LinuxMinerTerminal = select the session handler RainbowMiner will use to start the miners in the background, choose screen, tmux or auto [default=auto]
• EnableMinersAsRoot = set to 0, if you do not want to run miners as root, using the OCDaemon (linux only) [default=1]
• OpenCLPlatformSorting = define sort order of the OpenCL platforms, comma separated list. Valid values are AMD,INTEL,NVIDIA. Leave empty for automatic detection (recommended) [default=]
• CovalentAPIKey = enter your covalenthq.com API key [default=]

Maintenance

• MaxLogfileDays = max. days to keep logfiles in Logs folder [default=5]
• MaxDownloadfileDays = max. days to keep downloaded files in Downloads folder [default=14]
• MaxCachefileDays = max. days to keep cache files in Cache folder [default=14]
• EnableMinerBackups = keep backups of updated miners in Bin folder, set to 0, if you have limited space [default=1]
• EnableKeepDownloads = keep downloaded miners in Downloads folder, set to 0, if you have limited space [default=1]

Notes for HashrateWeight

The comparison prices of the pools will be scaled with the following formula:

compare price = price x (1-(HashrateWeight/100)x(1-(rel. hashrate)^(HashrateWeightStrength/100))

Config\pools.config.txt

Each pool has it's own section, in the pools.config.txt

Change payout currency of a pool / add more wallets (e.g. Ravenminer uses RVN)

The default pool config look like this:

"Zpool": {
    "BTC": "$Wallet",
    "Worker": "$WorkerName",
    "Penalty": "0"
}

The line "BTC": "$Wallet" defines the payout wallet address. $Wallet uses the value in your config.txt, $ uses the value, defined for the corresponding currency in coins.config.txt If you want to change it to LTC, for example, you have to change this line like this:

"Zpool": {
    "LTC": "<YOUR_LITECOIN_ADDRESS>",
    "Worker": "$WorkerName",
    "Penalty": "0"
}

Or like this, if you setup a global wallet address in coins.config.txt

"Zpool": {
    "LTC": "$LTC",
    "Worker": "$WorkerName",
    "Penalty": "0"
}

For non-autoexchange pools, you may define multiple wallets. The wallets define, which coins may be mined at a pool. In the following example, Rainbowminer will mine RVN and SUQA on Icemining, hereby using the default RVN wallet in the coins.config.txt.

"Icemining": {
    "RVN": "$RVN",
    "SUQA": "<YOUR_SUQA_ADDRESS>"
    "Worker": "$WorkerName",
    "Penalty": "0"
}

` Alternatively you may instruct RainbowMiner to automatically use every currency defined in coins.config.txt (which is enabled by adding a wallet address and setting parameter "EnableAutoPool" to "1") for a certain pool. To do so, set parameter "EnableAutoCoin" to "1". Example:

"Icemining": {
    "Worker": "$WorkerName",
    "Penalty": 0,
    "EnableAutoCoin": "1"
}

Add additional password parameters for YiiMP based pools

Many of our pools are based on the open-source YiiMP pool (e.g. Hashcryptos,ZergPool,ZPool etc.). Some of these pools accept additional parameters. A prominent example is the setting of a custom payout limit at ZergPool (pl=x.xx). To add a password parameter, add one line to pools.config.txt in the form "CURRENCY-Params": "parameters",. In fact, all parameters will be added to the preset password contents, using a comma.

Example 1:

"ZergPool": {
    "LTC": "<YOUR_LTC_ADDRESS>",
    "LTC-Params": "pl=1.5",
    "Worker": "$WorkerName",
    "Penalty": "0"
}

In this example, if mining Zergpool, it will autoexchange everything into LTC. The parameter string "pl=1.5" will be added to the password, that is passed to the pool. In the case of ZergPool it will define a payout limit of 1.5 LTC. Of course any parameters can be added here, depending on the pool's options.

For ZergPoolCoins pools, extra password parameters can be assigned per coin, even when using autoexchange to a certain currency:

Example 2:

"ZergPoolCoins": {
    "BTC": "<YOUR_BTC_ADDRESS>",
    "BTC-Params": "pl=0.001",
    "BTC-MBC-Params": "d=0.1",
    "Worker": "$WorkerName",
    "Penalty": "0"
}

In example 2, when mining for some MBC on ZergPoolCoins, the difficulty will be set to 0.1 by adding ",d=0.1" to the miner's password parameter. "CURRENCY-COIN-Params" has priority over "CURRENCY-Params"

Change a pool's penalty

If you feel like a pool tends to exaggerate it's results, you can set a penalty in % through the field "Penalty":

"Ravenminer": {
    "RVN": "<YOUR_RAVENCOIN_ADDRESS>",
    "Worker": "$WorkerName",
    "Penalty": "5"
}

This would reduce the hashrate-results from the pool Ravenminer by 5%

Override default dynamic penalties

All pool's penalties will be adjusted upwards, if either the current luck is greater than "MaxAllowedLuck" or the actual time to find a block is greater than "MaxTimeSinceLastBlock". Both values are defined in the global config.txt. If you want to override the defaults for a specific pool, give the corresponding parameters a value.

"Zpool": {
    "BTC": "<YOUR_BTC_ADDRESS>",
    "Worker": "$WorkerName",
    "MaxAllowedLuck": "2",
    "MaxTimeSinceLastBlock": "2h"
}

This would set the MaxAllowedLuck to 2 (=200% luck) and 2h (=7200 seconds). Leaving the parameter(s) empty (as ""), will have this pool using the default values in config.txt Set the parameter(s) to "0", to disable the feature(s) for that pool.

Change a pool's time frame (data window)

To override the default data window "average2e" of the YiiMP based pools (Hashcryptos,ZergPool,Zpool) the parameter "DataWindow" can be added to the pool's configuration record. Possible values are:

• estimate_current (=default): the pool's current calculated profitability-estimation (more switching, relies on the honesty of the pool)
• estimate_last24h: the pool's calculated profitability-estimation for the past 24 hours (less switching, relies on the honesty of the pool)
• actual_last24h: the actual profitability over the past 24 hours (less switching)
• minimum2: the minimum value of estimate_current and actual_last24h will be used
• maximum2: the maximum value of estimate_current and actual_last24h will be used
• average2: the calculated average of estimate_current and actual_last24h will be used
• mininum2e: the minimum value of estimate_current and estimate_last24h will be used
• maximum2e: the maximum value of estimate_current and estimate_last24h will be used
• average2e: the calculated average of estimate_current and estimate_last24h will be used
• minimum2h: the minimum value of estimate_last24h and actual_last24h will be used
• maximum2h: the maximum value of estimate_last24h and actual_last24h will be used
• average2h: the calculated average of estimate_last24h and actual_last24h will be used
• mininum3: the minimum value of the above three values will be used
• maximum3: the maximum value of the above three values will be used
• average3: the calculated average of the above three values will be used

Example:

"Zpool": {
    "LTC": "<YOUR_LITECOIN_ADDRESS>",
    "Worker": "$WorkerName",
    "Penalty": "0",
    "DataWindow": "minimum3"
}

Change a pool's moving average (stat average for live and stable price)

The price pulled from the pool's API is being averaged down with a defined moving average trend line. The averaging time can be defined:

• for live price: using the parameter "StatAverage". It overrides the global default set by the config.txt parameter "PoolStatAverage" [default=Minute_10]
• for stable price: using the parameter "StatAverageStable". It overrides the global default set by the config.txt parameter "PoolStatAverageStable" [default=Week]

Possible values are:

• Live: the live price
• Minute_5: five minutes moving average
• Minute_10: ten minutes moving average
• Hour: one hour moving average
• Day: one day moving average
• ThreeDay: three day moving average
• Week: one week moving average

Example:

"Zpool": {
    "LTC": "<YOUR_LITECOIN_ADDRESS>",
    "Worker": "$WorkerName",
    "Penalty": "0",
    "DataWindow": "minimum3",
    "StatAverage": "Hour",
    "StatAverageStable": "ThreeDay"
}

Define the Algorithms and Coins of a pool

Per default all algorithms of a pool will be used. To define your own set of algorithm, there are two additional fields:

• Algorithm: a comma separated list of all pool's algorithm, you want RainbowMiner to use (leave empty for all)
• ExcludeAlgorithm: a comma separated list of all pool's algorithm, you explicitly do not want RainbowMiner to use (leave empty for no exception)
• CoinName: a comma separated list of coin names, you want RainbowMiner to use (leave empty for all). The coin's name must be spelled exactly like it is used at the corresponding pool. It applies to the pools, that transmit the coin names, only.
• ExcludeCoin: a comma separated list of coin names, you explicitly do not want RainbowMiner to use (leave empty for all coins). The coin's name must be spelled exactly like it is used at the corresponding pool. It applies to the pools, that transmit the coin names, only.
• CoinSymbol: a comma separated list of coin symbols, you want RainbowMiner to use (leave empty for all). Better alternative to "CoinName"
• ExcludeCoinSymbol: a comma separated list of coin's, you want RainbowMiner to use (leave empty for all). Better alternative to "ExcludeCoin"
• EnablePostBlockMining: set to "1" to allow forced mining a specific currency for a timespan (defined in coins.config.txt), after a block has been found.
• CoinSymbolPBM: if EnablePostBlockMining is set to "1", specify which currency is taken into account for post block mining. Leave empty for all.

Example:

"ZergPool": {
    "User": "$UserName",
    "Worker": "$WorkerName",
    "Algorithm": "lyra2z,skein,myriadgroestl,groestl,neoscrypt,equihash-btg",
    "ExcludeAlgorithm": "",
    "CoinName": "",
    "ExcludeCoin": "",
    "CoinSymbol": "",
    "ExcludeCoinSymbol": "BTG,XTC",
    "FocusWallet": "",
    "EnablePostBlockMining": "0",
    "CoinSymbolPBM": ""
}

Force mining to a pool's wallet

To force mining to pool's wallets, you may add the wallet's currencies to field "FocusWallet". RainbowMiner will mine into the the focused pool/wallets, only.

Example:

"Ethermine": {
    "ETC": "0x012031012301230123012301230",
    "ERG": "$ERG",
    "User": "$UserName",
    "Worker": "$WorkerName",
    "Algorithm": "",
    "ExcludeAlgorithm": "",
    "CoinName": "",
    "ExcludeCoin": "",
    "CoinSymbol": "",
    "ExcludeCoinSymbol": "",
    "FocusWallet": "ETC,ERG"
}

This example will focus mining operations to pool Ethermine, comparing this pool's profitability of ETC and ERG, only. No other pool will be mined.

Allow mining algorithm when pool hashrate equals to 0

All pool modules contain a check for an algorithm hashrate to be greater than 0. If you want to mine a special currency, even if you are the only miner (e.g. solo mining on GosxSolo), set field "AllowZero" to "1":

Example:

"GosxSolo": {
    "SUQA": "<YOUR_SUQA_ADDRESS>",
    "Worker": "$WorkerName",
    "FocusWallet": "SUQA",
    "AllowZero": "1"
}

Change switching prevention

To avoid rapid pool-to-pool hopping, the global config.txt parameter "PoolSwitchingHysteresis" can already be set. If needed, the global value can be overwritten with the pools.config.txt parameter "SwitchingHysteresis". Set if to a value of "0"-"100" or leave it empty "" to use the global "PoolSWitchingHysteresis"

Example:

"ZergPool": {
    "BTC": "<YOUR_BTC_ADDRESS>",
    "Worker": "$WorkerName",
    "SwitchingHysteresis": "5"
},
"ZergPoolCoins": {
    "BTC": "<YOUR_BTC_ADDRESS>",
    "Worker": "$WorkerName",
    "SwitchingHysteresis": "0"
}

In this example, the switching hysteresis would be set to 5% (another pool with the same algorithm would need at least a 5% higher price to be accepted) and switched off completely for ZergPoolCoins.

Force a specific region's stratum

All region stratums are chosen automatically, depending on your "Region" setting in config.txt. For some cases, you might want to select a specific region stratum for a pool.

Example:

"Nicehash": {
    "BTC": "<YOUR_BTC_ADDRESS>",
    "Worker": "$WorkerName",
    "Region": "US"
},

In this example, only the US stratum will be used for Nicehash. Make sure, that the pool supports a stratum for the selected region. If it doesn't, the pool will not show up anymore.

Config\userpools.config.txt

Integrate your own pool or other pools of choice via .\Config\userpools.config.txt.

Notes:

• Each Currency/Coin/Algorithm/Region combination needs an own entry
• Every unique pool name will automatically get an config entry in pools.config.txt
• Price and profit calculations will be done either via WhatToMine or if you provide an API url and description
• Hashrate/Workers/Blocktimes/Difficulty are supported if you provide an API url and description
• Don't forget to add your custom pool's name to "PoolName" in config.txt!

Example for xvg-pool.com:

add in userpools.config.txt

{
  "Enable": "1",
  "Name": "XvgPool",
  "PoolFee": "api1.x17.fees",
  "Algorithm": "X17",
  "CoinName": "Verge",
  "CoinSymbol": "XVG",
  "Currency": "XVG",
  "Protocol": "stratum+tcp",
  "Host": "mining.xvg-pool.com",
  "Port": "6851",
  "User": "$Wallet.$WorkerName",
  "Pass": "c=XVG5",
  "Region": "US",
  "SSL": "0",
  "Worker": "$WorkerName",
  "EthMode": "",
  "APIUrl1": "https://xvg-pool.com/api/status",
  "APIUrl2": "https://xvg-pool.com/api/currencies",
  "APIUrl3": "",
  "Profit": "api1.x17.estimate_current",
  "ProfitFactor": "api1.x17.mbtc_mh_factor",
  "ProfitCurrency": "BTC",
  "Hashrate": "api1.x17.hashrate",
  "Workers": "api1.x17.workers",
  "TimeSinceLast": "api2.XVG5.timesincelast",
  "Blocks24h": "api2.XVG5.24h_blocks",
  "Difficulty": "api2.XVG5.difficulty",
  "SoloMining": "0"
}

in config.txt, add the XvgPool to the "PoolName" list:

"PoolName": "Nicehash,ZergPoolCoins,XvgPool",

Mandatory parameters:

• Enable = set to "1", to enable your new entry [default=0]
• Name = name of the pool, every unique name will automatically get an own entry in pools.config.txt
• Currency = coin, that will be paid, determines the wallet address. Each currency will have an entry in pools.config.txt
• Host = stratum server address, without stratum+tcp://, just my.server.name
• Port = stratum server port

Remark: if CoinSymbol is set and Currency is empty, Currency will be set to CoinSymbol

Optional parameters:

• User = exact syntax for the user parameter for the miners, variables possible, see remarks below [default=$Wallet.$WorkerName]
• Pass = specific pool password, variables possible, see remarks below [default=x]
• CoinSymbol = coin, that will be mined
• Algorithm = if CoinSymbol is not set or is not in our database, explicitly setup the algorithm here.
• CoinName = if CoinSymbol is not in our database, explicitly setup the coin's name here.
• Protocol = setup your own protocol, if it differs from the default [default=stratum+tcp / stratum+ssl]
• PoolFee = pool fee in percent (e.g. 1 for one percent) [default=0] --> API!
• SSL = set to "1" if the stratum wants SSL [default=0]
• SoloMining = set to "1" if this is a solo mining pool [default=0]
• Region = setup the stratum server's home region [default=US]
• EthMode = setup the stratum/proxy mining mode for Ethash, Kawpow, Progpow pools [default=ethproxy for Ethash, stratum for KawPow]
  • "ethproxy"
  • "ethstratumnh"
  • "qtminer"
  • "minerproxy"
  • "stratum"
• Profit = value for Currency per Hashrate per Day (total_profit_per_day = Profit * Hashrate / ProfitFactor) --> API!
• ProfitFactor = divisor to for profit calculation [default=1] --> API!
• ProfitCurrency = set the Profit's currency, if it differs from Currency --> API!
• Hashrate = current hashrate on the pool --> API!
• Workers = number of workers on the pool --> API!
• TimeSinceLast = time since last block found in seconds --> API!
• Blocks24h = number of blocks found in the past 24 hours --> API!
• Difficulty = current difficulty for that algorithm (needed for SoloMining) --> API!

API (can be used for all parameters marked with --> API!)

• APIUrl1 = set to a valid API url
• APIUrl2 = set to a valid API url
• APIUrl3 = set to a valid API url

Instead of setting a static value (number) for the API parameters, you can address the request results of one of the API urls. To declare which of the API urls contains a value, start the path with "api1", "api2" or "api3". If you ommit this, "api1" will be used automatically. The APIs need to return valid JSON (with one exception, see below). To describe the path to the values, the following syntax need to be used:

• apiN.name1.name2. ... until you reach the value
• if there are arrays inside the JSON, you can select the next path step with brackets:
  • apiN.name1[M].name2. ... to select the object number M in the array name1
  • apiN.name1[name2=value2].name3. ... to select the object in array name1, that has parameter name2 set to "value2"

For Profit there is an exception: in case one of the API urls directly returns a number for profit, set Profit to

• "#" or "#1" for the direct value of API url 1
• "#2" for the direct value of API url 2
• "#3" for the direct value of API url 3

For ProfitFactor there is a special case: if the ProfitFactor path contains "mbtc_mh_factor", the ProfitFactor will be multiplicated by 1e6 (=1000000)

Remark: the following variables will be automatically replaced in parameters User, Pass and all --> API!

• $Wallet will be replaced with your currency's wallet (as defined in pools.config.txt)
• $WorkerName will be replaced with your rig's workername (or the value in pools.config.txt)
• $CoinSymbol will be replaced with the CoinSymbol from userpools.config.txt
• $Currency will be replaced with the Currency from userpools.config.txt
• $Password will be replaced with Password from pools.config.txt
• $Params will be replaced with "Params-" from pools.config.txt

Config\miners.config.txt

Each miner can be configured by it's own section, in the miners.config.txt

Example:

{
    "CcminerAlexis78-NVIDIA":  [
                            {
                                "MainAlgorithm":  "c11",
                                "SecondaryAlgorithm":  "",
                                "Params":  "-i 21",
                                "MSIAprofile":  "",
                                "OCprofile": "",
                                "Difficulty": ""
                            },
                            {
                                "MainAlgorithm":  "keccak",
                                "SecondaryAlgorithm":  "",
                                "Params":  "-m 2 -i 19,29",
                                "MSIAprofile":  "",
                                "OCprofile": "",
                                "Difficulty": ""
                            }
                        ],
   "CcminerAlexis78-GTX1070":  [
                            {
                                "MainAlgorithm":  "c11",
                                "SecondaryAlgorithm":  "",
                                "Params":  "-i 21",
                                "MSIAprofile":  "",
                                "OCprofile": "Profile1",
                                "Difficulty": ""
                            },
                            {
                                "MainAlgorithm":  "keccak",
                                "SecondaryAlgorithm":  "",
                                "Params":  "-m 2 -i 19,29",
                                "MSIAprofile":  "",
                                "OCprofile": "",
                                "Difficulty": ""
                            }
                        ],
    "Sgminer-AMD":  [
                            {
                                "MainAlgorithm":  "lyra2rev2",
                                "SecondaryAlgorithm":  "",
                                "Params":  "--gpu-threads 2 --worksize 128 --intensity d",
                                "MSIAprofile":  "",
                                "OCprofile": "",
                                "Difficulty": ""
                            },
                            {
                                "MainAlgorithm":  "neoscrypt",
                                "SecondaryAlgorithm":  "",
                                "Params":  "--gpu-threads 1 --worksize 64 --intensity 15",
                                "MSIAprofile":  "",
                                "OCprofile": "",
                                "Difficulty": "1000"
                            }
                        ],
    "Trex":  [
                            {
                                "MainAlgorithm":  "\*",
                                "SecondaryAlgorithm":  "",
                                "Params":  "",
                                "MSIAprofile":  "",
                                "Penalty": "12.5",
                                "Difficulty": ""
                            }
                        ]                                                                
}

.. this adds extra command line parameters "-i 21" and "-m 2 -i 19,29" to

• "CcminerAlexis78-NVIDIA": miner CcminerAlexis78 in LegacyMining mode, mine on all selected nvidia GPU, Algorithms c11 and keccak
• "CcminerAlexis78-GTX1070": miner CcminerAlexis78 in non-LegacyMining mode on selected GPU devices with model name GTX1070, Algorithms c11 and keccak
• "CcminerAlexis78-GTX1070": miner will use custom overclocking profile "Profile1"
• "Sgminer-AMD": miner Sgminer in LegacyMining mode, mine on all selected amd GPU, Algorithms c11 and keccak
• "MainAlgorithm": algorithm, for which the extra configuration will be used
• "SecondaryAlgorithm": secondary algorithm, for which the extra configuration will be used (used for dual-mining Claymore, Excavator)
• "Params": these are the extra parameters, that will be added to the miner call
• "MSIAprofile": desired MSI Afterburner profile

.. this adds a Penalty of 12.5% to all algorithms used by Trex

.. this adds a static pool difficulty of 1000 to Sgminer's Neoscrypt

To remove a certain parameter from the RainbowMiner's miner commandline, use the #-method:

• find out, which parameters are being used (e.g. --cpu-affinity for affinity and -t for threads) by looking at the command line, RainbowMiner is using
• edit miners.config.txt and find the miner
• now add the parameters, that you want to have removed to "Params", each followed by a blank and #

e.g.

"Params": "--cpu-affinity # -t #",

Config\devices.config.txt

Each device group can be bound to/excluded from specific algorithm and miners by editing this config file.

Example:

{
  "RTX3060": [
    {
      "Algorithm": "Ethash,x16r",
      "ExcludeAlgorithm": "",
      "MinerName": "",
      "ExcludeMinerName": "ClaymoreEthash",
      "DisableDualMining": "1",
      "DefaultOCprofile": "Profile1",
      "PowerAdjust": "100",
      "Worker": "my3060",
      "EnableLHR": "1"
    }
  ],
  "R290X": [
    {
      "Algorithm": "",
      "ExcludeAlgorithm": "",
      "MinerName": "",
      "ExcludeMinerName": "",
      "DisableDualMining": "1",
      "DefaultOCprofile": "Profile1",
      "PowerAdjust": "87.5",
      "Worker": "",
      "EnableLHR": ""
    }
  ]      
}

This configuration would:

• bind all RTX3060 in the system to Ethash and X16R mining, only, excluding the ClaymoreEthash miner
• setting the flag "DisableDualMining" to "1", all dual-algorithm miners will be removed from this device's list.
• for custom overclocking Profile1 is used as default for this GPU type
• set a power adjust factor of 87.5% to the Radeon R290X (if RainbowMiner reported 250W with factor 100%, it will now show 250W x 87.5 / 100 = 175W)
• the pool worker name for the RTX3060 will be set to "my3060". If used in combos, the individual worker names will be combined with _ (underscore)
• the miners Trex and Teamblack will be forced to use LHR magic for the RTX3060s, because "EnableLHR" is set to "1". Leave it empty for automatically use, set to "0" for don't use.

Config\gpugroups.config.txt

Under some circumstances you might want to divide GPUs with unique model name into multiple groups (e.g. mining on different pools). For this case, all GPUs may be grouped, using group names, to be setup in gpugroups.config.txt. To find out the GPU numbers in your system, start ListDevices.bat

Example: Assumed four GTX1070 GPUs running in this rig.

{
  "GPU#00": "A",
  "GPU#01": "A",
  "GPU#02": "Zerg",
  "GPU#03": ""
}

Using this setup, RainbowMiner will use the following model names:

• GPU#00 and GPU#01 will get name "GTX1070A"
• GPU#02 will get name "GTX1070ZERG"
• GPU#03 will keep name "GTX1070"

This will result in three separate GPU groups. Be aware, that for each device group a new entry in devices.config.txt will be created. Also, all different device group combinations will be added to miners.config.txt.

Config\algorithms.config.txt

Globally define parameters for algorithms:

Example:

{
  "X17": {
      "Penalty": "10",
      "MinHashrate": "50GH",
      "MinWorkers": "300",
      "MaxTimeToFind": "1.5h",
      "MSIAprofile": 4,
      "OCprofile": "Profile4",
      "MinerName": "Gminer,CcminerTpruvot",
      "ExcludeMinerName": ""
    }
}

This configuration would:

• Penalty: reduce all X17 pool prices by a "Penalty" of 10%
• MinHashrate: set a minimum X17 pool hashrate of 50 GH/s for a pool to be selected (units allowed: k=kilo, M=Mega, G=Giga, T=Tera, P=Peta)
• MinWorkers: set the minimum pool workers mining X17 to 300 for a pool to be selected
• MaxTimeToFind: set a maximum time to find for the next block of 1.5 hours (units allowed: s=seconds, m=minutes, h=hours)
• MSIAprofile: set the MSI Afterburner overclocking profile to 4 (if MSIA is used)
• OCprofile: set the overclocking profile to "Profile4" (if the RainbowMiner oc is used)
• MinerName: only Gminer and CcminerTpruvot are allowed to mine X17 (leave empty for all X17 miners)
• ExcludeMinerName: no excluded miners for X17 (in case you want to disable a specific miner for that algorithm, add it to this list)

Notes:

• the overclocking profiles define the default for a specific algorithm
• the OCprofile hierarchy: miners.config.txt over algorithms.config.txt over devices.config.txt

Config\coins.config.txt

Globally define parameters for coins:

Example:

{
  "RVN": {
      "Penalty": "10",
      "MinHashrate": "50GH",
      "MinWorkers": "300",
      "MaxTimeToFind": "1.5h",
      "Wallet": "<YOUR_RAVENCOIN_ADDRESS>",
      "EnableAutoPool": "1",
      "PostBlockMining": "5m",
      "MinProfitPercent": "80"
    }
}

This configuration would:

• reduce all RVN pool coin prices by a "Penalty" of 10%
• set a minimum RVN pool hashrate of 50 GH/s for a pool to be selected (units allowed: k=kilo, M=Mega, G=Giga, T=Tera, P=Peta)
• set the minimum pool workers mining RVN to 300 for a pool to be selected
• set a maximum time to find for the next block of 1.5 hours (units allowed: s=seconds, m=minutes, h=hours)
• define a global RVN wallet with value <YOUR_RAVENCOIN_ADDRESS>. Every occurrence of "$RVN" in pools.config.txt will be automatically substituted with this wallet.
• each pool, that has it's parameter "EnableAutoCoin" set to "1" will use this RVN wallet
• if a RVN block has been found within the timespan of 5 minutes (PostBlockMining) at a pool that has "EnablePostBlockMining" set to "1", RainbowMiner will force mining RVN on this pool
• switching to postblock mining only, if the post block miner's profit is at least 80% of the best miner's profit (field "MinProfitPercent")

Config\mrr.config.txt

If pool MiningRigRentals is in use, this file contains per worker name specific configuration parameters. Setting any parameter to a value other then empty string will override the same-name main parameter in pools.config.txt

Config\mrralgorithms.config.txt

If pool MiningRigRentals is in use, this file contains per algorithm specific configuration parameters.

• Enable: set to "0" in order to disable a specific algorithm for MiningRigRentals [default=1]
• PriceModifierPercent: if set to a non-empty value, this will override the PriceModifierPercent parameter in pools.config.txt and/or mrr.config.txt for an algorithm
• AllowExtensions: if set to a non-empty value ("0" or "1"), this will override the AllowExtensions parameter in pools.config.txt and/or mrr.config.txt for an algorithm
• PriceFactor: if set to a non-empty value, this will override the PriceFactor parameter in pools.config.txt and/or mrr.config.txt for an algorithm
• PriceFactorMin: if set to a non-empty value, this will override the PriceFactorMin parameter in pools.config.txt and/or mrr.config.txt for an algorithm
• PriceFactorDecayPercent: if set to a non-empty value, this will override the PriceFactorDecayPercent parameter in pools.config.txt and/or mrr.config.txt for an algorithm
• PriceFactorDecayTime: if set to a non-empty value, this will override the PriceFactorDecayTime parameter in pools.config.txt and/or mrr.config.txt for an algorithm
• PriceRiseExtensionPercent: if set to a non-empty value, this will override the PriceRiseExtensionPercent parameter in pools.config.txt and/or mrr.config.txt for an algorithm

Config\ocprofiles.config.txt

This file contains all custom overclocking profiles. These profiles can be assigned by name to miners in file Config\miners.config.txt or to algorithms in file Config\algorithms.config.txt, field "OCprofile".

To make it easy to handle names, profiles may be assigned to devices. Just add the device model (see file Config\devices.config.txt for all model names), a specific device's name ("GPU#00","GPU#01",..) or PCI bus id ("00:02","00:03",..) with "-" to the profile name. With this feature, it is very easy to use different overclocking rules for devices under one name.

Example (this is the setup for one of my GTX1070 rigs, basically substituting the MSI Afterburner profiles I recommended above)

{
  "Profile1-GTX1070": {
    "PowerLimit": 80,
    "ThermalLimit": 0,
    "MemoryClockBoost": "0",
    "CoreClockBoost": "0",
    "LockVoltagePoint": "*",
    "LockMemoryClock": "*",
    "LockCoreClock": "*",
    "PreCmd": "",
    "PreCmdArguments": "",
    "PostCmd": "",
    "PostCmdArguments": ""
  },
  "Profile2-GTX1070": {
    "PowerLimit": 80,
    "ThermalLimit": 0,
    "MemoryClockBoost": "400",
    "CoreClockBoost": "100",
    "LockVoltagePoint": "*",
    "LockMemoryClock": "*",
    "LockCoreClock": "*",
    "PreCmd": "",
    "PreCmdArguments": "",
    "PostCmd": "",
    "PostCmdArguments": ""
  },
  "Profile3-GTX1070": {
    "PowerLimit": 80,
    "ThermalLimit": 0,
    "MemoryClockBoost": "200",
    "CoreClockBoost": "100",
    "LockMemoryClock": "*",
    "LockCoreClock": "*",
    "LockVoltagePoint": "*",
    "PreCmd": "",
    "PreCmdArguments": "",
    "PostCmd": "",
    "PostCmdArguments": ""
  },
  "Profile4-GTX1070": {
    "PowerLimit": 80,
    "ThermalLimit": 0,
    "MemoryClockBoost": "-500",
    "CoreClockBoost": "100",
    "LockMemoryClock": "*",
    "LockCoreClock": "*",
    "LockVoltagePoint": "*",
    "PreCmd": "",
    "PreCmdArguments": "",
    "PostCmd": "",
    "PostCmdArguments": ""
  },
  "Profile5-GTX1070": {
    "PowerLimit": 80,
    "ThermalLimit": 0,
    "MemoryClockBoost": "350",
    "CoreClockBoost": "100",
    "LockMemoryClock": "*",
    "LockCoreClock": "*",
    "LockVoltagePoint": "*",
    "PreCmd": "",
    "PreCmdArguments": "",
    "PostCmd": "",
    "PostCmdArguments": ""
  },
  "Profile2-GPU#02": {
    "PowerLimit": 85,
    "ThermalLimit": 0,
    "MemoryClockBoost": "500",
    "CoreClockBoost": "150",
    "LockMemoryClock": "*",
    "LockCoreClock": "*",
    "LockVoltagePoint": "*",
    "PreCmd": "",
    "PreCmdArguments": "",
    "PostCmd": "",
    "PostCmdArguments": ""
  }
}

• PowerLimit: in percent, set to 0, if you do not want this to be changed
• ThermalLimit: in °C, set to 0, if you do not want this to be changed
• MemoryClockBoost: in MHz, set to "*", if you do not want this to be changed
• CoreClockBoost: in MHz, set to "*", if you do not want this to be changed
• LockVoltagePoint: in µV, set to "*", if you do not want this to be changed or "0", if voltagePoint should be unlocked
• LockMemoryClock: in MHz, set to "*", if you do not want this to be changed or "0", if MemoryClock should be unlocked
• LockCoreClock: in MHz, set to "*", if you do not want this to be changed or "0", if CoreClock should be unlocked
• PreCmd/PreCmdArguments: define a command to be executed before the miner starts. PreCmd is the path to the binary, PreCmdArguments are optional arguments for that command.
• PostCmd/PostCmdArguments: define a command to be executed after the miner has finished. PostCmd is the path to the binary, PostCmdArguments are optional arguments for that command.

Note the last entry: "Profile-GPU#02" Imagine a rig with multiple GTX1070 from the same manufacturer, except GPU#02, which is from a different manufacturer. This one GPU might need slightly different overclocking for Profile2. Adding the GPU's name or PCI bus id has priority over the model name selection.

Config\scheduler.config.txt

Define different power prices and/or pause miners for different timespans.

• DayOfWeek: *=all 0=Sunday 1=Monday 2=Tuesday 3=Wednesday 4=Thursday 5=Friday 6=Saturday
• From: start of timespan, 24h notation HH:MM, e.g. 15:30
• To: end of timespan, 24h notation HH:MM, e.g. 22:45
• PowerPrice: power price for this timespan, leave empty for default powerprice
• Pause: if set to "1", miners will be paused during this timespan
• Enable: if set to "1", this timespan will be used
• EnableUpdate: set to "1" to allow automatic updates during this timespan (and if EnableUpdateWhenScheduled is set to 1 in config.txt) [default=0]
• EnableMiningHeatControl: set to "1" to allow mining heat control during this timespan (and if EnableMiningHeatControl is set to 1 in config.txt) [default=0]
• MiningHeatControl: set specific mining heat control value, during that timespan
• PauseRentals: if set to "1", all unrented rigs will be paused during this timespan
• MRRPriceFactor: set specific price factor for MiningRigRentals, during that timespan
• Algorithm: restrict mining to specific algorithms, during that timespan
• ExcludeAlgorithm: disallow mining to specific algorithms, during that timespan
• CoinSymbol: restrict mining to specific coin symbols, during that timespan
• ExcludeCoinSymbol: disallow mining to specific coin symbols, during that timespan
• PoolName: restrict mining to specific pools, during that timespan
• ExcludePoolName: disallow mining to specific pools, during that timespan

Example

[
    {
        "DayOfWeek":  "*",
        "From":  "01:15",
        "To":  "07:30",
        "PowerPrice":  "0.15",
        "Pause":  "0",
        "Enable":  "1"
    },
    {
        "DayOfWeek":  "0",
        "From":  "00:00",
        "To":  "23:59",
        "PowerPrice":  "",
        "Pause":  "0",
        "Enable":  "1"
    },
    {
        "DayOfWeek":  "1",
        "From":  "15:00",
        "To":  "16:30",
        "PowerPrice":  "",
        "Pause":  "1",
        "Enable":  "1"
    }
]

• On sunday (dow=0), the default power price from config.txt will be used for the whole day
• On monday (dow=1), the miners will be paused during 3pm - 4:30pm
• On all other weekdays (dow=*), a power price of 0.15 will be used during 1am - 7:30am
• During all other times, the default power price from config.txt will be used

Config\autoexec.config.txt

If you want RainbowMiner to start other commands before the mining begins, you may add them to file Config\autoexec.config.txt by following the following rules:

• one line, one command
• command and path must be enclosed with doublequotes (")
• arguments (if any) must follow after the closing doublequote if the command
• a hashtag (#) marks the beginning of a comment, everything behind this within the line, will be ignored

Example:

#
# RainbowMiner autoexec
# =====================
# 

"C:\Qbundle\BlagoMiner\Blagominer_avx.exe" --argument1 whatsoever1

.. would start Blagominer_avx.exe with commands ""--argument1 whatsoever1", setting the working directory to "C:\Qbundle\BlagoMiner"

FAQ

How do I add RainbowMiner's Start.bat to the windows task sheduler for autostart?

Press windows key and type shedule, click on Task Sheduler

Create a basic task

Tab "General":

• check Run only when user is logged in
• check Run with highest privileges
• Configure for: Windows Vista, Windows Server 2008

Tab "Trigger":

• check When I log in

Tab "Actions":

• Action=Start a program
• Program/Script=cmd
• Add Arguments=/c "C:\Users\RainbowMiner\Desktop\current-version\Start.bat"
• Start In=C:\Users\RainbowMiner\Desktop\current-version\

How do I add RainbowMiner's start script to crontab on Linux for autostart?

As the user that will be running RainbowMiner, edit the crontab file using crontab -e. You will be promped to select the editor you want to use (emacs, vi, etc.) Add one of the following lines to the end of the file and save:

• @reboot /PATH_TO_RAINBOWMINER/start-screen.sh If you want RainbowMiner to start in a separate screen
• @reboot /PATH_TO_RAINBOWMINER/start-tmux.sh If you want RainbowMiner to start in a separate tmux session
• @reboot /PATH_TO_RAINBOWMINER/start-nohup.sh If you want RainbowMiner to run as a background process

Where PATH_TO_RAINBOWMINER is the RainbowMiner installation directory.

How can I rent my rig to someone at MiningRigRentals.com?

1. Signup and create a rig for rent

• signup at https://www.miningrigrentals.com
• create API keys with permission "Balance/Withdraw" = "Read-Only" and "Manage Rigs" = "Yes" (Hint: if you have multiple RainbowMiner rigs, create new keys for each of it!)
• create a rig for at least one algorithm that you want to rent to an interested renter at the "MyRigs" section of the website
• optional: add pools on the "Pool Configuration" tab of the rig
• set your rig's rentable status to "available"
• edit your rig's description and add your RainbowMiner workername, enclosed with square brackets, somewhere into the text, e.g. [rbm]. This is important, otherwise Rainbowminer will not find your rig, later.

2. Setup Rainbowminer

• add "MiningRigRentals" to the PoolName list and make sure it is not in the ExcludePoolName list (config.txt or [C]onfiguration->[S]elections)

• edit "Config\pools.config.txt", find the MiningRigRentals section and add (API_Secret, User) or edit the following data:

  "API_Key": "<put your MiningRigRentals API-key here>",
  "API_Secret": "<put your MiningRigRentals API-secret key here>",
  "User": "<put your MiningRigRentals username here>",
  "Worker": "<put your RainbowMiner workername here or leave $WorkerName>",
  "EnableMining": "0",
  

All rigs will be automatically set to status "online", at MiningRigRentals and rest idle within RainbowMiner. If someone starts a rental, RainbowMiner will detect this and run the respective miner exclusively, until the rental ends. All other rigs on MiningRigRentals will be deactivated, for that time.

If you want to include MiningRigRentals into RainbowMiner's profitability checks and switching operation, so that it behaves just like a normal pool, set "EnableMining" to "1". Only do this, if MiningRigRentals is your only pool, because the mining prices (these are the prices setup at MiningRigRentals), will not reflect the real market prices.

RainbowMiner can create and update your MRR rigs fully automatic!

The following are the pool parameters:

• User: Enter your MiningRigRentals username [default=]
• API_Key: Enter your MiningRigRentals API key [default=]
• API_Secret: Enter your MiningRigRentals API secret key [default=]
• UseWorkerName: Enter list of workernames that should be explicitly used for MRR (leave empty for all) [default=]
• ExcludeWorkerName: Enter list of workernames that should explicitly excluded from the use with MRR (leave empty for none) [default=]
• EnableMining: Enable switching to MiningRigRentals, even it is not rentend (not recommended) [default=0]
• EnableMaintenanceMode: Set to "1" if you are planning to shut down your rig for any reason (e.g. maintenance). RainbowMiner will then disable all unrented rigs, until you reset the parameter back to "0" [default=0]
• EnableAutoCreate: Automatically create MRR-rigs [default=0]
• EnableAutoUpdate: Automatically update MRR-rigs [default=0]
• EnableAutoExtend: Automatically extend MRR rentals, when low average hashrate [default=0]
• EnableAutoBenchmark: Enable automatic benchmark of updated miners (it will mine to your wallets only, during benchmark), select the mode with AutoBenchmarkMode [default=0]
• AutoBenchmarkMode: Select mode for auto-benchmark, "all" benchmarks all algorithms, "updated" benchmarks only updated algorithms of an updated miner [default=updated]
• AutoExtendTargetPercent: Extend rentals time, so that the total average hashrate is near this value in percent of advertised hashrate [default=100]
• AutoExtendMaximumPercent: Extend rentals maximum to this value in percent of the rental time [default=100]
• AutoBonusExtendForHours: Enter amount of hours, that you want to reward with an automatic bonus extension (e.g. 24) [default=0]
• AutoBonusExtendByHours: Enter bonus extension in hours per each fully rented AutoBonusExtendForHours (e.g. 1) [default=0]
• AutoBonusExtendTimes: Limit the maximum extensions by AutoBonusExtendByHours to a specific number of times (e.g. 1), 0=unlimited [default=0]
• AutoCreateMinProfitPercent: Enter minimum profitability in percent compared to current best profit, for full rigs to be autocreated on MRR [defau lt=50]
• AutoCreateMinCPUProfitBTC: Enter minimum one-day revenue in BTC, for a CPU-only rig to be autocreated on MRR [default=0.00001]
• AutoCreateMaxMinHours: Enter the maximum hours for minimum rental time, for a rig to be autocreated on MRR [default=24]
• AutoCreateAlgorithm: Algorithms that should always be autocreated on MRR, even if below the other limits [default=]
• AutoUpdateMinPriceChangePercent: Enter minimum price change in percent, for a rig's price to be updated on MRR [default=3]
• EnableAutoPrice: Enable MRR automatic prices [default=1]
• EnableMinimumPrice: Set MRR automatic minimum price [default=1]
• EnableAutoAdjustMinHours: Automatically adjust minimum rental time (up to MaxMinHours), to satisfy the min. profit of 0.00001 BTC [default=1]
• EnableUpdateTitle: Enable automatic updating of rig titles (disable, if you prefer to edit your rig titles online at MRR) [default=1]
• EnableUpdateDescription: Enable automatic updating of rig descriptions (disable, if you prefer to edit your rig descriptions online at MRR) [default=1]
• EnableUpdatePriceModifier: Enable automatic update of price modifier (disable, if you prefer to edit your modifiers online at MRR). Can be set globally in pools.config.txt (parameter AutoPriceModifierPercent) and specific for each algorithm in algorithms.config.txt (parameter MRRPriceModifierPercent) [default=0]
• AutoPriceModifierPercent: Autoprice modifier in percent (e.g. +10 will increase all suggested prices by 10%, valid range is -30 .. 30) [default=0]
• **UpdateInterval"*: Enter the interval time for create and update rigs on MRR (in seconds, verbose allowed, e.g. 1.5h = 1.5 hours, 30m = 30 minutes) [default=1h]
• PriceBTC: Fixed price in BTC (used, if EnableAutoPrice=0 or if the value is greater than the PriceFactor x revenue) [default=0]
• PriceFactor: Enter profit multiplicator: minimum price = rig's average revenue x this multiplicator [default=1.8]
• PriceFactorMin: Minimum profit multiplicator (only of use, if PriceFactorDecayPercent is greater than 0) [default=1.2]
• PriceFactorDecayPercent: Enter percentage for decay of the profit multiplicator over time (0 = disable) [default=0]
• PriceFactorDecayTime: Enter the profit multiplicator decay interval (in seconds, verbose allowed, e.g. 1.5h = 1.5 hours, 30m = 30 minutes) [default=4h]
• PriceRiseExtensionPercent: Enter price rise for extensions of a rental (in percent, e.g. 10 means 10% price rise) [default=0]
• PowerDrawFactor: Enter powerdraw multiplicator (only if UsePowerPrice is enabled): minimum price = minimum price + (miner's power draw - rig's average power draw) 24 / 1000 x powerdrawprice x this multiplicator [default=1.0]
• EnablePowerDrawAddOnly: Add the powerdraw cost difference only, if it is greater than 0 [default=0]
• MinHours: Minimum rental time in hours (min. 3) [default=3]
• MaxHours: Maximum rental time in hours (min. 3) [default=168]
• MaxMinHours: Upper limit for auto-adjust minimum rental time, if EnableAutoAdjustMinHours is set to 1 [default=24]
• AllowExtensions: Allow renters to buy extensions for their rentals [default=1]
• AllowRentalDuringPause: Allow rentals, even if the mining rig is in pause mode [default=0]
• PriceCurrencies: List of accepted currencies (must contain BTC) [default=BTC]
• Title: Title for autocreate, make sure it contains %algorithm% or %algorithmex% or %display%, and %rigid% (values will be substituted like that: %algorithm% with algorithm, %algorithmex% with algorithm plus coin info if needed, %coininfo% with eventual coin info, %display% with MRR specific display title, %rigid% with an unique rigid, %workername% with the workername, %type% with either CPU or GPU, %typecpu% with CPU or empty, %typegpu% with GPU or empty)";Description="Description for autocreate, %workername% will be substituted with rig's workername. Make sure you add [%workername%] (including the square brackets!) [default=%algorithmex% mining with RainbowMiner rig %rigid%]
• Description: Description for autocreate, %workername% will be substituted with rig's workername. Make sure you add [%workername%] (including the square brackets!) [default=Autostart mining with RainbowMiner (https://rbminer.net) on Windows. This rig is idle and will activate itself, as soon, as you rent it. [%workername%]]
• StartMessage: Message, that will be sent to the renter at the start of the rental. See below for possible substitution variables.
• ExtensionMessageTime: Send the ExtensionMessage to the renter, when the remaining rental time drops below this value (in seconds, verbose allowed, e.g. 1.5h = 1.5 hours, 30m = 30 minutes, set to 0 or empty to disable) [default=2h]
• ExtensionMessage: Message, that will be sent to the renter, when remaining rental time drops below ExtensionMessageTime
• DiffMessageTime: Send the DiffMessage to the renter, when the current difficulty stays out of the optimum difficulty for this time (in seconds, verbose allowed, e.g. 1.5h = 1.5 hours, 30m = 30 minutes, set to 0 or empty to disable) [default=15m]
• DiffMessageTolerancyPercent: Allowed tolerancy above the maximum and below the minimum of the optimum difficulty (in percent, e.g. 15 means 15%) [default=15]
• DiffMessage: Message, that will be sent to the renter, if the current difficulty stays out of the optimum difficulty for DiffMessageTime. See below for possible substitution variables.
• PoolOfflineTime: time a renter's pools has to be offline, until it is temporary disabled and the pool offline message is sent (in seconds, verbose allowed, e.g. 1.5h = 1.5 hours, 30m = 30 minutes) [default=3m]
• PoolOfflineRetryTime: time after which we will retry to connect to a disabled renter's pool (in seconds, verbose allowed, e.g. 1.5h = 1.5 hours, 30m = 30 minutes) [default=15m]
• PoolOfflineMessage: Message, that will be sent to the renter, after a renter's pool has been offline for PoolOfflineTime
• ProfitAverageTime: Enter the device profit moving average time period (Minute,Minute_5,Minute_10,Hour,Day,ThreeDay,Week), [default=Day]
• PauseBetweenRentals: Disable rigs on MRR after a rental for some time (in seconds, verbose allowed, e.g. 1.5h = 1.5 hours, 30m = 30 minutes) [default=10m]
• EnableRecoveryMode: if you have orphaned rigs due to empty description or if you have unintentionally removed the [%workername%] tag, set this to "1" and RainbowMiner will try to match all orphaned rigs to the unique rig titles and eventually recover the description. Since the recovery mode adds another pretty lengthy API call, make sure to disable (set "EnableRecoverMode" to "0"), after all rigs have been recovered. [default=0]

Substitution variables for StartMessage and DiffMessage:

• %Algorithm% = normalized algorithm name
• %Type% = Miningrigrental's algorithm name
• %Coin% = coin symbol, if applicable
• %MinDiff% = optimum minimum difficulty
• %MaxDiff% = optimum maximum difficulty
• %CurrentDiff% = current difficulty (only DiffMessage)
• %MinDiffFmt% = formatted* optimum minimum difficulty
• %MaxDiffFmt% = formatted* optimum maximum difficulty
• %CurrentDiffFmt% = formatted* current difficulty (only DiffMessage)

• %...fmt% will format numbers like that: 0.035 -> 35m, 120,000 -> 120k, 53,100,000 -> 53.1M

Hints:

• set "EnableAutoUpdate": "1",, to enable automatic updates of price/hash and minhours
• set "EnableAutoCreate": "1",, to enable automatic creation of profitable rigs on MRR
• the MRR suggested prices will be enabled, if "EnableAutoPrice": "1",
• the MRR adjust % value is set by "AutoPriceModifierPercent": "-10",, (in this example it's -10%)
• extensions can be (dis-)allowed per algorithm in algorithms.config.txt "MRRAllowExtensions": "0", (leave empty for the default in pools.config.txt)
• the price adjust % can be set per algorithm in algorithms.config.txt "MRRPriceModifierPercent": "-10",
• the MRR minimum price will be automatically set, if "EnableMinimumPrice": "1", (recommended!)
• if MRR suggested prices are disabled ("EnableAutoPrice": "0",)
  • either the rig's price will set to your rig's average profit x "PriceFactor"
  • or the rig's price will be set to "PriceBTC", if it is greater than 0
• if MRR suggested prices are enabled ("EnableAutoPrice": "1",)
  • either the rig's minimum price will be set to your rig's average profit x "PriceFactor"
  • or the rig's minimum price will be set to "PriceBTC", if it is greater than your rig's average profit x "PriceFactor"

Remark:

• to (dis-)allow the CPU rigs: add <yourrigworkername>cpu, e.g. if your workername is "RainbowMiner", use "RainbowMinercpu"
• to (dis-)allow the all-GPU rig: add <yourrigworkername>, e.g. if your workername is "RainbowMiner", use it :)
• to (dis-)allow device groups: add the workername(s), that you have given your device groups in devices.config.txt (parameter "Worker")
• to avoid miners crashing at the end of a rental, the MRR pools will be preset with my default donation pools. These will be used for some seconds at the end of the rentals, when the renter's pool finally goes offline, before the current RainbowMiner round is finished. You may change these to your likes, or leave them like they are and support my work with some seconds of your rig's time.

How can I quickly copy my current configuration to a new rig?

RainbowMiner comes with easy setup configuration. Download a setup.json at http://localhost:4000/setup.json from your current rig, copy it into the new rig's RainbowMiner folder before first start (you may easily reset RainbowMiner by simply deleting the complete ".\Config" folder). Now answer two inputs and off you go. More info can be found here.

How can I dual mine ETC with ZIL?

Most info can be found on the FAQ page at https://ezil.me. But there is more.

• first of all, get a ZIL wallet address.
• set your wallet address(es) in pools.config.txt section "Ezil"
• add "Ezil" to the "PoolName" list in config.txt
• if you want to mine ETC/ETH + ZIL on https://ezil.me only, you are done. You will mine ETH/ETC most of the time and the pool will switch to ZIL mining every 1,5h for a short period of time. ZIL uses the same Ethash algorithm.
• here is the extra: it is possible to mine ZIL only on ezil.me pool and with other algorithms on other pools with miner Nanominer (currently Autolycos2, Etchash, Ethash, KawPow and Octopus):
  • set the ZIL wallet in pools.config.txt, only. No ETH nor ETC.
  • set "EnableNanominerDual": "1", in pools.config.txt
  • done. Now Nanominer will switch to Ezil.me just in time to catch the next ZIL mining rounds and switch back, afterwards.
  • it will use the dummy ETH address 0xffffffffffffffffffffffffffffffffffffffff to auth on Ezil.me

How can I dual/triple mine ZIL with Bzminer?

• first of all, get a ZIL wallet address.
• set your wallet address(es) in pools.config.txt section "Flexpool"
• set "EnableBzminerDual": "1", in pools.config.txt section "Flexpool"
• add "Flexpool" to the "PoolName" list in config.txt
• Done! Bzminer will now switch to ZIL mining every 1,5h for a short period of time.

How does the profit switcher work and how can I change it's behavior?

The Profit Switcher Beast

The profit switcher can be controlled like follows. To be able to compare the pools (a "pool" is basically each available PoolName+Algorithm+CoinSymbol), an internal comparison price is being calculated.

• all available config parameters are marked as bold in the following

• the profit switcher uses two different price moving averages:

  • StablePrice: stable price, the moving average time defaults to 1 week. It can be changed for all pools in config.txt, with parameter PoolStatAverageStable, or per pool in pools.config.txt with parameter StatAverageStable
  • Price: live price, the moving average time defaults to 10 minutes. It can be changed for all pools in config.txt, with parameter PoolStatAverage, or per pool in pools.config.txt with parameter StatAverage

• PfC is the price for comparison. It starts at either the pool's StablePrice or Price:

  • PfC = StablePrice: if EnableFastSwitching is "0" (=disabled) and either ForceStablePrice is "1" (=enabled) or the pool isn't internally marked as PaysLive (like Nicehash is)
  • PfC = Price: all other cases (especially NiceHash)

• if EnableFastSwitching is set to "0" (=disabled) in config.txt:

  • for Pools, that aren't currently being mined, comparison prices will be decreased
    • PfC = PfC x ( 1 - ErrorMargin(%)/100 x DecayFactor(t) x PoolAccuracyWeight(%)/100 )
  • for Pools, that are currently being mined, comparison prices will be increased
    • if SwitchingHysteresis is set in pools.config.txt
      • PfC = PfC x ( 1 + SwitchingHysteresis(%)/100 )
    • else if PoolSwitchingHysteresis is set in config.txt
      • PfC = PfC x ( 1 + PoolSwitchingHysteresis(%)/100 )

• all prices will be decreased by a reverse exponential function, that will set hashrates into comparison to the maximum possible Algorithm+CoinSymbol hashrates PfC = PfC x ( 1 - (1 - (Hashrate/MaximumHashrate(Algorithm+CoinSymbol))^(HashrateWeightStrength(%)/100)) x (HashrateWeight(%)/100) )

• if MaxAllowedLuck is set to a value greater than 0 (floating point, 1 equals to 100%, 1.2 equals to 120% ...)

  • with Luck = TimeSinceLast/TimeToFind
  • PfC = PfC / (Luck - MaxAllowedLuck + 1)
  • 

• if MaxTimeSinceLastBlock is greater than 0 (in seconds) and the pool's time since last block is greater than MaxTimeSinceLastBlock, the comparison price will be decreased:

  • PfC = PfC / ( (PoolTimeSinceLastBlock - MaxTimeSinceLastBlock)/3600 + 1 )
  • 

• all prices will be decreased by an inverse logarithmic function, depending on how far a pool is out of sync (current-time minus last-price-or-hashrate-update time)

How can I make sure, my hand tuned config files in the Bin folders, will not be deleted during miner updates?

• RainbowMiner has a built-in list of protected files, that will be kept during updates:

  config.txt
  nvidia.txt
  amd.txt
  config_*.txt
  

• If you want to add your own userdefined files, that should be kept from update to update, edit the file Config\minerconfigfiles.txt and add your files (wildcards are allowed), one at each row.

• if the automatic fails: when updating, RainbowMiner creates a backup folder that contains the full contents of the original. It is named like the original miner's folder, but date/time added with a dot (e.g. CryptoNight-SrbMiner.20181202_174533). A maximum of three backups is kept.

CREDITS

The miner script has initially been forked from MultiPoolMiner, for my private use, only. Since I changed and optimized the script a lot to suit my needs, I decided to make the source code public, so that others can profit from my optimizations.

If you are happy with the script, crypto donations are greatly appreciated:

• BTC: 3P7pVVNpExuuHL9wjWKAo7jzQsb9ZziUFC
• BTC: bc1q6h7k2ul4a4rtmrlaemlxd9kmhtf89nlg6s4ydu (bech32 native segwit)
• BCH: 1MGRzyaLjQ67ZwwL9QTbXzwLxa8x1qSTBD
• ETH: 0x3084A8657ccF9d21575e5dD8357A2DEAf1904ef6