corrade-group-discord-bridge – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | office | 1 | [:- Requirements -:] |
2 | |||
3 | * node.js (confirmed working with node.js version 10.15.3) and npm |
||
4 | * a Discord bot & token (web search: creating a discord bot & getting a token) |
||
5 | * Corrade or above (confirmed working with version 11.0.286.368) |
||
6 | * Corrade must have the MQTT server enabled and running |
||
7 | (Nucleus->Configuration->(Tick Advanced)->Servers->MQTT (do not enable compression) |
||
8 | |||
9 | Two programs will have to be running: Corrade and the bridge program (this |
||
10 | one), at all times for the messages to be relayed between SecondLife and |
||
11 | Discord. |
||
12 | |||
13 | Setting up Corrade is wholely documented on the Wizardry and Steamworks Corrade page. |
||
14 | Node.JS and npm can be installed for each Linux distribution and for Windows from |
||
15 | official sources. |
||
16 | |||
17 | [:- Installing -:] |
||
18 | |||
19 | In the directory containing this document issue the command: |
||
20 | |||
21 | npm install |
||
22 | |||
23 | in order to install dependencies for this program. |
||
24 | |||
25 | Next, copy the file "config.yml.dist" to "config.yml" and edit "config.yml" to |
||
26 | change the settings such that they match the Corrade settings. |
||
27 | |||
28 | [:- Running -:] |
||
29 | |||
30 | For a test run, execute: |
||
31 | |||
32 | node main.js |
||
33 | |||
34 | and follow the console messages. If everything went well, the program will |
||
35 | announce that it has connected to Discord and to the Corrade MQTT server. |
||
36 | |||
37 | [:- Linux: Running as a Service -:] |
||
38 | |||
39 | Copy the file from "contrib/linux/corrade-group-discord-bridge.service" to |
||
40 | "/etc/systemd/system/" and edit it to configure parameters matching your |
||
41 | system. |
||
42 | |||
43 | Issue the command: |
||
44 | |||
45 | systemctl enable corrade-group-discord-bridge.service |
||
46 | |||
47 | to enable the service. |
||
48 | |||
49 | Then issue: |
||
50 | |||
51 | systemctl start corrade-group-discord-bridge.service |
||
52 | |||
53 | to start up the bridge in the background. |
||
54 | |||
55 | The service will be restarted in case it crashes and will also restart after |
||
56 | reboots. |
||
57 | |||
58 | (⌐■_■) |
||
59 | |||
60 | [:- Windows: Running as a Service -:] |
||
61 | |||
62 | Use nssm (free) or other software to install this program as a service. |
||
63 | |||
64 | [:- Licensing -:] |
||
65 | |||
66 | Wizardry and Steamworks Project-Closed and Open-Derivatives License 1.0 (WAS PC & OD 1.0) |