(This README will be updated along with bot updates)

Features:

• Tipbot for any coin running the bitcoind client.
  • Help message !tip.
• Dynamic plugin loading with permission support.
• out of the box Supported Coins
  • Dogecoin (DOGE)
  • Ravencoin (RVN)
  • LBRY Credits (LBC)
  • Uniform Fiscal Object (UFO)
  • Proton (PROTON) Higgs(PROTON)
  • Phoenixcoin (PXC)
  • Feathercoin (FTC)

1. Create a bot and get the bots Token and Client ID: https://discordapp.com/developers/applications/me

   1. After going to the link above click “new application”. Give it a name, picture, and description.

   2. Click “Create Bot User” and click “Yes, Do It!” when the dialog pops up.

   3. Copy down the token used to login and Client ID to invite your new bot to your discord server.

2. invite the bot to your server using the link below and entering the Client ID or generate your own Here:link:

https://discordapp.com/oauth2/authorize?client_id=INSERT_CLIENT_ID_HERE&scope=bot&permissions=27648

1. Edit and rename ecosystem.config.js.example to ecosystem.config.js in the root folder to match the correct directories for log files and bot root folder.

2. Edit and rename default.json.example to default.json in /config. You will use the same info in the next step.

   "raven": {
     "paytxfee": .01
     "config":
       "port": 3335,
       "user": "username",
       "pass": "Do-Not-Use-This-Password-Youll-Be-Hacked-For-all-Teh-Moneys!"
     }
   },
   

   (you can add more coins by following this format and using the exampleTipper.js file in /bot/modules)

3. set up the wallets config file

   1. In most cases, your wallets data folder can be found in %appdata%

      (default Roaming Folder), e.g. C:\Users\USER\AppData\Roaming\COIN.

   2. Edit or create your COIN.conf file (Where "COIN" is the coin name) to include the following:

      server=1
      par=1
      rpcbind=127.0.0.1
      rpcallowip=127.0.0.1
      rpcport=3335
      rpcuser=<Same-as-you-set-in-config.json>
      rpcpassword=<Same-as-you-set-in-config.json>
      rpcclienttimeout=30
      rpcthreads=<Number-of-Threads>
      rpcworkqueue=1000
      paytxfee=<Amount-to-always-pay-tx-fee>
      

      1. NOTE: for paytxfee to actually work properly use the console or rpc command settxfee number number being the fee of course.

      2. NOTE: if you are using a master node coin you also need to add these extra options into your wallets config file

      staking=0
      enableaccounts=1
      

1. run the windows-install.bat file to install needed tools, Not on windows or don't want to auto install follow the instructions below for manual Installation.

2. verify the following tools are installed by running the commands below in cmd:

   • git - git --version
   • node - node -v
     • npm - npm -v
       • pm2 - pm2 -v
       • yarn - yarn --version

3. start the bot with yarn start or pm2 start ecosystem.config.js in the bots root directory

   1. if the bot fails to start and throws missing npm package errors simply run npm install again in the bots root directory

1. Download and install the required tools listed below:

   • git > 2.0.0
   • node > 8.0.0
     • npm > 0.12.x
       • pm2 > latest
       • yarn > latest

2. After the above tools have been installed run npm install in the bots root directory.

   1. this may throw some errors on some systems not all packages are required for some systems, the bot will still run unless it's an absolutely needed dependency.

3. start the bot with yarn start or pm2 start ecosystem.config.js in the bots root directory

Be sure to run the command below before working on any code, this ensures prettier goes to work and keeps the code to our standard.

yarn install --production=false

to run prettier before submitting your code simply run the following in the bots root directory.

yarn precommit