Welcome to the AGENTARTEL monorepo! This repository houses the interconnected projects that power "Fractal of You," an introspective RPG experience.
AGENTARTEL combines a player-facing RPGJS game (ARTELIO) with a powerful AI backend (Agent-artel-Dock). Agent-artel-Dock acts as a central hub for AI capabilities, providing services that ARTELIO consumes to bring its world and characters to life. The core concept, "Fractal of You," invites players into the world of Artelio to explore themes of self-discovery through interaction with AI-driven characters and the collection and processing of unique 'media fragments.'
This monorepo structure facilitates unified development, version control, and management of both critical components.
This repository contains the followin 96AF g primary projects:
ARTELIO/: The frontend RPG game built with RPGJS. This is where players will explore the world, interact with NPCs, and experience the narrative of "Fractal of You." It interfaces withAgent-artel-Dockfor dynamic AI-driven content and interactions.Agent-artel-Dock/: The backend AI agent and services hub. This Node.js application, built with Next.js and pnpm, provides the AI-driven dialogue, dynamic content generation, and other intelligent services. It manages connections to various AI models (e.g., OpenAI, Anthropic) and other external services, configured via its own environment variables.
The primary goal of this monorepo is to streamline the development and deployment of the "Fractal of You" experience by:
- Maintaining both the game client and AI backend under a single version control system.
- Simplifying dependency management and build processes.
- Ensuring consistent development practices across both projects.
- Node.js (LTS version recommended -
Agent-artel-Dockrequiresv20.11.0or higher) - Git
- pnpm (for
Agent-artel-Dock- version9.15.0or higher specified)
git clone https://github.com/AgentArtel/AGENTARTEL.git
cd AGENTARTELEach project within this monorepo has its own dependencies and setup steps:
-
ARTELIO (RPGJS Game):
cd ARTELIO npm install # Create a .env file in this directory (ARTELIO/.env). # Populate it with necessary environment variables, primarily the base URL # for your local Agent-artel-Dock instance (e.g., AGENT_DOCK_BASE_URL=http://localhost:3001). # Other specific configurations for ARTELIO can also be placed here. cd ..
-
Agent-artel-Dock (AI Backend):
cd Agent-artel-Dock pnpm install # This will also run a postinstall script to set up 'agentdock-core'. # Copy .env.example to .env and populate with necessary API keys (e.g., OpenAI, Anthropic) # and other configurations for the AI services it provides. cd ..
Both projects need to be run separately, typically in different terminal sessions.
-
To run
ARTELIO:cd ARTELIO npm run devThe game should then be accessible in your browser, usually at
http://localhost:3000. EnsureAgent-artel-Dockis running andARTELIOis configured with the correct URL to reach it. -
To run
Agent-artel-Dock:cd Agent-artel-Dock pnpm run devThis command will also execute pre-development scripts for bundling templates and building
agentdock-core. The backend services will then be available, typically on a different port (e.g.,http://localhost:3001or as configured).
Important Note on Environment Variables: Both projects rely heavily on environment variables.
- For
ARTELIO/, create a.envfile. The most critical variable will be the one specifying the URL for yourAgent-artel-Dockbackend. - For
Agent-artel-Dock/, copyAgent-artel-Dock/.env.exampletoAgent-artel-Dock/.envand fill in your API keys and other configurations for the AI models and services it uses. - These
.envfiles are ignored by Git (as per.gitignore) to protect sensitive information. - For general guidance on setting up environment variables, you can refer to the workflow:
/setup-environment-variables.
- Game Engine: RPGJS (v4.3.0+)
- Programming Language: TypeScript
- Backend Framework: Node.js, Next.js (for Agent-artel-Dock)
- Package Management: npm (for ARTELIO), pnpm (for Agent-artel-Dock)
- AI Integration:
ARTELIOcommunicates withAgent-artel-Dock, which in turn integrates with various AI models (e.g., OpenAI, Anthropic) and external services.
This repository utilizes development workflows managed by Cascade, located in the .windsurf/workflows/ directory. These workflows provide step-by-step instructions for common tasks such as creating new AI NPCs, managing GUI components, and more. You can ask Cascade to list or run these workflows.
This README provides a starting point. Feel free to expand it with more details about specific features, contribution guidelines, or deployment processes as the project evolves.