333 lines
8.1 KiB
Markdown
333 lines
8.1 KiB
Markdown
# NexusLauncher
|
||
|
||
[English](README.md) | [简体中文](README_CN.md)
|
||
|
||
一个强大且直观的桌面应用程序，专为简化艺术家工作流程而设计，通过管理项目、组织任务文件夹和高效启动创意应用程序来提升工作效率。
|
||
|
||
---
|
||
|
||
## ✨ 功能特性
|
||
|
||
### 🎨 项目管理
|
||
- **多项目支持**：无缝切换多个项目
|
||
- **项目个性化**：使用自定义图标和颜色个性化每个项目
|
||
- **自动保存配置**：所有设置自动保存
|
||
|
||
### 📁 任务管理
|
||
- **7种预设模板**：角色、武器、道具、环境、动画、绑定和其他
|
||
- **可视化节点编辑器**：可视化创建和自定义文件夹结构
|
||
- **一键创建**：即时生成标准化文件夹层次结构
|
||
|
||
### 🚀 应用启动器
|
||
- **快速启动**：快速访问您喜欢的创意应用程序
|
||
- **图标缩放**：使用 `Ctrl + 鼠标滚轮` 调整图标大小
|
||
- **拖放排序**：轻松重新排序应用程序
|
||
|
||
### 🔧 插件系统
|
||
- **Maya 集成**：支持 Maya 2023+ 的自定义插件
|
||
- **Substance Painter**：内置启动器集成
|
||
- **可扩展**：易于添加自定义插件
|
||
|
||
---
|
||
|
||
## 📋 目录
|
||
|
||
- [功能特性](#-功能特性)
|
||
- [安装](#-安装)
|
||
- [快速开始](#-快速开始)
|
||
- [使用指南](#-使用指南)
|
||
- [项目管理](#项目管理)
|
||
- [任务管理](#任务管理)
|
||
- [应用管理](#应用管理)
|
||
- [项目结构](#-项目结构)
|
||
- [配置](#-配置)
|
||
- [文档](#-文档)
|
||
- [系统要求](#-系统要求)
|
||
- [快捷键](#-快捷键)
|
||
- [从源码构建](#-从源码构建)
|
||
- [致谢](#-致谢)
|
||
|
||
---
|
||
|
||
## 🚀 安装
|
||
|
||
### 方式 1：独立可执行文件
|
||
1. 从发布页面下载 `NexusLauncher.exe`
|
||
2. 解压到您喜欢的目录
|
||
3. 运行 `NexusLauncher.exe`
|
||
|
||
### 方式 2：从源码运行
|
||
1. 克隆仓库：
|
||
```bash
|
||
git clone https://github.com/Jeffreytsai1004/NexusLauncher
|
||
cd NexusLauncher
|
||
```
|
||
|
||
2. 安装依赖：
|
||
```bash
|
||
pip install -r requirements.txt
|
||
```
|
||
|
||
3. 运行应用程序：
|
||
```bash
|
||
python main.py
|
||
```
|
||
|
||
---
|
||
|
||
## ⚡ 快速开始
|
||
|
||
### 1️⃣ 添加您的应用程序
|
||
```
|
||
主窗口 → ⚙ 设置 → + 添加应用
|
||
```
|
||
|
||
填写详细信息：
|
||
- **名称**：Maya 2025
|
||
- **路径**：`C:\Program Files\Autodesk\Maya2025\bin\maya.exe`
|
||
- **版本**：2025.1
|
||
|
||
### 2️⃣ 创建项目
|
||
```
|
||
设置窗口 → 新建项目 → 输入项目名称
|
||
```
|
||
|
||
建议命名：
|
||
- `Character_角色名称`
|
||
- `Environment_场景名称`
|
||
- `Weapon_武器名称`
|
||
|
||
### 3️⃣ 创建任务文件夹
|
||
```
|
||
Task 标签页 → 选择任务类型 → 设置工作空间 → Create Task Folder
|
||
```
|
||
|
||
### 4️⃣ 启动应用程序
|
||
```
|
||
Project 标签页 → 点击应用图标
|
||
```
|
||
|
||
💡 **提示**：使用 `Ctrl + 鼠标滚轮` 调整图标大小
|
||
|
||
---
|
||
|
||
## 📖 使用指南
|
||
|
||
### 项目管理
|
||
|
||
#### 创建项目
|
||
- 导航到设置（`⚙` 图标）
|
||
- 点击"新建项目"
|
||
- 输入描述性项目名称
|
||
- 使用图标和颜色进行自定义
|
||
|
||
#### 切换项目
|
||
- 使用顶部下拉菜单
|
||
- 键盘快捷键：`Ctrl + Tab`
|
||
- 所有设置自动保存
|
||
|
||
#### 项目操作
|
||
| 操作 | 描述 |
|
||
|------|------|
|
||
| **新建** | 创建新项目 |
|
||
| **复制** | 复制现有项目 |
|
||
| **重命名** | 修改项目名称 |
|
||
| **删除** | 删除项目 |
|
||
| **图标** | 设置自定义图标 |
|
||
| **颜色** | 选择主题颜色 |
|
||
|
||
### 任务管理
|
||
|
||
#### 可用模板
|
||
|
||
| 模板 | 使用场景 |
|
||
|------|----------|
|
||
| **Character** | 角色制作 |
|
||
| **Weapon** | 武器建模 |
|
||
| **Prop** | 道具资产 |
|
||
| **Environment** | 环境艺术 |
|
||
| **Animation** | 动画制作 |
|
||
| **Rigging** | 角色绑定 |
|
||
| **Other** | 自定义任务 |
|
||
|
||
#### 角色模板结构
|
||
```
|
||
TaskFolder_Character_001/
|
||
├── Reference/ # 参考资料
|
||
├── MP/ # 中精度建模
|
||
├── HP/ # 高精度雕刻
|
||
├── LP/ # 低精度建模
|
||
├── Baking/ # 烘焙流程
|
||
├── Texture/ # 贴图制作
|
||
├── FBX/ # 最终导出
|
||
└── Screenshot/ # 展示图片
|
||
```
|
||
|
||
#### SubFolder Editor（节点编辑器）
|
||
|
||
| 操作 | 快捷键 | 功能 |
|
||
|------|--------|------|
|
||
| **移动节点** | 拖拽 | 重新定位 |
|
||
| **重命名** | `F2` | 重命名节点 |
|
||
| **删除** | `Delete` | 删除节点 |
|
||
| **复制** | `Ctrl + D` | 复制节点 |
|
||
| **添加子节点** | 右键菜单 | 添加子文件夹 |
|
||
| **缩放** | `Ctrl + 鼠标滚轮` | 缩放视图 |
|
||
| **平移** | 中键拖拽 | 移动视图 |
|
||
| **居中** | `Home` | 居中显示 |
|
||
| **保存** | `Ctrl + S` | 保存结构 |
|
||
|
||
### 应用管理
|
||
|
||
#### 添加应用程序
|
||
```
|
||
⚙ 设置 → + 添加应用 → 填写详细信息 → 保存
|
||
```
|
||
|
||
**必填信息**：
|
||
- **名称**：应用程序显示名称
|
||
- **路径**：可执行文件完整路径
|
||
- **版本**：版本号（可选）
|
||
|
||
#### 常用应用程序路径
|
||
|
||
| 软件 | 默认路径 |
|
||
|------|---------|
|
||
| **Maya 2025** | `C:\Program Files\Autodesk\Maya2025\bin\maya.exe` |
|
||
| **Blender** | `C:\Program Files\Blender Foundation\Blender 4.2\blender.exe` |
|
||
| **ZBrush** | `C:\Program Files\Maxon\ZBrush 2025\ZBrush.exe` |
|
||
| **Substance Painter** | `C:\Program Files\Adobe\Adobe Substance 3D Painter\...` |
|
||
| **Photoshop** | `C:\Program Files\Adobe\Adobe Photoshop 2025\Photoshop.exe` |
|
||
| **Unreal Engine** | `C:\Program Files\Epic Games\UE_5.4\Engine\Binaries\Win64\UnrealEditor.exe` |
|
||
|
||
---
|
||
|
||
## 📂 项目结构
|
||
|
||
```
|
||
NexusLauncher/
|
||
├── main.py # 主应用程序入口
|
||
├── requirements.txt # Python 依赖
|
||
├── build.bat # 构建脚本
|
||
├── Run.bat # 运行脚本
|
||
├── config/ # 配置模块
|
||
│ ├── config_manager.py # 配置管理
|
||
│ ├── constants.py # 应用常量
|
||
│ └── icon_config.py # 图标配置
|
||
├── ui/ # 用户界面
|
||
│ ├── project/ # 项目面板
|
||
│ ├── task/ # 任务面板
|
||
│ └── utilities/ # UI 工具
|
||
├── plugins/ # 插件系统
|
||
│ ├── maya.py # Maya 集成
|
||
│ └── substancepainter/ # Substance Painter 插件
|
||
├── icons/ # 应用程序图标
|
||
└── docs/ # 文档
|
||
├── ARTIST_GUIDE.md # 用户指南（中文）
|
||
└── CUSTOM_PLUGIN_GUIDE.md # 插件开发指南
|
||
```
|
||
|
||
---
|
||
|
||
## ⚙️ 配置
|
||
|
||
应用程序将所有设置存储在应用程序目录中的 `config.json` 文件中。
|
||
|
||
### 配置结构
|
||
```json
|
||
{
|
||
"projects": [
|
||
{
|
||
"name": "Project_01",
|
||
"icon": "path/to/icon.png",
|
||
"color": "#FF5733"
|
||
}
|
||
],
|
||
"applications": [
|
||
{
|
||
"name": "Maya 2025",
|
||
"path": "C:/Program Files/Autodesk/Maya2025/bin/maya.exe",
|
||
"version": "2025.1"
|
||
}
|
||
]
|
||
}
|
||
```
|
||
|
||
### 备份配置
|
||
只需备份 `config.json` 文件即可保留所有设置。
|
||
|
||
---
|
||
|
||
## 📚 文档
|
||
|
||
- **[艺术家指南](docs/ARTIST_GUIDE.md)** - 综合用户指南（中文）
|
||
- **[自定义插件指南](docs/CUSTOM_PLUGIN_GUIDE.md)** - Maya 插件开发指南（中文）
|
||
|
||
---
|
||
|
||
## 💻 系统要求
|
||
|
||
### 最低要求
|
||
- **操作系统**：Windows 10 或更高版本
|
||
- **内存**：4GB
|
||
- **存储空间**：100MB 可用空间
|
||
- **Python**：3.8+（如果从源码运行）
|
||
|
||
### 推荐配置
|
||
- **操作系统**：Windows 11
|
||
- **内存**：8GB 或更多
|
||
- **显示器**：1920x1080 分辨率
|
||
- **Python**：3.10+
|
||
|
||
---
|
||
|
||
## ⌨️ 快捷键
|
||
|
||
| 快捷键 | 功能 |
|
||
|--------|------|
|
||
| `Ctrl + Tab` | 切换项目 |
|
||
| `Ctrl + 鼠标滚轮` | 缩放图标/视图 |
|
||
| `Ctrl + 点击` | 多选 |
|
||
| `Delete` | 删除选中项 |
|
||
| `Escape` | 取消选择 |
|
||
| `F2` | 重命名 |
|
||
| `Ctrl + D` | 复制 |
|
||
| `Ctrl + S` | 保存 |
|
||
| `Home` | 居中视图 |
|
||
| `中键拖拽` | 平移视图 |
|
||
|
||
---
|
||
|
||
## 🛠️ 从源码构建
|
||
|
||
### 要求
|
||
- Python 3.8+
|
||
- `requirements.txt` 中的所有依赖
|
||
|
||
### 构建步骤
|
||
1. 安装依赖：
|
||
```bash
|
||
pip install -r requirements.txt
|
||
```
|
||
|
||
2. 运行构建脚本：
|
||
```bash
|
||
build.bat
|
||
```
|
||
|
||
3. 在 `dist/` 目录中找到可执行文件
|
||
|
||
---
|
||
|
||
## 🙏 致谢
|
||
|
||
- 使用 [CustomTkinter](https://github.com/TomSchimansky/CustomTkinter) 构建
|
||
- 图标来自各种开源项目
|
||
- 特别感谢所有贡献者
|
||
|
||
---
|
||
|
||
**NexusLauncher** - 让艺术家的项目管理更简单 🚀
|
||
|
||
*版本 1.2.0 | 更新时间：2025年11月*
|