Skip to content

Commit 95f4b47

Browse files
Bjornskjaldgitbook-bot
authored andcommitted
GitBook: [master] 15 pages modified
1 parent c409431 commit 95f4b47

File tree

3 files changed

+24
-9
lines changed

3 files changed

+24
-9
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ description: Hello! What's Miscord?
66

77
Miscord is a highly configurable and easy to use bridge between Discord and Messenger. It uses [`libfb`](https://github.com/ChatPlug/libfb) and [`discord.js`](https://discord.js.org/) libraries, it's written in TypeScript and runs basically on any system that supports [Node.js](https://nodejs.org), including Android phones and Raspberry Pi.
88

9-
Miscord is currently built by myself, [ptrcnull](https://ptrcnull.me). If you have any skills and free time, any contributions to the code are welcome. If you can't help that way, you might donate on [PayPal](https://paypal.me/Bjornskjald), [OpenCollective](https://opencollective.com/miscord) or [Patreon](https://patreon.com/Bjornskjald).
9+
Miscord is currently built by myself, [ptrcnull](https://ptrcnull.me). If you have any skills and free time, any contributions to the code are welcome. If you can't help that way, you might donate on [PayPal](https://paypal.me/Bjornskjald) or [OpenCollective](https://opencollective.com/miscord).
1010

configuration/connections.yml.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,15 @@ Your connection list is stored in a file named `connections.yml`.
99
It's a [YAML](https://en.wikipedia.org/wiki/YAML) file that should be in the same folder as your config file \(creates itself after a successful start\).
1010
Example format:
1111

12-
{% code-tabs %}
13-
{% code-tabs-item title="connections.yml" %}
12+
{% code title="connections.yml" %}
1413
```yaml
1514
example:
1615
- type: discord
1716
id: '1234'
1817
- type: messenger
1918
id: '5678'
2019
```
21-
{% endcode-tabs-item %}
22-
{% endcode-tabs %}
20+
{% endcode %}
2321
2422
Each connection entry consists of "endpoint" blocks, which usually have 2 properties: **type** \(`discord`/`messenger`\) and **id**, both required when creating a connection.
2523
You can add as many endpoints to one connections as you want.
@@ -39,8 +37,7 @@ The example above can be recreated using following commands:
3937

4038
Example connections file \(~~used live on~~ [~~Miscord's Discord server~~](https://discord.gg/DkmTvVz) ~~in `#testing`~~Facebook banned my accounts\) :
4139

42-
{% code-tabs %}
43-
{% code-tabs-item title="connections.yml" %}
40+
{% code title="connections.yml" %}
4441
```yaml
4542
__comment: >-
4643
This is your connections.yml file. More info at
@@ -59,8 +56,7 @@ dev:
5956
id: '1458225837612649'
6057
readonly: true
6158
```
62-
{% endcode-tabs-item %}
63-
{% endcode-tabs %}
59+
{% endcode %}
6460

6561
Command representation:
6662

configuration/dashboard.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
# Dashboard
22

3+
Web dashboard is an easy way of managing your Miscord instance.
4+
5+
If you're running Miscord for the first time without a config, it will automatically set up the dashboard settings for you.
6+
Otherwise, you need to add an api block to your config \(port is optional\):
7+
8+
```javascript
9+
"api": {
10+
"username": "ptrcnull",
11+
"password": "hunter2",
12+
"port": 1234
13+
}
14+
```
15+
16+
{% hint style="warning" %}
17+
The `api` block should not be in other blocks like `messenger` or `discord`
18+
{% endhint %}
19+
20+
21+

0 commit comments

Comments
 (0)