fnlb 0.0.8 → 1.0.1
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 +75 -31
- package/dist/index.d.ts +13 -6
- package/dist/index.js +1 -1
- package/package.json +6 -9
package/README.md
CHANGED
|
@@ -1,16 +1,19 @@
|
|
|
1
|
-
# Fortnite
|
|
1
|
+
# 🚀 FNLB – Self-Host Your Own Fortnite Bot
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Easily run your own bot using **[FNLB](https://fnlb.net)**, a powerful and scalable system for managing Fortnite bots.
|
|
4
|
+
Whether you're running one bot or hundreds, FNLB gives you full control.
|
|
4
5
|
|
|
5
|
-
## Installation
|
|
6
|
+
## 📦 Installation
|
|
6
7
|
|
|
7
|
-
|
|
8
|
-
|
|
8
|
+
Install the latest version via npm:
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install fnlb@latest
|
|
9
12
|
```
|
|
10
13
|
|
|
11
|
-
##
|
|
14
|
+
## 🤖 Starting a Single Bot
|
|
12
15
|
|
|
13
|
-
|
|
16
|
+
Get started with a single bot using your [FNLB API token](https://app.fnlb.net/account):
|
|
14
17
|
|
|
15
18
|
```ts
|
|
16
19
|
import FNLB from 'fnlb';
|
|
@@ -18,13 +21,14 @@ import FNLB from 'fnlb';
|
|
|
18
21
|
const fnlb = new FNLB();
|
|
19
22
|
|
|
20
23
|
await fnlb.start({
|
|
21
|
-
apiToken: '
|
|
24
|
+
apiToken: 'your-api-token', // 🔑 Replace with your actual token from https://app.fnlb.net/account
|
|
25
|
+
categories: ['your-category-id'] // Get the category of your bot on https://app.fnlb.net/bots -> Click on your bot -> About this bot -> Category ID
|
|
22
26
|
});
|
|
23
27
|
```
|
|
24
28
|
|
|
25
|
-
##
|
|
29
|
+
## 🔁 Running Multiple Bots (Same Shard)
|
|
26
30
|
|
|
27
|
-
|
|
31
|
+
Run multiple bots in a **single subprocess** using the `botsPerShard` option:
|
|
28
32
|
|
|
29
33
|
```ts
|
|
30
34
|
import FNLB from 'fnlb';
|
|
@@ -32,14 +36,15 @@ import FNLB from 'fnlb';
|
|
|
32
36
|
const fnlb = new FNLB();
|
|
33
37
|
|
|
34
38
|
await fnlb.start({
|
|
35
|
-
apiToken: '
|
|
36
|
-
|
|
39
|
+
apiToken: 'your-api-token',
|
|
40
|
+
categories: ['your-category-id'],
|
|
41
|
+
botsPerShard: 10 // 🧱 Spawns max 10 bots
|
|
37
42
|
});
|
|
38
43
|
```
|
|
39
44
|
|
|
40
|
-
##
|
|
45
|
+
## 🧩 Using Multiple Shards (Subprocesses)
|
|
41
46
|
|
|
42
|
-
|
|
47
|
+
Scale even more by spawning multiple **shards** (subprocesses) with multiple bots each:
|
|
43
48
|
|
|
44
49
|
```ts
|
|
45
50
|
import FNLB from 'fnlb';
|
|
@@ -47,15 +52,19 @@ import FNLB from 'fnlb';
|
|
|
47
52
|
const fnlb = new FNLB();
|
|
48
53
|
|
|
49
54
|
await fnlb.start({
|
|
50
|
-
apiToken: '
|
|
51
|
-
|
|
52
|
-
|
|
55
|
+
apiToken: 'your-api-token',
|
|
56
|
+
categories: ['your-category-id'],
|
|
57
|
+
numberOfShards: 2, // 2 shards 🧩
|
|
58
|
+
botsPerShard: 10 // max 10 bots per shard 🤖
|
|
53
59
|
});
|
|
54
60
|
```
|
|
55
61
|
|
|
56
|
-
|
|
62
|
+
> 💡 Total bots: `numberOfShards × botsPerShard`
|
|
63
|
+
> In this example: 2 × 10 = **20 bots max**
|
|
64
|
+
|
|
65
|
+
## 🗂️ Launching Bots Across Multiple Categories
|
|
57
66
|
|
|
58
|
-
|
|
67
|
+
Want to run bots from different FNLB categories? Just add them to the `categories` array:
|
|
59
68
|
|
|
60
69
|
```ts
|
|
61
70
|
import FNLB from 'fnlb';
|
|
@@ -63,16 +72,16 @@ import FNLB from 'fnlb';
|
|
|
63
72
|
const fnlb = new FNLB();
|
|
64
73
|
|
|
65
74
|
await fnlb.start({
|
|
66
|
-
apiToken: '
|
|
67
|
-
categories: ['
|
|
75
|
+
apiToken: 'your-api-token',
|
|
76
|
+
categories: ['category-id-1', 'category-id-2'], // 🔄 Multi-category support
|
|
68
77
|
numberOfShards: 2,
|
|
69
78
|
botsPerShard: 10
|
|
70
79
|
});
|
|
71
80
|
```
|
|
72
81
|
|
|
73
|
-
##
|
|
82
|
+
## ⛔ Stopping All Bots
|
|
74
83
|
|
|
75
|
-
|
|
84
|
+
Shut everything down cleanly using the `stop()` method:
|
|
76
85
|
|
|
77
86
|
```ts
|
|
78
87
|
import FNLB from 'fnlb';
|
|
@@ -80,26 +89,61 @@ import FNLB from 'fnlb';
|
|
|
80
89
|
const fnlb = new FNLB();
|
|
81
90
|
|
|
82
91
|
await fnlb.start({
|
|
83
|
-
apiToken: '
|
|
92
|
+
apiToken: 'your-api-token',
|
|
84
93
|
numberOfShards: 2,
|
|
85
94
|
botsPerShard: 10
|
|
86
95
|
});
|
|
87
96
|
|
|
88
|
-
//
|
|
89
|
-
|
|
90
|
-
await fnlb.stop()
|
|
97
|
+
await fnlb.stop(); // 🛑 Stops all shards and bots
|
|
91
98
|
```
|
|
92
99
|
|
|
93
|
-
##
|
|
100
|
+
## 🏷️ Naming Your Cluster
|
|
94
101
|
|
|
95
|
-
|
|
102
|
+
Customize your cluster with a unique name using the `clusterName` option:
|
|
96
103
|
|
|
97
104
|
```ts
|
|
98
105
|
import FNLB from 'fnlb';
|
|
99
106
|
|
|
100
|
-
const fnlb = new FNLB({ clusterName: '
|
|
107
|
+
const fnlb = new FNLB({ clusterName: 'MyAwesomeCluster' });
|
|
101
108
|
|
|
102
109
|
await fnlb.start({
|
|
103
|
-
apiToken: '
|
|
110
|
+
apiToken: 'your-api-token'
|
|
104
111
|
});
|
|
105
112
|
```
|
|
113
|
+
|
|
114
|
+
## 🔄 Auto-Restart Every Hour (Optional)
|
|
115
|
+
|
|
116
|
+
Want to keep things fresh? Here's how to restart your bots automatically every hour:
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
import FNLB from 'fnlb';
|
|
120
|
+
|
|
121
|
+
const fnlb = new FNLB();
|
|
122
|
+
|
|
123
|
+
async function startFNLB() {
|
|
124
|
+
await fnlb.start({
|
|
125
|
+
apiToken: 'your-api-token',
|
|
126
|
+
numberOfShards: 1,
|
|
127
|
+
botsPerShard: 5,
|
|
128
|
+
categories: ['your-category-id']
|
|
129
|
+
});
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
async function restartFNLB() {
|
|
133
|
+
console.log('🔁 Restarting FNLB...');
|
|
134
|
+
await fnlb.stop();
|
|
135
|
+
await startFNLB();
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
await startFNLB();
|
|
139
|
+
|
|
140
|
+
// ⏱️ Restart every hour (3600000 ms)
|
|
141
|
+
setInterval(restartFNLB, 3_600_000);
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
## 💬 Join the Community
|
|
145
|
+
|
|
146
|
+
Need help, support, or just want to chat with other developers?
|
|
147
|
+
Come hang out with us on Discord! 👇
|
|
148
|
+
|
|
149
|
+
[](https://fnlb.net/discord)
|
package/dist/index.d.ts
CHANGED
|
@@ -20,6 +20,12 @@ export interface FNLBConfig {
|
|
|
20
20
|
disableErrorLogs?: boolean;
|
|
21
21
|
disableSubProcessLogs?: boolean;
|
|
22
22
|
disableSubProcessErrorLogs?: boolean;
|
|
23
|
+
maxDownloadRetries?: number;
|
|
24
|
+
maxBackoffMs?: number;
|
|
25
|
+
}
|
|
26
|
+
export declare enum LogLevel {
|
|
27
|
+
Info = "INFO",
|
|
28
|
+
Debug = "DEBUG"
|
|
23
29
|
}
|
|
24
30
|
export interface StartConfig {
|
|
25
31
|
apiToken: string;
|
|
@@ -28,22 +34,23 @@ export interface StartConfig {
|
|
|
28
34
|
botsPerShard?: number;
|
|
29
35
|
hideUsernames?: boolean;
|
|
30
36
|
hideEmails?: boolean;
|
|
31
|
-
logLevel?:
|
|
37
|
+
logLevel?: LogLevel;
|
|
32
38
|
}
|
|
33
39
|
declare class FNLB {
|
|
34
|
-
private isLoaded;
|
|
35
40
|
private readonly config?;
|
|
36
41
|
private readonly activeProcesses;
|
|
42
|
+
private readonly packageName;
|
|
43
|
+
private isLoaded;
|
|
37
44
|
private shouldRestart;
|
|
38
45
|
constructor(config?: FNLBConfig);
|
|
46
|
+
start(config: StartConfig): Promise<void>;
|
|
47
|
+
stop(): Promise<void>;
|
|
48
|
+
startShard(config: StartConfig, id: string): Promise<import("child_process").ChildProcess>;
|
|
49
|
+
update(): Promise<void>;
|
|
39
50
|
private log;
|
|
40
51
|
private success;
|
|
41
52
|
private warn;
|
|
42
53
|
private error;
|
|
43
|
-
update(): Promise<void>;
|
|
44
|
-
start(config: StartConfig): Promise<void>;
|
|
45
|
-
stop(): Promise<void>;
|
|
46
|
-
startShard(config: StartConfig, id: string): Promise<import("child_process").ChildProcess>;
|
|
47
54
|
}
|
|
48
55
|
|
|
49
56
|
export {
|
package/dist/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
import{fork as
|
|
1
|
+
import{fork as g}from"node:child_process";import{createHash as f}from"node:crypto";import{mkdir as u,readFile as m,writeFile as w}from"node:fs/promises";import{resolve as S}from"node:path";class l{static wait(t){return new Promise((e)=>setTimeout(e,t))}}class d{config;activeProcesses=new Map;packageName=`${process.versions.bun?"zenith-bun":"zenith"}`;isLoaded=!1;shouldRestart=!0;constructor(t){this.config=t}async start(t){if(await this.stop(),this.shouldRestart=!0,!t?.apiToken)throw new Error("[FNLB ShardingManager] Please provide a FNLB API token.");await this.update();let e=t.numberOfShards??1,i=(~~(Math.random()*1e4)).toString(36)+"fnlb"+(~~(Date.now()/1000)).toString(36);for(let s=0;s<e;s++){let r=`${i}-${s.toString().padStart(2,"0")}`,n=await this.startShard(t,r);this.activeProcesses.set(r,n)}}async stop(){if(this.shouldRestart=!1,this.activeProcesses.size===0)return;this.log("Stopping all active processes...");for(let[t,e]of this.activeProcesses)this.log(`Stopping process with ID: ${t}`),e.kill();this.activeProcesses.clear(),this.log("All processes stopped.")}async startShard(t,e){if(await this.update(),!t?.apiToken||t.apiToken.length<10)throw new Error("[FNLB ShardingManager] Please provide a valid FNLB API token.");this.log("Starting shard with ID:",e);let i=g(`./.fnlb/${this.packageName}.mjs`,[],{env:{...process.env,FORCE_COLOR:"1",SHARD_ID:e,API_TOKEN:t.apiToken,CATEGORIES:t.categories?.join(","),BOTS_PER_SHARD:(t.botsPerShard??1).toString(),HIDE_USERNAMES:t.hideUsernames?"true":"false",HIDE_EMAILS:t.hideEmails?"true":"false",LOG_LEVEL:t.logLevel,CLUSTER_ID:this.config?.clusterName?.trim().replace(/ +(?= )/g,"").toLowerCase().replaceAll(" ","-")??"unknown",CLUSTER_NAME:this.config?.clusterName?.trim()},stdio:["inherit","pipe","pipe","ipc"]});if(!this.config?.disableSubProcessLogs)i.stdout?.on("data",(s)=>{let r=s.toString("utf8");process.stdout.write(r),this.config?.onSubProcessLogMessage?.({timestamp:Date.now(),content:r,format:0})});if(!this.config?.disableSubProcessErrorLogs)i.stderr?.on("data",(s)=>{let r=s.toString("utf8");process.stderr.write(r),this.config?.onSubProcessLogMessage?.({timestamp:Date.now(),content:r,format:4})});return i.on("close",async(s)=>{if(this.activeProcesses.delete(e),this.shouldRestart){if(s===0)this.warn("Child process exited with code:",s?.toString()??"none");else this.error("Child process exited with code:",s?.toString()??"none");await l.wait(1e4);let r=await this.startShard(t,e);this.activeProcesses.set(e,r)}else this.log(`Child process ${e} stopped.`)}),i}async update(){if(this.isLoaded)return;let t=S(`./.fnlb/${this.packageName}.mjs`),e=await m(t,"utf-8").catch(()=>null),i=this.config?.maxDownloadRetries||1/0,s=this.config?.maxBackoffMs||60000;this.log(e?"Checking for updates...":"Downloading FNLB...");let r=`https://dist.fnlb.net/packages/${this.packageName}/release`,n,c=0,h=1000;while(c<i)try{let o=await fetch(r);if(!o.ok)throw new Error(`Status code: ${o.status}`);n=await o.json();break}catch(o){let a=Math.min(h*2,s);if(c++,this.warn(`Check for updates attempt ${c} failed: ${o.message}. Retrying in ${a>=60000?`${~~(a/60000)}m`:`${~~(a/1000)}s`}...`),c>=i)break;await new Promise((p)=>setTimeout(p,h)),h=a}if(!n){if(e){this.warn("Failed to check for updates. Using existing local version."),this.isLoaded=!0,this.success("Loaded existing FNLB version");return}throw new Error("[FNLB ShardingManager] Failed to check for updates and no local file found.")}if(e){if(f("sha256").update(e).digest("hex")===n.hash){this.success(`FNLB v${n.version} is up to date`),this.isLoaded=!0,this.success(`Finished loading FNLB v${n.version}`);return}this.log(`Downloading update for FNLB v${n.version}`)}c=0,h=1000;while(c<i)try{let o=await fetch(n.url);if(!o.ok)throw new Error(`Download failed with status ${o.status}`);let a=await o.text();if(f("sha256").update(a).digest("hex")!==n.hash)throw new Error("Downloaded file hash mismatch...");await u(".fnlb",{recursive:!0}),await w(t,a),this.isLoaded=!0,this.success(`Finished loading FNLB v${n.version}`);return}catch(o){let a=Math.min(h*2,s);c++,this.warn(`Download attempt ${c} failed: ${o.message}. Retrying in ${a>=60000?`${~~(a/60000)}m`:`${~~(a/1000)}s`}...`),await l.wait(h),h=a}if(e){this.warn("Max retries reached. Using existing local version."),this.isLoaded=!0,this.success("Loaded existing FNLB version");return}throw new Error(`[FNLB ShardingManager] Failed to download and verify update after ${c} attempts`)}log(...t){if(!this.config?.disableLogs)console.log("[FNLB ShardingManager]",...t),this.config?.onLogMessage?.({timestamp:Date.now(),content:t.join(" "),format:0})}success(...t){if(!this.config?.disableLogs)console.log("[FNLB ShardingManager] [OK]",...t),this.config?.onLogMessage?.({timestamp:Date.now(),content:t.join(" "),format:1})}warn(...t){if(!this.config?.disableErrorLogs)console.warn("[FNLB ShardingManager] [WRN]",...t),this.config?.onLogMessage?.({timestamp:Date.now(),content:t.join(" "),format:3})}error(...t){if(!this.config?.disableErrorLogs)console.error("[FNLB ShardingManager] [ERR]",...t),this.config?.onLogMessage?.({timestamp:Date.now(),content:t.join(" "),format:4})}}var L;((i)=>{i.Info="INFO";i.Debug="DEBUG"})(L||={});var M=d;export{M as default,L as LogLevel};
|
package/package.json
CHANGED
|
@@ -1,19 +1,16 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "fnlb",
|
|
3
|
-
"version": "
|
|
4
|
-
"author": "FNLB
|
|
3
|
+
"version": "1.0.1",
|
|
4
|
+
"author": "FNLB",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"devDependencies": {
|
|
7
7
|
"@biomejs/biome": "^1.9.4",
|
|
8
|
-
"@types/bun": "^1.
|
|
9
|
-
"bun-plugin-dts": "^0.3.0"
|
|
10
|
-
"@typescript-eslint/eslint-plugin": "^8.20.0",
|
|
11
|
-
"@typescript-eslint/parser": "^8.20.0",
|
|
12
|
-
"eslint": "^9.18.0"
|
|
8
|
+
"@types/bun": "^1.2.8",
|
|
9
|
+
"bun-plugin-dts": "^0.3.0"
|
|
13
10
|
},
|
|
14
|
-
"description": "
|
|
11
|
+
"description": "Easily run your own bot using FNLB, a powerful and scalable system for managing Fortnite bots.",
|
|
15
12
|
"files": ["dist"],
|
|
16
|
-
"keywords": [],
|
|
13
|
+
"keywords": ["fnlb", "fortnite", "lobbybot", "self-host", "botlobbies"],
|
|
17
14
|
"license": "ISC",
|
|
18
15
|
"packageManager": "bun@1.1.17",
|
|
19
16
|
"scripts": {
|