mirror of
https://github.com/AsgardEternal/SquadJS.git
synced 2024-09-28 19:54:25 -05:00
Merge pull request #202 from 11TStudio/patch-2
Add link to README for socket.io plugin guide
This commit is contained in:
commit
ae19534404
30
README.md
30
README.md
@ -687,6 +687,34 @@ Grafana:
|
|||||||
<pre><code>true</code></pre></li></ul>
|
<pre><code>true</code></pre></li></ul>
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>DiscordSquadCreated</summary>
|
||||||
|
<h2>DiscordSquadCreated</h2>
|
||||||
|
<p>The <code>SquadCreated</code> plugin will log Squad Creation events to a Discord channel.</p>
|
||||||
|
<h3>Options</h3>
|
||||||
|
<ul><li><h4>discordClient (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Discord connector name.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>discord</code></pre></li>
|
||||||
|
<li><h4>channelID (Required)</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The ID of the channel to log Squad Creation events to.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code></code></pre></li><h6>Example</h6>
|
||||||
|
<pre><code>667741905228136459</code></pre>
|
||||||
|
<li><h4>color</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>The color of the embed.</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>16761867</code></pre></li>
|
||||||
|
<li><h4>useEmbed</h4>
|
||||||
|
<h6>Description</h6>
|
||||||
|
<p>Send message as Embed</p>
|
||||||
|
<h6>Default</h6>
|
||||||
|
<pre><code>true</code></pre></li></ul>
|
||||||
|
</details>
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>DiscordSubsystemRestarter</summary>
|
<summary>DiscordSubsystemRestarter</summary>
|
||||||
<h2>DiscordSubsystemRestarter</h2>
|
<h2>DiscordSubsystemRestarter</h2>
|
||||||
@ -849,7 +877,7 @@ Grafana:
|
|||||||
token: "MySecretPassword"
|
token: "MySecretPassword"
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
</code></pre>If you need more documentation about socket.io please go ahead and read the following;<br />General Socket.io documentation: <a href="https://socket.io/docs/v3" target="_blank">Socket.io Docs</a><br />Authentication and securing your websocket: <a href="https://socket.io/docs/v3/middlewares/#Sending-credentials" target="_blank">Sending-credentials</a></p>
|
</code></pre>If you need more documentation about socket.io please go ahead and read the following;<br />General Socket.io documentation: <a href="https://socket.io/docs/v3" target="_blank">Socket.io Docs</a><br />Authentication and securing your websocket: <a href="https://socket.io/docs/v3/middlewares/#Sending-credentials" target="_blank">Sending-credentials</a><br />How to use, install and configure a socketIO-client: <a href="https://github.com/11TStudio/SocketIO-Examples-for-SquadJS" target="_blank">Usage Guide with Examples</a></p>
|
||||||
<h3>Options</h3>
|
<h3>Options</h3>
|
||||||
<ul><li><h4>websocketPort (Required)</h4>
|
<ul><li><h4>websocketPort (Required)</h4>
|
||||||
<h6>Description</h6>
|
<h6>Description</h6>
|
||||||
|
@ -160,6 +160,14 @@
|
|||||||
"updateInterval": 60000,
|
"updateInterval": 60000,
|
||||||
"setBotStatus": true
|
"setBotStatus": true
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"plugin": "DiscordSquadCreated",
|
||||||
|
"enabled": false,
|
||||||
|
"discordClient": "discord",
|
||||||
|
"channelID": "",
|
||||||
|
"color": 16761867,
|
||||||
|
"useEmbed": true
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"plugin": "DiscordSubsystemRestarter",
|
"plugin": "DiscordSubsystemRestarter",
|
||||||
"enabled": false,
|
"enabled": false,
|
||||||
|
@ -43,7 +43,8 @@ export default class SocketIOAPI extends BasePlugin {
|
|||||||
</code></pre>` +
|
</code></pre>` +
|
||||||
'If you need more documentation about socket.io please go ahead and read the following;' +
|
'If you need more documentation about socket.io please go ahead and read the following;' +
|
||||||
'<br />General Socket.io documentation: <a href="https://socket.io/docs/v3" target="_blank">Socket.io Docs</a>' +
|
'<br />General Socket.io documentation: <a href="https://socket.io/docs/v3" target="_blank">Socket.io Docs</a>' +
|
||||||
'<br />Authentication and securing your websocket: <a href="https://socket.io/docs/v3/middlewares/#Sending-credentials" target="_blank">Sending-credentials</a>'
|
'<br />Authentication and securing your websocket: <a href="https://socket.io/docs/v3/middlewares/#Sending-credentials" target="_blank">Sending-credentials</a>' +
|
||||||
|
'<br />How to use, install and configure a socketIO-client: <a href="https://github.com/11TStudio/SocketIO-Examples-for-SquadJS" target="_blank">Usage Guide with Examples</a>'
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user