You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+60-78Lines changed: 60 additions & 78 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,117 +12,99 @@ Features:
12
12
- Uniform Fiscal Object (UFO)
13
13
-~~Proton (PROTON)~~ Higgs(PROTON)
14
14
15
-
## Auto-Installation
16
15
17
-
for Windows Users Only!
16
+
## Create a Bot
18
17
19
-
Create a bot and get the bot's API Token:
20
-
https://discordapp.com/developers/applications/me
18
+
1) Create a bot and get the bots Token and Client ID: https://discordapp.com/developers/applications/me
21
19
22
-
make sure you have setup your wallet config properly to facilitate this bot
20
+
1) After going to the link above click “new application”. Give it a name, picture and description.
23
21
24
-
wallets data folder can be found in %appdata% (default Roaming Folder):
22
+
2) Click “Create Bot User” and click “Yes, Do It!” when the dialog pops up.
25
23
26
-
```
27
-
server=1
28
-
par=1
29
-
rpcbind=127.0.0.1
30
-
rpcallowip=127.0.0.1
31
-
rpcport=3335
32
-
rpcuser=<Same-as-you-set-in-config.json>
33
-
rpcpassword=<Same-as-you-set-in-config.json>
34
-
rpcclienttimeout=30
35
-
rpcthreads=<Number-of-Threads>
36
-
rpcworkqueue=1000
37
-
```
24
+
3) Copy down the token used to login and Client ID to invite your new bot to your discord server.
38
25
39
-
NOTE: if you are using a masternode coin you also need to add these to extra option into your wallets config file
26
+
2) invite the bot to your server using the link below and entering the Client ID or generate your own [Here :link:](https://discordapi.com/permissions.html)
edit and rename default.json.example in /config to default.json
32
+
## Edit Files
47
33
48
-
edit the following according to your wallets config options set in the previous step:
34
+
1) Edit and rename `ecosystem.json.js.example`to `ecosystem.json.js` in the root folder to match the correct directories for log files and bot root folder.
49
35
50
-
(you can add more coins by following this format and using the exampleTipper.js)
36
+
2) Edit and rename `default.json.example` to `default.json` in `/config`. You will use the same info in the next step.
to start the install run the windows-install.bat file!
46
+
(you can add more coins by following this format and using the `exampleTipper.js` file in `/bot/modules`)
61
47
62
-
before you start the file make sure the directories in ecosystem.config.js, you have to rename the old one from ecosystem.config.js.example to the file name above, properly match those of the project your deploying!
48
+
3) setup the wallets configfile
63
49
64
-
and finally `pm2 start ecosystem.config.js`
50
+
1) In most cases, your wallets data folder can be found in `%appdata%`
2) Edit or create your `COIN.conf` file (Where "COIN" is the coin name) to include the following:
69
55
70
-
## Requirements
56
+
```
57
+
server=1
58
+
par=1
59
+
rpcbind=127.0.0.1
60
+
rpcallowip=127.0.0.1
61
+
rpcport=3335
62
+
rpcuser=<Same-as-you-set-in-config.json>
63
+
rpcpassword=<Same-as-you-set-in-config.json>
64
+
rpcclienttimeout=30
65
+
rpcthreads=<Number-of-Threads>
66
+
rpcworkqueue=1000
67
+
```
71
68
72
-
- node > 8.0.0
73
-
- npm > 0.12.x
74
-
- yarn ( install with npm install -g yarn if not installed )
69
+
1) NOTE: if you are using a masternode coin you also need to add these to extra option into your wallets config file
75
70
76
-
## Installation
71
+
```
72
+
staking=0
73
+
enableaccounts=1
74
+
```
77
75
78
-
Download the respective coins wallet that uses bitcoind (aka bitcoin-qt).
76
+
## Install Bot
79
77
80
-
Create a bot and get the bot's Token: https://discordapp.com/developers/applications/me
78
+
### Auto - Windows
81
79
82
-
make sure you have setup your wallet config properly to facilitate this bot
80
+
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.
83
81
84
-
wallet folder found in %appdata% (default Roaming Folder):
82
+
2) verify the following tools are installed by running the commands below in cmd:
85
83
86
-
```
87
-
server=1
88
-
par=1
89
-
rpcbind=127.0.0.1
90
-
rpcallowip=127.0.0.1
91
-
rpcport=3335
92
-
rpcuser=<Same-as-you-set-in-config.json>
93
-
rpcpassword=<Same-as-you-set-in-config.json>
94
-
rpcclienttimeout=30
95
-
rpcthreads=<Number-of-Threads>
96
-
rpcworkqueue=1000
97
-
```
84
+
* git - `git --version`
85
+
* node - `node -v`
86
+
* npm - `npm -v`
87
+
* pm2 - `pm2 -v`
88
+
* yarn - `yarn --version`
98
89
99
-
NOTE: if you are using a masternode coin you also need to add these to extra option into your wallets config file
90
+
3) start the bot with `yarn start` or `pm2 start ecosystem.config.js` in the bots root directory
100
91
101
-
```
102
-
staking=0
103
-
enableaccounts=1
104
-
```
105
-
106
-
rename default.json.example in /config to default.json
92
+
1) if the bot fails to start and throws missing npm package errors simply run `npm install` again in the bots root directory
107
93
108
-
edit the following according to your wallets config options set in the previous step:
94
+
### Manual - Linux/Mac
109
95
110
-
(you can add more coins by following this format and using the exampleTipper.js)
96
+
1) Download and install the required tools listed below:
2) After the above tools have been installed run `npm install` in the bots root directory.
119
104
120
-
then run:
105
+
1) this may throw some errors on some systems not all packages are required for some systems, the bot will still run unless its a absolutely needed dependency.
121
106
122
-
```
123
-
npm install
124
-
pm2 start ecosystem.config.js
125
-
```
107
+
3) start the bot with `yarn start` or `pm2 start ecosystem.config.js` in the bots root directory
0 commit comments