# AI_apartment

**Repository Path**: QWERTYUIOP233/ai_apartment

## Basic Information

- **Project Name**: AI_apartment
- **Description**: 受23年斯坦福小镇项目启发，由werehouse团队开发的AI小镇模拟系统。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-09
- **Last Updated**: 2025-06-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 系统安装手册

## 引言

本手册旨在为系统管理员和开发人员提供详细的指导，帮助他们安装和配置本“人工社会”模拟系统，适用于具备基本计算机操作技能和一定编程基础的用户。本文档内容涵盖了安装前的准备工作、具体的安装步骤、系统的配置，以及常见问题的解决方案等，旨在确保用户能够顺利地完成系统的安装与部署。

## 系统概述

### 系统功能简介

本系统是一个基于多 Agent 技术的“人工社会”模拟系统，通过大语言模型（LLM）驱动多个 Agent 在公寓环境中进行自主活动。系统支持 Agent 在不同房间中执行预定义行为，并实时展示其活动状态，可用于研究多 Agent 行为模式和人机交互可视化。

### 系统架构简述

本系统采用前后端分离架构：

- **前端**：基于 Godot 引擎实现，负责展示 Agent 的活动状态和用户界面交互。
- **后端**：使用 Python 开发，负责 Agent 的行为决策和数据管理。
- **中间件**：基于 Flask 框架，实现前后端之间的通信和数据交互。
```bash
ai_apartment/
├── frontend/                    # 前端（Godot 项目文件）
│   ├── ai_apartment.exe       
│   └── ai_apartment.pck         

├── back/                    # 后端服务
│   ├── activities/             # 预设活动列表
│   ├── charcaters/             # 任务设定
│   ├── src/                    # 核心业务逻辑
│   ├── tests/                  # 单元测试
│   └── system_tests/           # 系统测试

├── middleware/                        # 公共配置和中间逻辑层
│   ├── ActionData.py           # 活动数据类
│   ├── AgentEnum.py            # 人物映射
│   ├── DataManager.py          # 数据管理器
│   └── FileReader.py           # 文件读取管理器       

├── log                         # 人物历史行为记录
├── request.txt                 # 系统所需依赖列表
├── README.md                   # 项目说明文档
├── main.py                     # 后端服务入口
├── .gitignore                  # Git 忽略配置
└── server.py                   # 中间件服务入口
```

## 安装前的准备

- **硬件要求**：
  - 推荐配置：CPU 4 核以上，内存 8GB 以上，磁盘空间 10GB 以上。
- **软件依赖**：
  - 操作系统：Windows 10 及以上版本
  - Python：3.8 及以上版本
  - Git
- **权限要求**：
  - 管理员权限

## 安装步骤

### 安装顺序说明

1. 安装 Python  
2. 安装 Git  
3. 从 Gitee 拉取代码  
4. 安装 Python 依赖  
5. 配置环境变量  

### 安装 Python

1. 访问 [Download Python | Python.org](https://www.python.org/downloads/)
2. 下载并安装 Python 3.8 及以上版本
3. 安装过程中，确保勾选 “Add Python to PATH” 选项，以便将 Python 添加到系统环境变量中

### 安装 Git

1. 访问 [Git - Downloads](https://git-scm.com/downloads)
2. 下载并安装 Git
3. 安装完成后，打开命令提示符或终端，运行命令 `git --version` 以验证 Git 是否安装成功；如果显示 Git 版本信息，则表示安装成功

### 从 Gitee 拉取代码

1. 打开命令提示符或终端  
2. 创建一个目录用于存放项目代码  
3. 运行命令 `git clone https://gitee.com/QWERTYUIOP233/ai_apartment.git` 克隆项目代码  

### 安装 Python 依赖

1. 进入项目目录  
2. 运行命令 `pip install -r request.txt` 安装项目依赖  

> 注：如果系统中未安装 pip，可以通过命令 `python -m ensurepip --upgrade` 安装  

### 配置环境变量

1. 右键点击“此电脑”或“我的电脑”，选择“属性”  
2. 点击“高级系统设置”  
3. 在“系统属性”窗口中，点击“环境变量”  
4. 在“系统变量”区域，点击“新建”  
5. 输入变量名 `MOONSHOT_API_KEY`，变量值为你的 OpenAI API 密钥  

## 系统配置

- 如果需要修改系统配置，可以编辑项目目录下的 `src/backend/config/settings.py` 文件
- 常见配置项包括：
  - `API_BASE_URL`：OpenAI 服务的基础 URL
  - `START_TIME`：系统启动的初始时间
  - `ACTIVITY_DURATION`：每个活动的时间步长

## 常见问题与解决方案

- **无法安装 Python 依赖**：
  - 确保 pip 版本为最新。运行命令 `python -m pip install --upgrade pip` 更新 pip

- **环境变量未生效（运行报错显示“请设置环境变量 MOONSHOT_API_KEY”）**：
  - 确保环境变量已正确添加到系统环境变量中，可以通过“系统属性”中的“环境变量”查看