fnlb 1.0.0 → 1.1.0

package/README.md

@@ -1,16 +1,31 @@
-# Fortnite LobbyBot
+# 🚀 FNLB – Self-Host Your Own Fortnite Bot
 
-Self-Host your own Fortnite LobbyBot with FNLB's system.
+Easily run your own bot using **[FNLB](https://fnlb.net)**, a powerful and scalable system for managing Fortnite bots.  
+Whether you're running one bot or hundreds, FNLB gives you full control.  
 
-## Installation
+## 📦 Installation
 
-```sh
-npm i fnlb@latest
+Install the latest version via **npm install**:
+
+```bash
+npm install fnlb@latest
+```
+
+Using **[bun](https://bun.sh)**? Install the latest version via **bun install**:
+
+```bash
+bun install fnlb@latest
 ```
 
-## Start a bot
+## ⛓️‍💥 Useful Links
+
+- 📖 **[FNLB Documentation](https://docs.fnlb.net/introduction)**
+- 📄 **[FNLB Changelog](https://docs.fnlb.net/bots/changelog)**
+- 🗨️ **[FNLB Discord Server](https://fnlb.net/discord)**
+
+## 🤖 Starting a Single Bot
 
-This will start a single bot. You need to change the API Token to use the one of your FNLB account.  
+Get started with a single bot using your [FNLB API token](https://app.fnlb.net/account):
 
 ```ts
 import FNLB from 'fnlb';
@@ -18,13 +33,14 @@ import FNLB from 'fnlb';
 const fnlb = new FNLB();
 
 await fnlb.start({
-    apiToken: 'abc'
+    apiToken: 'your-api-token', // 🔑 Replace with your actual token from https://app.fnlb.net/account
+    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
 });
 ```
 
-## Start multiple bots
+## 🔁 Running Multiple Bots (Same Shard)
 
-To do it you can configure the botsPerShard setting. This example will spawn 10 bots on the same subprocess.
+Run multiple bots in a **single subprocess** using the `botsPerShard` option:
 
 ```ts
 import FNLB from 'fnlb';
@@ -32,14 +48,15 @@ import FNLB from 'fnlb';
 const fnlb = new FNLB();
 
 await fnlb.start({
-    apiToken: 'abc',
-    botsPerShard: 10
+    apiToken: 'your-api-token',
+    categories: ['your-category-id'],
+    botsPerShard: 10 // 🧱 Spawns max 10 bots
 });
 ```
 
-## Start multiple shards
+## 🧩 Using Multiple Shards (Subprocesses)
 
-To do it you can configure the numberOfShards setting. This example will spawn 2 shards (subprocesses) with 10 bots per shard for a total of 20 bots.
+Scale even more by spawning multiple **shards** (subprocesses) with multiple bots each:
 
 ```ts
 import FNLB from 'fnlb';
@@ -47,15 +64,19 @@ import FNLB from 'fnlb';
 const fnlb = new FNLB();
 
 await fnlb.start({
-    apiToken: 'abc',
-    numberOfShards: 2,
-    botsPerShard: 10
+    apiToken: 'your-api-token',
+    categories: ['your-category-id'],
+    numberOfShards: 2,     // 2 shards 🧩
+    botsPerShard: 10       // max 10 bots per shard 🤖
 });
 ```
 
-## Start bots only from certain categories
+> 💡 Total bots: `numberOfShards × botsPerShard`  
+> In this example: 2 × 10 = **20 bots max**
 
-To do it you can configure the categories setting.
+## 🗂️ Launching Bots Across Multiple Categories
+
+Want to run bots from different FNLB categories? Just add them to the `categories` array:
 
 ```ts
 import FNLB from 'fnlb';
@@ -63,16 +84,16 @@ import FNLB from 'fnlb';
 const fnlb = new FNLB();
 
 await fnlb.start({
-    apiToken: 'abc',
-    categories: ['abc', 'abc']
+    apiToken: 'your-api-token',
+    categories: ['category-id-1', 'category-id-2'], // 🔄 Multi-category support
     numberOfShards: 2,
     botsPerShard: 10
 });
 ```
 
-## Stop your bot
+## ⛔ Stopping All Bots
 
-The FNLB.stop() method will kill all the shards.
+Shut everything down cleanly using the `stop()` method:
 
 ```ts
 import FNLB from 'fnlb';
@@ -80,26 +101,61 @@ import FNLB from 'fnlb';
 const fnlb = new FNLB();
 
 await fnlb.start({
-    apiToken: 'abc',
+    apiToken: 'your-api-token',
     numberOfShards: 2,
     botsPerShard: 10
 });
 
-// do something
-
-await fnlb.stop()
+await fnlb.stop(); // 🛑 Stops all shards and bots
 ```
 
-## Set a cluster name
+## 🏷️ Naming Your Cluster
 
-You can use the clusterName option to set your cluster name.
+Customize your cluster with a unique name using the `clusterName` option:
 
 ```ts
 import FNLB from 'fnlb';
 
-const fnlb = new FNLB({ clusterName: 'MyCluster' });
+const fnlb = new FNLB({ clusterName: 'MyAwesomeCluster' });
 
 await fnlb.start({
-    apiToken: 'abc'
+    apiToken: 'your-api-token'
 });
 ```
+
+## 🔄 Auto-Restart Every Hour (Optional)
+
+Want to keep things fresh? Here's how to restart your bots automatically every hour:
+
+```ts
+import FNLB from 'fnlb';
+
+const fnlb = new FNLB();
+
+async function startFNLB() {
+    await fnlb.start({
+        apiToken: 'your-api-token',
+        numberOfShards: 1,
+        botsPerShard: 5,
+        categories: ['your-category-id']
+    });
+}
+
+async function restartFNLB() {
+    console.log('🔁 Restarting FNLB...');
+    await fnlb.stop();
+    await startFNLB();
+}
+
+await startFNLB();
+
+// ⏱️ Restart every hour (3600000 ms)
+setInterval(restartFNLB, 3_600_000);
+```
+
+## 🗨️ Join the Community
+
+Need help, support, or just want to chat with other developers?  
+Come hang out with us on Discord! 👇
+
+[![Join FNLB on Discord](https://discord.com/api/guilds/1106879710744543303/widget.png?style=banner3)](https://fnlb.net/discord)

package/dist/index.d.ts

@@ -20,6 +20,12 @@ export interface FNLBConfig {
 	disableErrorLogs?: boolean;
 	disableSubProcessLogs?: boolean;
 	disableSubProcessErrorLogs?: boolean;
+	maxDownloadRetries?: number;
+	maxBackoffMs?: number;
+}
+export declare enum LogLevel {
+	Info = "INFO",
+	Debug = "DEBUG"
 }
 export interface StartConfig {
 	apiToken: string;
@@ -28,22 +34,23 @@ export interface StartConfig {
 	botsPerShard?: number;
 	hideUsernames?: boolean;
 	hideEmails?: boolean;
-	logLevel?: "INFO" | "DEBUG";
+	logLevel?: LogLevel;
 }
 declare class FNLB {
-	private isLoaded;
 	private readonly config?;
 	private readonly activeProcesses;
+	private readonly packageName;
+	private isLoaded;
 	private shouldRestart;
 	constructor(config?: FNLBConfig);
+	start(config: StartConfig): Promise<void>;
+	stop(): Promise<void>;
+	startShard(config: StartConfig, id: string): Promise<import("child_process").ChildProcess>;
+	update(): Promise<void>;
 	private log;
 	private success;
 	private warn;
 	private error;
-	update(): Promise<void>;
-	start(config: StartConfig): Promise<void>;
-	stop(): Promise<void>;
-	startShard(config: StartConfig, id: string): Promise<import("child_process").ChildProcess>;
 }
 
 export {

package/dist/index.js

@@ -1 +1 @@
-import{fork as d}from"node:child_process";import{createHash as p}from"node:crypto";import{readFile as g,writeFile as f}from"node:fs/promises";import u from"node:path";class c{static wait(t){return new Promise((s)=>setTimeout(s,t))}}class i{isLoaded=!1;config;activeProcesses=new Map;shouldRestart=!0;constructor(t){this.config=t}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})}async update(){if(this.isLoaded)return;let t=u.join("zenith.mjs"),s=await g(t,"utf-8").catch(()=>null);this.log(s?"Checking for updates...":"Downloading FNLB...");let o=await fetch("https://dist.fnlb.net/packages/zenith/release");if(!o.ok)throw new Error(`[FNLB ShardingManager] Failed to check for updates, status code: ${o.status}`);let e=await o.json();if(s){let h=p("sha256");if(h.update(s),h.digest().toString("hex")===e.hash){this.success(`FNLB v${e.version} is up to date`),this.isLoaded=!0,this.success(`Finished loading FNLB v${e.version}`);return}this.log(`Downloading update for FNLB v${e.version}`)}let a=e.url,n=await fetch(a);if(!n.ok)throw new Error(`[FNLB ShardingManager] Failed to download update, status code: ${n.status}`);this.log(`Downloaded FNLB v${e.version}`);let l=await n.text();await f(t,l),this.isLoaded=!0,this.success(`Finished loading FNLB v${e.version}`)}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 s=t.numberOfShards??1;for(let r=0;r<s;r++){let o=new Date,e=`${r.toString().padStart(2,"0")}/${o.getDay()}${o.getHours()}${o.getMinutes()}${o.getSeconds()}`,a=await this.startShard(t,e);this.activeProcesses.set(e,a)}}async stop(){this.log("Stopping all active processes..."),this.shouldRestart=!1;for(let[t,s]of this.activeProcesses)this.log(`Stopping process with id: ${t}`),s.kill();this.activeProcesses.clear(),this.log("All processes stopped.")}async startShard(t,s){if(await this.update(),!t?.apiToken)throw new Error("[FNLB ShardingManager] Please provide a FNLB API token.");this.log("Starting shard with id:",s);let r=d("zenith.mjs",[],{env:{...process.env,FORCE_COLOR:"1",SHARD_ID:s,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)r.stdout?.on("data",(o)=>{let e=o.toString("utf8");process.stdout.write(e),this.config?.onSubProcessLogMessage?.({timestamp:Date.now(),content:e,format:0})});if(!this.config?.disableSubProcessErrorLogs)r.stderr?.on("data",(o)=>{let e=o.toString("utf8");process.stderr.write(e),this.config?.onSubProcessLogMessage?.({timestamp:Date.now(),content:e,format:4})});return r.on("close",async(o)=>{if(this.activeProcesses.delete(s),this.shouldRestart){if(o===0)this.warn("Child process exited with code:",o?.toString()??"none");else this.error("Child process exited with code:",o?.toString()??"none");await c.wait(1e4);let e=await this.startShard(t,s);this.activeProcesses.set(s,e)}else this.log(`Child process ${s} stopped.`)}),r}}var D=i;export{D as default};
+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

@@ -1,19 +1,17 @@
 {
 	"name": "fnlb",
-	"version": "1.0.0",
-	"author": "FNLB-Project",
+	"version": "1.1.0",
+	"author": "FNLB",
 	"main": "dist/index.js",
+	"homepage": "https://fnlb.net/",
 	"devDependencies": {
 		"@biomejs/biome": "^1.9.4",
-		"@types/bun": "^1.2.1",
-		"bun-plugin-dts": "^0.3.0",
-		"@typescript-eslint/eslint-plugin": "^8.22.0",
-		"@typescript-eslint/parser": "^8.22.0",
-		"eslint": "^9.19.0"
+		"@types/bun": "^1.2.8",
+		"bun-plugin-dts": "^0.3.0"
 	},
-	"description": "Self-Host your own Fortnite LobbyBot with FNLB's system.",
+	"description": "Easily run your own bot using FNLB, a powerful and scalable system for managing Fortnite bots.",
 	"files": ["dist"],
-	"keywords": [],
+	"keywords": ["fnlb", "fortnite", "lobbybot", "self-host", "botlobbies"],
 	"license": "ISC",
 	"packageManager": "bun@1.1.17",
 	"scripts": {