NiceHash QuickMiner Documentation

repository·main·Indexed 19 days ago

https://github.com/nicehash/nicehashquickminer

Resources for NiceHash QuickMiner, including instructions for verifying SHA1 and SHA256 checksums of release files, guidelines for creating and updating multi-language JSON translation files, and methods for translating EULA RTF files.

Tokens
1.6K
Snippets
6
Records
7
Agent score
17%

What's inside NiceHash QuickMiner

  1. Automatic checksum verification for .NHPKG files

    main
    .NHPKG (NiceHash package) files are automatically verified by the NiceHash QuickMiner application after being downloaded. The auto-update feature handles security by checking the SHA256 checksum of the package against the version information provided in latest_version.json.
  2. Create a new language file

    main

    To add a new language to NiceHash QuickMiner, follow these steps:

    1. Download the template: Download dump_en.json from the /lang/ directory.
    2. Modify strings: The JSON file contains arrays where the first element is a token and the second is the string. Modify only the second element of the array.
    3. Naming convention: Name the file using the two-letter language code followed by .json (e.g., de.json, pt.json, es.json).
    4. Requirements: The file must be in JSON format and use UTF8 encoding.
    5. Verification: Ensure your JSON is valid using a tool like JSON Formatter.

    Once complete, submit a pull request to have your translation accepted.

    // Example structure of a language file
    [
      ["TOKEN_NAME", "Translated String Here"],
      ["ANOTHER_TOKEN", "Another translation"]
    ]
  3. Update an existing language file

    main

    When new strings are added or existing ones are modified, the language file version increases. To update your translation:

    1. Set your language: Ensure your language is selected in the configuration file.
    2. Generate a dump: Run the executable with the --language-dump flag. This will dump your current language file and print any missing strings to the console.
    3. Handle missing strings: In production, missing strings default to English. You must add these new strings to your JSON file.
    4. Handle modified strings: Check /lang/UPDATES.md to see which existing strings have been updated.
    5. Finalize: Ensure the file remains valid JSON and UTF8 encoded, then submit a pull request.

    Command:

    NiceHashQuickMiner.exe --language-dump
  4. Translate EULA RTF files

    main

    To translate the End User License Agreement (EULA) while preserving formatting:

    1. Prepare the text: Use WordPad to write and style your translated text. Save it as an .rtf file (e.g., example.rtf).
    2. Convert to text: Use the --port-rtf command to extract the formatted text into a plain text format suitable for the language JSON file.
    3. Use the output: The command generates a .txt file containing your translated and formatted text. Copy this content into your language JSON file.

    Note: You must use the latest NiceHashQuickMiner.exe for this process.

    Command Syntax:

    NiceHashQuickMiner.exe --port-rtf <input_rtf_file> <output_txt_file>
    NiceHashQuickMiner.exe --port-rtf example.rtf translated.txt
  5. Verify SHA1 & SHA256 checksums for RELEASE files

    main

    To ensure the security and integrity of downloaded NiceHash QuickMiner files, you must verify that the file's SHA1 and SHA256 hashes match the official values provided in the repository. If the checksums do not match precisely with each letter and number, do not use the file, as it may have been tampered with.

    How to check hashes on Windows

    1. Download and install 7-Zip.
    2. Open File Explorer and locate your downloaded file.
    3. Right-click the file.
    4. Select CRC SHA from the context menu.
    5. Select * to view all available hash types (including SHA1 and SHA256).
    # No runnable code provided; instructions are for manual GUI verification via 7-Zip
  6. Test a language file locally

    main

    To test your custom language file in NiceHash QuickMiner:

    1. Identify a target language: Pick an existing language that is NOT en.
    2. Prepare the directory:
      • Quit NiceHash QuickMiner.
      • Navigate to the .\langs\ directory.
      • Open the existing language file and ensure its version matches your custom file's version.
      • Delete the existing language file.
      • Copy your custom language file into the .\langs\ directory and rename it to match the deleted file's name.
    3. Launch and Verify: Start NiceHash QuickMiner; it should now use your language.
    4. Revert: To go back to standard behavior, simply delete your custom language file from the .\langs\ directory.

    Viewing Special Dialogs

    You can test specific UI dialogs by appending command line arguments to the executable:

    Command LineDialog Shown
    --installDownload & installer
    --uninstallUninstall dialog
    --countWindows start-up counter before standard launch
    --updatedfrom <version>Various update-related message boxes

    Example:

    NiceHashQuickMiner.exe --install
  7. Checksum reference for RELEASE files

    main

    Official SHA1 and SHA256 checksums for current and historical NiceHash QuickMiner release files. Use these to validate your downloads.

    | File Name | Checksum |
    |----------|--------------|
    | Installer (v0.6.13.0): [NiceHashQuickMinerInstaller.exe] | **SHA1:** 74bf00b01e3bb8a7ecba4a8ec13f477300a81044<br> **SHA256**: 0d2b7dc88ed7f71e8ac0d09a3b7a2bc02f10997a2c95b7f491e3a23b75e4feff |
    | [NHQM_v0.6.13.0.zip] | **SHA1:** e02b74b6243cefcda4ed764205ff35a33592b0b1<br> **SHA256**: c27457c70767252783f77e9fde10e385727e826cacad6cb8a14778b0b7c7bde7 |
    | [NHQM_v0.7.8.0_RC.zip] | **SHA1:** 87c4985bfb534a2ea672fdcb2917ad2e3aa1c42a<br> **SHA256**: e36f71fe6cce2fd02a42e11df9dbba70e496e9eda4836d9ec79868e5c064fd3b |