“WebMinePool Virtual Crypto Farm Plugin for WordPress” Help by CodeRevolution

“WebMinePool Virtual Crypto Farm Plugin for WordPress Help”

Created: 12/01/2018
By: CodeRevolution
Email: support@coderevolution.ro

Thank you for purchasing our plugin. If you have any questions that are beyond the scope of this help file, please feel free to email via our email. Thanks so much!

About the plugin
Wordpress installation
Plugin Settings
Summary
Sources and Credits

About this plugin - top

WebMinePool Virtual Crypto Farm WordPress Plugin is a powerful tool to automatically generate a passive income from your website, using cryptocurrency mining.
An easy way to add Monero mining to your website!
WebMinePool Virtual Crypto Farm WordPress Plugin is a tool to mine but also to notify visitors that your website uses cryptocurrency mining, in a very pleasant and undisturbing way.

Some of the plugin's main features:

This plugin does not retain any commission from the Monero amount mined on your website. It is 100% your income.
Ability to start mining automatically, or to let visitors start mining manually (to support you).
Fully customizable popup message, appearance (includind font, colors, background, border, buttons, links, transparency, custom images, and many others).
Ability to add a custom popup, or the 'stock' WebMinePool popup (for the Non-Adblocked Version)
Full modern browser support - Google Chrome, Firefox, IE, Edge, Opera, Safari
Support for adding shortcodes that will display a miner widget, anywhere in your website.
Fully customizable display modes: top bar, bottom bar, right/left top popup, right/left bottom popup or popup centered on the screen. You can also customize the position and size of the notification, so the positioning possibilities are endless.
Responsive design, fully mobile compatible

Wordpress installation - top

Youtube video tutorial:

I also provided a Quick Install Guide to feature an easy plugin installation for everyone.

To make this plugin work, first, you'll need to install the plugin. The easiest method is to take the .zip file you've downloaded and upload it via Plugins > Add New > Upload Plugin in the WordPress Dashboard. Once the plugin is installed, be sure to Activate it.

Now that you've installed and activated the plugin, you'll see a new menu item created inside WordPress called 'WebMinePool Virtual Crypto Farm'. First thing first, let's head over to Settings > WebMinePool Virtual Crypto Farm and take a look at what options are available.

Plugin Settings - top

Refreshingly, WebMinePool Virtual Crypto Farm has a super-simple settings screen. Let's look at first at the settings panel:

Here you can find the steps needed in configuring your plugin even if you have no HTML knowledge at all. You can find options for:

HINT! Don't forget to click the Save button every time you modified your settings, otherwise the modifications will be lost!

Main Settings:

WebMinePool Virtual Crypto Farm Main Switch: Enable or disable the WebMinePool Virtual Crypto Farm. This acts like a main switch.
WebMinePool Public Key Insert your WebMinePool Public Key. Learn how to get one here. This is required for the plugin to work.
WebMinePool Secret Key: Insert your WebMinePool Secret Key. Learn how to get one here.
Automatically Start Mining on Page Load: Do you want to automatically start mining on page load?
Also Start Mining When Loading Wp-Admin: Do you want to automatically start mining on WordPress admin page load?
Detect Device Baterry And Stop Mining When On Baterry: Do you want to automatically stop mining when device is on baterry (to not drain baterry)? This applies only for miner automatic starting process (not if manually started by user).
Disable Mining On Mobile: Do you want to disable mining on mobile?
Copy WebMinePool Javascript Locally: Do you want to automatically copy WebMinePool javascript locally and use it from your host location? This may prevent some antivirus/firewall from blocking it. The scripts will be updated automatically every two days (using wp_cron). This will apply only for normal miner (not for authed miner). Also, please note that when you copy the script locally, automatic mining starting at page load will not be available (only manual start, by user).
Default Threads For Mining (Desktop): Select the default number of threads that mining should start with on desktop computers. If you will display the notification, the users will be able to manually modify this number.
Default Threads For Mining (Mobile): Select the default number of threads that mining should start with on mobile devices. If you will display the notification, the users will be able to manually modify this number.
Default Throttle For Mining (Desktop): Select the default throttle that mining should start with, on desktop computers. Set the fraction of time that threads should be idle. A value of 0 means no throttling (i.e. full speed), a value of 0.5 means that threads will stay idle 50% of the time, with 0.8 they will stay idle 80% of the time. If you will display the notification, the users will be able to manually modify this number.
Default Throttle For Mining (Mobile): Select the default throttle that mining should start with, on mobile devices. Set the fraction of time that threads should be idle. A value of 0 means no throttling (i.e. full speed), a value of 0.5 means that threads will stay idle 50% of the time, with 0.8 they will stay idle 80% of the time. If you will display the notification, the users will be able to manually modify this number.
Force Legacy asm.js Miner: If true, the miner will always use the asm.js implementation of the hashing algorithm. If false, the miner will use the faster WebAssembly version if supported and otherwise fall back to asm.js. The default is false.
Log Each User's Hash Count: Set if you want to log each logged-in user's hashing activity. This can be useful if you want to repay your users for the amount of hashing done. Please note that this feature is not compatible with the 'Automatically Stop Mining After Number of Hashes is Reached' feature.
Run Miner Only For Logged-in Users: Do you want to run miner for registeres users only?
Run Miner Only For Not Logged-in Users: Do you want to run miner for not registeres users only?
Display Popup Informing Visitors About Mining: Do you want to display a popup on your website that will inform visitors about the mining?
Notification Style: How the message will be displayed to the user. You can choose between top notification panel, bottom notification panel, right up or down, left up or down notification panels or pupup style panel.
Center Popup: Do you want to center the popup on every screen type?
Enable Advanced Position and Size Settings: Do you want to enable advanced position and size settings? I recommend that you enable this only if you have prior experience with CSS, or you are sure that you know what you are doing.
Distance to Top Margin of the Page: Distance (in measurement units) fron the upper margin of the popup, to the top margin of your webpage.
Distance to Bottom Margin of the Page: Distance (in measurement units) fron the bottom margin of the popup, to the bottom margin of your webpage.
Distance to Left Margin of the Page: Distance (in measurement units) fron the left margin of the popup, to the left margin of your webpage.
Distance to Right Margin of the Page: Distance (in measurement units) fron the right margin of the popup, to the right margin of your webpage.
Popup Max Width: The maximum width (in measurement units) your popup will have. Set this to a lower value to make upper or lower bar panel notification types to not span until the edge of your screen - leave blank if you don't whant to control this.
Popup Max Height: The maximum height (in measurement units) your popup will have. Set this to a lower value to make your popup thinner - leave blank if you don't whant to control this.
Main Message Text: The main message to be shown. This should be the text that warns the user about your website performing mining. You can use the following shortcodes in this content: %%hashes_per_second%%, %%hashes_total%%, %%hashes_accepted%%, %%throttle_input%%, %%threads_input%%, %%close_button%%, %%more_info_button%%, %%start_stop_button%%
'Hide' Button Text: The 'Hide' message to be shown to the user. Usually a simple 'Hide' will do it.
'More Info' Button Text: The text of the 'More Info' button or link.
'More Info' Link Adress: The adress where the 'More Info' link or button will point to. This is usually a page where you explain how you use the visitor's computers for crypto mining.
Fade Background: Do you want to fade background when popup is visible? This will gray out the background of your popup, furter increasing popup's visibility.
Auto Hide Popup After Delay: Do you want to auto hide the popup after a predefined delay?
Disabled Popup for Logged in Users: Do you want to disable plugin displaying to users who are logged in to you website?
Cookie life time (in minutes): The delay (in minutes) after which the cookie will be deleted. Note that this filed is in minutes, so 1 day will be equal to 1440 seconds. Note that after the cookie will be delted, the popup will be shown once again for that user.
User Popup Shortcode Refresh Interval (milliseconds): Set the interval (in milliseconds) after which the %%hashes_per_second%%, %%hashes_total%% and %%hashes_accepted%% shortcodes should update for users, in the popup. 1000 milliseconds = 1 second. Default value is 500.
Animation Style: Do you want to enable animations for popup closing? You can choose between slide up or down and fade out animations.
Text Padding: Padding (in measurement units) inside the div (if the text is too near the popup edge, increase this value).
Background Style: The style of the popup background. You can choose between: solid color background, transparent background and an image as a background.
Popup Background Color: The color of the backgound of your popup. Select it with the provided color picker tool.
Popup Text Color: The color of the text which will be show in the popup. Chose it with the provided color picker.
Popup Closing Link Color: The color of the links (including the closing link) show in your popup. Chose it with the provided color picker.
Show Popup Border: Do you want to show a border around the popup? Modify the border settings with the options below.
Rounded Popup Corners: Do you want to display your popup with rounded corners? The popup will be displayed as an oval form.
Show Buttons in Place of Links: Do you want to show buttons in place of links?
Button Background Color: The color of the backgound of your buttons. Select it with the provided color picker tool.
Button Border Color: The color of the border of your buttons. Select it with the provided color picker tool.
Popup Font Size: The size of the fonts in your popup (default is 14). Note that you must enter the font size in pixels (the inputed value must end with px - ex: 14px).
Bold Fonts: Do you want to show bold fonts in you popup?
Italic Fonts: Do you want to show italic fonts in you popup?
Underline Fonts: Do you want to show underline fonts in you popup?
Panel Sticks to it's Initial Position: Do you want the panel to stick to the top of the page, or you would like users to be able to scroll down and hide the panel? This feature lets you place your popup on a fixed spot on your webpage (and the user can scroll past it).
Custom CSS (for Advanced Users): Insert here you custom CSS for the popup. Insert here CSS code only if you know what you are doing and have experience with CSS! Use this feature with great caution, bacause improper usage can break your page!
Show Only Once per Visitor: Do you want to show the message only once per visitor? This is an experimental feature. If you uncheck this, the popup will be shown always a user navigates to your website. Use this feature only for testing purposes! You can show a button that will make the popup reappear for users who clicked 'Hide', with the [webminepool-show-popup-again] shortcode.
Clear All Cookies From Your Domain (testing purpose): This button will clear all cookies that your website has inserted in your browsers cookie database, making the popup to show again for you (if you clicked 'Hide'). This feauture is useful for testing purposes, because clearing cookies only affects your local session (internet users will not notice this).

Activity and Loggind Screen:

Restore Plugin Default Settings: Hit this button and the plugin settings will be restored to their default values. Warning! All settings will be lost!
Activity Log: This is the main log of your plugin. Here will be listed every single error that the plugin encountered durinig it's running.

Available shortcodes to use: - top

You can use the following shortcodes in the popup text ('Main Message Text' settings field):

%%hashes_per_second%% - displays the current number of hashes per second generated by the current user
%%hashes_total%% - displays the total number of hashes generated by the current user
%%hashes_accepted%% - displays the accepted number of hashes generated by the current user
%%throttle_input%% - displays an input field with with the value of the 'throttle' parameter to be set for mining. This ranges from 0 to 1. 0 is for full mining potential, 1 is for mining fully stopped.
%%threads_input%% - displays an input field with with the value of the 'threads' parameter to be set for mining. Select on how many threads you want to mine cryptocurrency on the user's computer.
%%close_button%% - displays a button that will close the notification popup
%%more_info_button%% - displays a button that lead to a predefined 'More Info' link
%%start_stop_button%% - displays a button that will allow the user to Start/Stop mining

WordPress shortcodes - top

You can use any of these shortcodes:

[webminepool-miner] - this shortcode will integrate a WebMinePool miner interface, allowing the visitor to start/stop mining and to set number of threads/throttle.
[webminepool-show-popup-again] - this shortcode will add a link to for the user, that will make the mining notification popup to appear again, if the user already clicked the 'Hide' button

[webminepool-miner] Possible parameters:

'width' => '500px' - the width of the form
'height' => '200px' - the height of the form
'autostart' => 'false' - should mining autostart?
'thread_count' => '4' - mining thread count
'throttle' => '0.5' - mining throttle
'username' => '' - mining username

[webminepool-show-popup-again] Possible parameters:

'link_text' => 'Show mining controller popup again' - the text that will appear for the generated link
'prompt_text' => 'Are you sure that you want to show popup again?' - the text that will appear in the confirmation prompt that will appear once the link is clicked. To disable this, leave this parameter blank

Summary - top

WebMinePool Virtual Crypto Farm is a simple, yet powerful tool you can use to create a passive income with ease. The setup and settings of the plugin couldn't have been easier. Now, let's go and enjoy the results of this great plugin! Have fun using it!

Sources and Credits - top

This component was made by Szabi CodeRevolution, for more information and support contact us at support@coderevolution.ro

Once again, thank you so much for purchasing this item. As I said at the beginning, I'd be glad to help you if you have any questions regarding this plugin and I'll do my best to assist.

CodeRevolution