fnlb 1.1.18 → 1.1.19
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +30 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -94,7 +94,7 @@ await fnlb.start({
|
|
|
94
94
|
|
|
95
95
|
## 🎯 Starting Specific Bots by ID
|
|
96
96
|
|
|
97
|
-
|
|
97
|
+
Use the `bots` array to include specific bots by ID. Get bot IDs from [app.fnlb.net/bots](https://app.fnlb.net/bots) > select a bot > **About this bot** > **FNLB ID**.
|
|
98
98
|
|
|
99
99
|
```ts
|
|
100
100
|
import FNLB from 'fnlb';
|
|
@@ -108,9 +108,36 @@ await fnlb.start({
|
|
|
108
108
|
});
|
|
109
109
|
```
|
|
110
110
|
|
|
111
|
-
|
|
111
|
+
## 🔀 Bot and Category Selection
|
|
112
112
|
|
|
113
|
-
|
|
113
|
+
`categories` and `bots` define which bots a shard can pick from. They work as an **include list**.
|
|
114
|
+
|
|
115
|
+
- **Categories only** - bots in those categories, plus unassigned bots.
|
|
116
|
+
- **Bots only** - only the listed bot IDs.
|
|
117
|
+
- **Both** - bots from the listed categories **or** the listed bot IDs (union).
|
|
118
|
+
- **Neither** - your full bot pool.
|
|
119
|
+
|
|
120
|
+
Invalid category or bot IDs are ignored at startup.
|
|
121
|
+
|
|
122
|
+
Multiple shards can share the same `bots` list - the gateway distributes IDs across shards with no duplicates.
|
|
123
|
+
|
|
124
|
+
Example - start bots from two categories **and** two specific bots from elsewhere:
|
|
125
|
+
|
|
126
|
+
```ts
|
|
127
|
+
import FNLB from 'fnlb';
|
|
128
|
+
|
|
129
|
+
const fnlb = new FNLB();
|
|
130
|
+
|
|
131
|
+
await fnlb.start({
|
|
132
|
+
apiToken: 'your-api-token',
|
|
133
|
+
categories: ['category-id-1', 'category-id-2'],
|
|
134
|
+
bots: ['bot-id-1', 'bot-id-2'],
|
|
135
|
+
numberOfShards: 2,
|
|
136
|
+
botsPerShard: 10
|
|
137
|
+
});
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
Omit `categories` (or pass `[]`) to allow bots from any category when using `bots` alone. When `categories` is set, bots without a category are still included.
|
|
114
141
|
|
|
115
142
|
## ⛔ Stopping All Bots
|
|
116
143
|
|