Help

概况

1. 项目地址：https://github.com/21ess/graffiti
2. 项目 wiki 地址：https://github.com/21ess/graffiti/wiki
3. 资源 cos 地址：https://cosbrowser.cloud.tencent.com/web/file?bucket=resource-graffiti-1318385221&region=ap-beijing （腾讯云 cos 服务）

注意

1. github 仓库和 cos 服务均需要 @moderator 申请权限喵
2. 代码仓库不允许直接推送 main 分支，main 分支原则上保持为可直接运行的稳定版本
3. wiki 仓库通过不同文件来隔离，比如玩法设计说明(GDD)仅由策划修改，美术风格指南(ASG) 仅由美术修改，不要修改他人的内容
4. 文档编写采用 markdown 语法
5. godot 版本 4.x 及以上

Help（TODO）

面向非程序同学的帮助文档

为了统一资源管理，代码仓库和资源仓库均放在网络上，而不是本地。

CosBrowser（桌面客户端/网页访问）

作用: 仅用来做文件存储，存储大文件，如原画/素材等

访问 CosBrowser，提供下载、上传、新建文件夹等功能

github

作用: 存储项目代码，项目 wiki ，管理项目版本（作用类似“时光机”）

• code：项目文件目录

  

• issue：留言板和任务清单，用来沟通和记录，可以理解为“便利贴墙”。

  可以通过 Label 来分类

  • bug：发现一个存在的问题，比如 UI 的错位
  • enhancement：添加一个新的功能

  

• wiki：项目的百科，用于编写长篇文档。比如游戏玩法说明（GDD），美术风格说明（ASG）。

  • wiki 是一个独立的仓库，所以可以 git clone https://github.com/21ess/graffiti.wiki.git ，然后在本地修改后推送到远端
  • 也可以在网页直接修改

  

github desktop （git 客户端）

github 是一个网站，这是一个软件，用于管理本地的仓库（时光机）

下载地址

操作流程：

拉取远程仓库（也就是 github 的代码仓库和 wiki 仓库）

1. 点击 Current Repository 按钮
2. 点击 Add下的 Clone ，选择好 Local path

切换/创建自己的分支（不影响其他人的工作， TODO）

1. 点击 Current Branch

修改内容后推送到远程仓库

1. 在 change files区域勾选你要推送的文件（全选即可）
2. 在下面的框框中，简单描述本次的修改，如doc: update readme（中英文皆可）
3. 点击 Commit 1 file to main
4. 点击 fetch origin，点击 Pull origin
5. 点击 Push origin


更新远程仓库（仓库一直在更新，希望看到最新的内容）

1. 点击 Fetch origin
2. 点击 Pull origin

clash verge （vpn）

作用：一个外网的梯子软件，用于访问 github，discord 等

godot

作用：项目的游戏引擎

markdown

教程

作用：用于文档编写（比如本文）

软件推荐

部分软件，后续补充到 cos 资源库