GriddyCode 全方位使用指南：从核心功能到个性化配置

一、核心功能模块解析

1.1 功能模块定位图

GriddyCode 的目录结构设计围绕实际开发场景展开，各模块承担明确职责：

• Lua/Plugins/：语法支持核心区，包含 py.lua（Python支持）、js.lua（JavaScript支持）等文件，为不同编程语言提供语法高亮与自动补全能力
• Lua/Themes/：视觉风格控制中心，存储 GitHub Dark.lua、Catppuccin Mocha.lua 等主题配置文件，直接影响编辑器界面呈现效果
• Tools/src/：后端功能实现区，使用 Rust 语言编写的核心逻辑代码，负责处理编辑器底层操作
• Scripts/：前端交互逻辑区，包含 editor.gd、file_manager.gd 等 Godot 脚本，控制用户界面交互行为

1.2 核心技术架构

GriddyCode 采用分层架构设计，各模块协同工作：

• 表现层：通过 Scenes/ 目录下的 .tscn 文件定义界面布局，配合 Shaders/ 目录中的着色器实现视觉效果
• 逻辑层：Scripts/ 目录下的 GDScript 脚本处理用户交互，Lua/ 目录提供语言支持和主题系统
• 核心层：Tools/ 目录的 Rust 代码提供高性能计算支持，通过 luaAPI/ 扩展实现跨语言调用

二、快速上手指南

2.1 环境准备与安装

1. 克隆项目代码库

   git clone https://gitcode.com/GitHub_Trending/gr/griddycode
   

2. 构建工具组件

   cd griddycode/Tools && cargo build --release
   

3. 配置环境变量（文字流程图）

   系统环境变量设置
        ↓
   添加工具路径：export PATH=$PATH:/path/to/griddycode/Tools/target/release
        ↓
   验证配置：gcode --version
        ↓
   显示版本信息即配置成功
   

2.2 基础操作流程

1. 启动编辑器

   gcode [文件或目录路径]  # 不指定路径则打开空编辑器
   

2. 基本文件操作

   • 新建文件：Ctrl+N（Windows/Linux）或 Cmd+N（Mac）
   • 保存文件：Ctrl+S（Windows/Linux）或 Cmd+S（Mac）
   • 打开文件对话框：通过菜单栏 File > Open 或快捷键 Ctrl+O

小贴士：首次启动时会自动加载默认主题和语言配置，可通过设置面板随时调整

三、个性化配置实践

3.1 定制主题外观

基础配置：切换内置主题

1. 打开主题选择器：Settings > Theme
2. 选择预设主题（如 Nord.lua、Tokyo Night.lua）
3. 实时预览并应用

进阶技巧：创建自定义主题

1. 在 Lua/Themes/ 目录创建新文件 my_custom_theme.lua
2. 定义主题配色方案：

   -- 基础配色设置
   local theme = {
       background = "#1e1e1e",       -- 编辑器背景色
       foreground = "#d4d4d4",       -- 文本前景色
       keyword = "#569cd6",          -- 关键字颜色
       string = "#ce9178",           -- 字符串颜色
       comment = "#6a9955",          -- 注释颜色
       function_name = "#dcdcaa",    -- 函数名颜色
       -- 更多元素配色...
   }
   return theme
   

3. 重启编辑器，在主题选择器中应用自定义主题

3.2 配置语法高亮

基础配置：启用语言支持

1. 确认 Lua/Plugins/ 目录包含对应语言的插件文件（如 py.lua 对应 Python）
2. 编辑器会自动识别文件类型并应用相应语法高亮

进阶技巧：自定义语法规则

1. 打开对应语言的插件文件（如 Lua/Plugins/js.lua）
2. 添加自定义高亮规则：

   -- 为JavaScript添加自定义关键字高亮
   highlight("async", "keyword")      -- 高亮async关键字
   highlight("await", "keyword")      -- 高亮await关键字
   highlight("import", "preprocessor")-- 将import标记为预处理器类型
   

3. 保存文件后无需重启，语法高亮会立即更新

3.3 配置快捷键

1. 打开设置文件 Scripts/settings.gd
2. 修改快捷键映射：

   # 自定义快捷键示例
   func _setup_shortcuts():
       add_shortcut("editor.save_all", KEY_MASK_CTRL + KEY_S)  # 保存所有文件
       add_shortcut("editor.format", KEY_MASK_CTRL + KEY_F)   # 格式化代码
       # 添加更多自定义快捷键...
   

3. 重启编辑器使配置生效

注意事项：修改核心配置文件（如 src/ 目录下的文件）前，建议先备份原始文件，避免因配置错误导致编辑器无法启动。