mshzhb / vk-ethminer

Vulkan-ethminer is the first an Ethash/Etcash GPU mining worker based on Vulkan. It supports windows, linux and macOS.
MIT License
8 stars 1 forks source link

VKminer

standard-readme compliant

This eth/etc miner supports nvidia, amd, intel, adreno, mali, img and apple M1 GPUs. It also the first miner available on android.

VKminer is the first an Etcash GPU mining worker based on Vulkan: with the miner you can mine every coin which relies on an Etcash Proof of Work thus including Ethereum (deprecated), Ethereum Classic, Metaverse, Musicoin, Ellaism, Pirl, Expanse and others. This is the actively maintained version of Vulkan-ethminer.

This project is still under development. If you want to commint to this project, please contact: mshzhb@gmail.com

Features

Table of Contents

Install

Standalone executables for Android, Linux, macOS and Windows are provided in the Releases section. Download an archive for your operating system and unpack the content to a place accessible from command line. The ethminer is ready to go.

Usage

The vkminer is a command line program. This means you launch it either from a Windows command prompt or Linux console, or create shortcuts to predefined command lines using a Linux Bash script or Windows batch/cmd file. For a full list of available command, please run:

./vulkan_ethminer --help

common run cli

#please replace 0x.. with your wallet
#On x86 platforms it will automatically run on all discrete gpus. On arm (e.g. apple) it will run on all gpus. 
./vulkan_ethminer --server us1-etc.ethermine.org --port 4444 --wallet 0x0D405dc4889DE1512BfdeFa0007c3b6AA468E31A --rig miner --shader wave_shuffle

list all devices

./vulkan_ethminer -l

explicitly run miner on GPU 0 and GPU 1

./vulkan_ethminer -d 0 1 ....

Build

Building from source

This project uses [CMake] and [Hunter] package manager.

Common

  1. CMake >= 3.6
  2. Git
  3. Vulkan-SDK >= 1.3
  4. python3
  5. build-tools

Linux & Mac OS

requires gcc/clang and make on linux/macOS

using build script

./setup.py

manual build

cd vulkan-etherminer
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Release ..
make

Windows

requires visual studio 2019+ on windows

using build script

py setup.py

manual build

cd vulkan-etherminer
mkdir build
cd build
cmake ..
cmake --build . --config Release
Xcopy shaders Release\shaders\ /E /H /C /I

Maintainers & Authors

Name Contact
Tong Liu @mshzhb 0x0d405dc4889de1512bfdefa0007c3b6aa468e31a

Contribute

All bug reports, pull requests and code reviews are very much welcome.

License

Licensed under the MIT License.

F.A.Q