(This README will be updated along with bot updates)
Features:
- Tipbot for the snatcoind client (will work with other daemons).
- Help message
!tip
.
- Help message
- Dynamic plugin loading with permission support.
- out of the box Supported Coins
- Snatcoin (SNAT)
-
Create a bot and get the bots Token and Client ID: https://discordapp.com/developers/applications/me
-
After going to the link above click “new application”. Give it a name, picture, and description.
-
On the side bar navigation menu click "Bot" Click “Add Bot” and click “Yes, Do It!” when the dialog pops up.
-
Copy down the token used on this page to login and Client ID on the general info page to invite your new bot to your discord server.
-
-
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
-
Edit
ecosystem.config.js
in the root folder to match the correct directories for log files and bot root folder. -
Edit
default.json
in/config
. You will use the same info in the next step."snat": { "paytxfee": .1 "config": "port": 2332, "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
) -
set up the wallets config file
-
In most cases, your wallets data folder can be found in
%appdata%
(default Roaming Folder),
e.g. C:\Users\USER\AppData\Roaming\snatcoin
-
Edit or create your
snatcoin.conf
file to include the following:server=1 par=1 rpcbind=127.0.0.1 rpcallowip=127.0.0.1 rpcport=2332 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>
-
NOTE: for
paytxfee
to actually work properly use the console or rpc commandsettxfee number
number being the fee of course. -
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
-
-
-
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. -
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
- pm2 -
- npm -
- git -
-
start the bot with
yarn start
orpm2 start ecosystem.config.js
in the bots root directory- if the bot fails to start and throws missing npm package errors simply run
npm install
again in the bots root directory
- if the bot fails to start and throws missing npm package errors simply run
-
Download and install the required tools listed below:
-
After the above tools have been installed run
npm install
in the bots root directory.- 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.
-
start the bot with
yarn start
orpm2 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
Don't forget to run node ./bot/bot.js in order to invite the bot into your Discord channel