feat: add diagram

This commit is contained in:
Jacob Nguyen
2022-07-10 00:04:52 -05:00
parent 3d05c4873f
commit 3fbfdeff76
2 changed files with 4 additions and 63 deletions

View File

@@ -1,61 +0,0 @@
<mxfile host="app.diagrams.net" modified="2022-07-10T04:49:15.896Z" agent="5.0 (Windows)" etag="OBzIRUwJS--wDtPsaW6S" version="20.0.4" type="github">
<diagram id="kgpKYQtTHZ0yAKxKKP6v" name="Page-1">
<mxGraphModel dx="677" dy="1490" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="QrId8dRm8pNMWfVECz5q-10" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="QrId8dRm8pNMWfVECz5q-1" target="QrId8dRm8pNMWfVECz5q-3">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-1" value="Event" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="70" y="-15" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-3" value="Plugin 1" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;" vertex="1" parent="1">
<mxGeometry x="240" y="-10" width="90" height="50" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-5" value="Plugin 2" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;" vertex="1" parent="1">
<mxGeometry x="380" y="-10" width="90" height="50" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-36" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="QrId8dRm8pNMWfVECz5q-6" target="QrId8dRm8pNMWfVECz5q-18">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-6" value="Plugin 3" style="shape=hexagon;perimeter=hexagonPerimeter2;whiteSpace=wrap;html=1;fixedSize=1;" vertex="1" parent="1">
<mxGeometry x="380" y="80" width="90" height="50" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-31" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="QrId8dRm8pNMWfVECz5q-18" target="QrId8dRm8pNMWfVECz5q-30">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-33" value="" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;" edge="1" parent="1" source="QrId8dRm8pNMWfVECz5q-18" target="QrId8dRm8pNMWfVECz5q-32">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-18" value="Is successful" style="strokeWidth=2;html=1;shape=mxgraph.flowchart.decision;whiteSpace=wrap;" vertex="1" parent="1">
<mxGeometry x="375" y="150" width="100" height="100" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-23" value="" style="endArrow=classic;html=1;rounded=0;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="425" y="40" as="sourcePoint" />
<mxPoint x="425" y="85" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-25" value="" style="endArrow=classic;html=1;rounded=0;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=1;exitY=0.5;exitDx=0;exitDy=0;" edge="1" parent="1" source="QrId8dRm8pNMWfVECz5q-3" target="QrId8dRm8pNMWfVECz5q-5">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="330" y="20" as="sourcePoint" />
<mxPoint x="380" y="-30" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-30" value="&lt;div&gt;Command Executes&lt;/div&gt;" style="rounded=1;whiteSpace=wrap;html=1;strokeWidth=2;" vertex="1" parent="1">
<mxGeometry x="240" y="300" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-32" value="Ignore" style="rounded=1;whiteSpace=wrap;html=1;strokeWidth=2;" vertex="1" parent="1">
<mxGeometry x="490" y="300" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-34" value="True" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="300" y="160" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="QrId8dRm8pNMWfVECz5q-35" value="&lt;div&gt;False&lt;/div&gt;" style="text;html=1;strokeColor=none;fillColor=none;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="470" y="160" width="60" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>

View File

@@ -256,7 +256,9 @@ export function logCreated(): CommandPlugin<CommandType.Text> {
}
```
Above, this simple plugin logs that the module has been loaded along with a timestamp. <br>
Again, it is up to the user to define plugin logic! The possibilities to customize your bots is endless.
Again, it is up to **you** to define plugin logic! The possibilities to customize your bots is endless.
## Event Plugins
sern hooks up to a discord.js event, and then handles which command is fired. <br>
![event-plugins](/assets/images/eventplugins.drawio.svg) <br>
The diagram should explain most of it. An event is emitted by discord.js, run through all the plugins, and if they are <br>
all successful, the command is executed.