forbocai 0.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 +127 -0
- package/dist/index.d.mts +7 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +49 -0
- package/dist/index.mjs +24 -0
- package/package.json +22 -0
package/README.md
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
<br/>
|
|
2
|
+
<div align="center">
|
|
3
|
+
<img alt="ForbocAI logo" src="https://forbocai.github.io/logo.png" height="50" align="center">
|
|
4
|
+
|
|
5
|
+
<br/>
|
|
6
|
+
|
|
7
|
+
# ForbocAI SDK
|
|
8
|
+
|
|
9
|
+
`Systém_Óverview // Prótocol_Init`
|
|
10
|
+
|
|
11
|
+
**ᚠ ᛫ ᛟ ᛫ ᚱ ᛫ ᛒ ᛫ ᛟ ᛫ ᚲ**
|
|
12
|
+
|
|
13
|
+
Autonomous AI for game NPCs.
|
|
14
|
+
|
|
15
|
+
[](https://forbocai.docs.buildwithfern.com)
|
|
16
|
+
[](https://discord.gg/6hr2jHqnsG)
|
|
17
|
+
|
|
18
|
+
</div>
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Overview
|
|
23
|
+
|
|
24
|
+
`Córe_Módules // SDK_Init`
|
|
25
|
+
|
|
26
|
+
The **ForbocAI SDK** is a toolkit for creating autonomous AI-powered NPCs in games. It provides:
|
|
27
|
+
|
|
28
|
+
- **Local Inference** — Run quantized SLMs in your environment
|
|
29
|
+
- **Autonomous NPCs** — Create agents with persona, memory, and validated actions
|
|
30
|
+
- **Persistent Memory** — RAG pipeline for semantic recall across sessions
|
|
31
|
+
- **Portable Souls** — Export agent state to IPFS for cross-application use
|
|
32
|
+
- **Automated QA** — Ghost Agents for headless testing at scale
|
|
33
|
+
|
|
34
|
+
**᛭ ᛫ ᛬ ᛫ ᛭**
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## Installation
|
|
39
|
+
|
|
40
|
+
`Instáll_Séquence // Pácкage`
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
# JavaScript/TypeScript
|
|
44
|
+
npm install forbocai
|
|
45
|
+
|
|
46
|
+
# Python
|
|
47
|
+
pip install forbocai
|
|
48
|
+
|
|
49
|
+
# Rust
|
|
50
|
+
cargo add forbocai
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Quick Start
|
|
56
|
+
|
|
57
|
+
`Quíck_Stárt // Éxample`
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
import { Cortex, Agent } from 'forbocai';
|
|
61
|
+
|
|
62
|
+
// Córtex_Init // Loćal_Inférence
|
|
63
|
+
const cortex = await Cortex.init({ model: 'smollm2-135m' });
|
|
64
|
+
|
|
65
|
+
// Agént_Créate // NPC_Entíty
|
|
66
|
+
const npc = await Agent.create({
|
|
67
|
+
cortex,
|
|
68
|
+
persona: 'A suspicious merchant who was once cheated by adventurers.',
|
|
69
|
+
state: { inventory: ['rusty_key', 'healing_potion'], mood: 'suspicious' }
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
// Prócéss_Ínput // Dïalógue
|
|
73
|
+
const response = await npc.process({
|
|
74
|
+
input: 'I want to buy a healing potion.',
|
|
75
|
+
context: { playerGold: 50 }
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
console.log(response.dialogue);
|
|
79
|
+
// "Hmm, you have the coin... but how do I know you won't just take it and run?"
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## Core Modules
|
|
85
|
+
|
|
86
|
+
`Módulátion_Máp // Sýstem_Óverview`
|
|
87
|
+
|
|
88
|
+
| Module | Description |
|
|
89
|
+
|--------|-------------|
|
|
90
|
+
| **Cortex** | Local SLM inference engine |
|
|
91
|
+
| **Agent** | Autonomous entities with persona, state, memory |
|
|
92
|
+
| **Memory** | RAG pipeline for persistent semantic recall |
|
|
93
|
+
| **Bridge** | Neuro-symbolic action validation |
|
|
94
|
+
| **Soul** | Portable agent state (IPFS/ERC-7007) |
|
|
95
|
+
| **Ghost** | Headless QA testing at scale |
|
|
96
|
+
|
|
97
|
+
---
|
|
98
|
+
|
|
99
|
+
## Documentation
|
|
100
|
+
|
|
101
|
+
`Dócs_Máp // Référence`
|
|
102
|
+
|
|
103
|
+
- **[Introduction](https://forbocai.docs.buildwithfern.com)** — SDK overview and quick start
|
|
104
|
+
- **[User Stories](https://forbocai.docs.buildwithfern.com/user-stories)** — BDD specifications for all features
|
|
105
|
+
- **[Concepts](https://forbocai.docs.buildwithfern.com/concepts)** — Architecture and core abstractions
|
|
106
|
+
- **[API Reference](https://forbocai.docs.buildwithfern.com/api-reference)** — Complete endpoint documentation
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## Links
|
|
111
|
+
|
|
112
|
+
`Éxternal_Líns // Cónnect`
|
|
113
|
+
|
|
114
|
+
- **Website:** [forbocai.github.io](https://forbocai.github.io)
|
|
115
|
+
- **Documentation:** [forbocai.docs.buildwithfern.com](https://forbocai.docs.buildwithfern.com)
|
|
116
|
+
- **Discord:** [discord.gg/6hr2jHqnsG](https://discord.gg/6hr2jHqnsG)
|
|
117
|
+
- **Telegram:** [t.me/forbocai](https://t.me/forbocai)
|
|
118
|
+
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
**ᚠ ᛫ ᛟ ᛫ ᚱ ᛫ ᛒ ᛫ ᛟ ᛫ ᚲ**
|
|
122
|
+
|
|
123
|
+
## License
|
|
124
|
+
|
|
125
|
+
`Légal_Státus // Ríghts`
|
|
126
|
+
|
|
127
|
+
All rights reserved. © 2026 ForbocAI
|
package/dist/index.d.mts
ADDED
package/dist/index.d.ts
ADDED
package/dist/index.js
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __defProp = Object.defineProperty;
|
|
3
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
4
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
5
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __copyProps = (to, from, except, desc) => {
|
|
11
|
+
if (from && typeof from === "object" || typeof from === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(from))
|
|
13
|
+
if (!__hasOwnProp.call(to, key) && key !== except)
|
|
14
|
+
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return to;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
19
|
+
|
|
20
|
+
// src/index.ts
|
|
21
|
+
var index_exports = {};
|
|
22
|
+
__export(index_exports, {
|
|
23
|
+
init: () => init
|
|
24
|
+
});
|
|
25
|
+
module.exports = __toCommonJS(index_exports);
|
|
26
|
+
var init = () => {
|
|
27
|
+
const reset = "\x1B[0m";
|
|
28
|
+
const cyan = "\x1B[36m";
|
|
29
|
+
const blue = "\x1B[34m";
|
|
30
|
+
const dim = "\x1B[2m";
|
|
31
|
+
const bold = "\x1B[1m";
|
|
32
|
+
const runes = "\u16A0 \u16EB \u16DF \u16EB \u16B1 \u16EB \u16D2 \u16EB \u16DF \u16EB \u16B2";
|
|
33
|
+
const border = `${dim}----------------------------------------${reset}`;
|
|
34
|
+
console.log(`
|
|
35
|
+
${border}
|
|
36
|
+
${cyan}${bold}FORBOC AI SDK${reset} ${dim}v0.0.1${reset}
|
|
37
|
+
${blue}${runes}${reset}
|
|
38
|
+
${border}
|
|
39
|
+
${dim}> Initializing Cortex...${reset}
|
|
40
|
+
${dim}> Connecting into the Neuro-Symbolic Grid...${reset}
|
|
41
|
+
${dim}> Status: ${cyan}ONLINE${reset}
|
|
42
|
+
|
|
43
|
+
${cyan}Welcome to the Future of NPC Intelligence.${reset}
|
|
44
|
+
`);
|
|
45
|
+
};
|
|
46
|
+
// Annotate the CommonJS export names for ESM import in node:
|
|
47
|
+
0 && (module.exports = {
|
|
48
|
+
init
|
|
49
|
+
});
|
package/dist/index.mjs
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
// src/index.ts
|
|
2
|
+
var init = () => {
|
|
3
|
+
const reset = "\x1B[0m";
|
|
4
|
+
const cyan = "\x1B[36m";
|
|
5
|
+
const blue = "\x1B[34m";
|
|
6
|
+
const dim = "\x1B[2m";
|
|
7
|
+
const bold = "\x1B[1m";
|
|
8
|
+
const runes = "\u16A0 \u16EB \u16DF \u16EB \u16B1 \u16EB \u16D2 \u16EB \u16DF \u16EB \u16B2";
|
|
9
|
+
const border = `${dim}----------------------------------------${reset}`;
|
|
10
|
+
console.log(`
|
|
11
|
+
${border}
|
|
12
|
+
${cyan}${bold}FORBOC AI SDK${reset} ${dim}v0.0.1${reset}
|
|
13
|
+
${blue}${runes}${reset}
|
|
14
|
+
${border}
|
|
15
|
+
${dim}> Initializing Cortex...${reset}
|
|
16
|
+
${dim}> Connecting into the Neuro-Symbolic Grid...${reset}
|
|
17
|
+
${dim}> Status: ${cyan}ONLINE${reset}
|
|
18
|
+
|
|
19
|
+
${cyan}Welcome to the Future of NPC Intelligence.${reset}
|
|
20
|
+
`);
|
|
21
|
+
};
|
|
22
|
+
export {
|
|
23
|
+
init
|
|
24
|
+
};
|
package/package.json
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "forbocai",
|
|
3
|
+
"version": "0.0.1",
|
|
4
|
+
"description": "The Infrastructure Layer for Autonomous AI Characters",
|
|
5
|
+
"main": "dist/index.js",
|
|
6
|
+
"module": "dist/index.mjs",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
8
|
+
"scripts": {
|
|
9
|
+
"build": "tsup src/index.ts --format cjs,esm --dts",
|
|
10
|
+
"dev": "tsup src/index.ts --watch",
|
|
11
|
+
"test": "echo 'No tests yet'"
|
|
12
|
+
},
|
|
13
|
+
"devDependencies": {
|
|
14
|
+
"tsup": "^8.0.0",
|
|
15
|
+
"typescript": "^5.0.0"
|
|
16
|
+
},
|
|
17
|
+
"files": [
|
|
18
|
+
"dist",
|
|
19
|
+
"README.md",
|
|
20
|
+
"package.json"
|
|
21
|
+
]
|
|
22
|
+
}
|