Skip to content

Commit

Permalink
Merge pull request #37 from cashshuffle/doc-update
Browse files Browse the repository at this point in the history
readme update
  • Loading branch information
clifordsymack committed Sep 28, 2018
2 parents 15e121f + 4b051a2 commit 65f2e68
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Expand Up @@ -24,6 +24,7 @@ For installation of plugin do the follows:

8. Restart Electron Cash and you now should see the "Shuffle" tab in the main window.

![Server settings](/images/shuffle_tab.png)

## Making a shuffle

Expand Down Expand Up @@ -67,6 +68,24 @@ If you want to add your server to the list follow the next structure:

`port` value should be integer value of your server port and `ssl` should be boolean value of ssl support.

## Running a shuffling bot from plugin

You can run shuffling bot from plugin with checkin `use bot` checkbox.

![Bot settings](/images/Bot_tab.png)

1. Choose server from servers list

2. Specify minimal number of players in pool to support it

3. Specify maximum additional player which bot can add to pool

4. Specify lookup period

5. Run the bot with `Run bot` button

6. Stop it with `Stop bot` button if necessary

## Running a shuffling bot

You can run a shuffling bot for supporting of shuffling process. Bot is a simple python script which is looking at the selected cashshuffle server to see if it is a some players in the pool. If it finds a players it also run cahsshuffle protocol clients for mixing.
Expand Down
Binary file added images/Bot_tab.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 65f2e68

Please sign in to comment.