NPC-Forge README

The project's README from github.com/gioblu/NPC-Forge. As one markdown file: README.md.

NPC-Forge Discord

NPC-Forge

NPC-Forge is a framework for building conversational agents with distinct personalities, multi-turn context, sentiment analysis, and tool-call support. NPCs run on the CPU (web browser or OS) even on embedded systems and obsolete hardware without relying on machine learning or LLMs.

Instead of praying for a model to do the right thing, you can now use NPC-Forge to quickly build a deterministic agent and hook it up to your favourite workflow, API or harness.

Why NPC-Forge?

Many problems you encounter can be solved without machine-learning or LLMs. NPC-Forge gives you a way to solve those problems more efficiently:

NPC-Forge CLI

Administer, install, and run your NPCs with the following terminal commands:

npc-forge list           # Lists the installed NPCs
npc-forge test           # Run NPC-Forge test suite
npc-forge serve          # Starts OpenAi/Copilot compatible API server
npc-forge stop           # Stops server
npc-forge reboot         # Reboots server
npc-forge watch          # Starts server and watch logs in real-time
npc-forge create         # Creates new NPC using the example profile
npc-forge install <path> # Installs a new NPC

Additional information can be found in the NPC-Forge CLI documentation.

TERMy terminal assistant

TERMy is the first NPC baked into the NPC-Forge framework. It is a cynical but very knowledgeable Linux terminal assistant that translates your natural language into shell commands without a single artificial neuron. Just type termy followed by your prompt:

Terminal demonstration

You can also write a script in plain english, create a file test.termy with the following content:

search on wiki the programma 101
append it to p101.txt
open it in the browser

Then digit termy -y < test.termy and watch TERMy transpile it to a Shell script and execute it.

[!TIP] If you want to expand the capabilities of TERMy check out the dataset directory and the TERMy documentation

Quick start to redemption

Reclaim control on your workflow in less than sixty seconds:

# Clone the forge from the cloud
git clone https://github.com/gioblu/NPC-Forge.git

# Step into the forge and install it
cd NPC-Forge && chmod +x setup.sh && ./setup.sh

# Install TERMy
npc-forge install npcs/termy

# Chat with TERMy
termy how are you

Consider that this experimental release of npc-forge works only on Linux and WSL.

[!WARNING] First experimental release of NPC-Forge distributed "AS IS" without any warranty, use it at your own risk.

Documentation

Contributing to the forge

I am developing NPC-Forge with the conviction that democratic and sustainable use of Artificial Intelligence can be achieved with deterministic designs driven by curated and tested datasets crafted by the community; if you can, help me out. NPC-Forge thrives on your contributions, the community grows stronger when you:

Or are you just going to sit there waiting for the water to reach the boiling point?

The following list contains the contributors; with their support, expertise, kindness and talent NPC-Forge and TERMy are getting better by the day: Fred Larsen, Kevin Mathis, Cristiano Pizzarelli, David Starkweather, SyN-droMe, AnonymousMonkeyNo12

License

Licensed under the AGPL-3.0, feel free to contact me directly for commercial licensing options. Let's see if your corporate checkbook can purchase an exemption.

NPC-Forge (gioblu/NPC-Forge)

Searching Database…

269 ·GitHub
NPC-Forge
这是什么？NPC-Forge 是一个开源的神经符号框架，用于构建具有独特个性、多轮上下文、情感分析和工具调用支持的对话代理。它的代理运行在 CPU 上，无需机器学习，也不依赖大语言模型（LLM）。
它是供我在上面开发的框架，还是一个拿来就能用的现成助手？它是一个框架：你通过 NPC-Forge CLI 来构建和管理 NPC，并用 NDF 0.0 格式编写它们的数据集。它还内置了一个现成的助手 TERMy。
最快的上手方式是什么？在 Linux 或 WSL 上安装它，然后按照快速入门操作——README 称整个过程不到六十秒；所有操作都通过 NPC-Forge CLI 的终端命令来完成。之后只需输入 'termy' 加上你的提示词即可。
它能在 macOS 或 Windows 上运行吗？不能原生运行：当前的实验性版本只支持 Linux 和 WSL，而且按“现状”（AS IS）分发，不提供任何保证。由于代理是确定性的，它们不会产生幻觉——但也只能做到其数据集覆盖的内容。
可以免费用于商业用途吗？它采用 AGPL-3.0 许可证，因此可以免费用于开源项目；如需商业授权，作者请你直接与他联系。
作者为什么要构建确定性代理，而不使用大语言模型？他认为很多问题不用机器学习就能更高效地解决，并且 AI 的可持续、普惠的使用应来自由社区精心打磨并经过测试的数据集所驱动的确定性设计，而不是指望某个模型碰巧表现良好。
它和 NLP.js 相比怎么样？根据 README 的说法，NPC-Forge 对拼写错误、脏话、感叹词和词序颠倒的容错能力远好于 NLP.js，同时还能在 CPU 上以毫秒级速度响应。
这个项目成熟度如何？它是一个早期项目：当前版本明确标注为实验性且不提供任何保证，但已经编写了 CLI、API、FlintParser、FlintNPC、NDF 和 TCS 规范的文档，并列出了活跃的贡献者。
What are similar projects?Proteus, OpenIntelligentUI, turnstone, rasa, CopilotKit, aichat, tambo, agentscope
Which topics is it in?wsl, assistant, cpu, tool-calling, embedded-systems, lightweight, natural-language-processing, agent-framework, openai-compatible, nlp, agpl, chatbot
Creator
gioblu
Size
56.6 MB
Stars
269
Updated
CommitOct 14Release0.1Oct 07
Age
3mo
Commits · 90 Days