diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..b943b19 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,22 @@ +name: Publish docs via GitHub Pages +on: + push: + branches: + - ng + +jobs: + build: + name: Deploy docs + runs-on: ubuntu-latest + steps: + - name: Checkout ng + uses: actions/checkout@v4 + with: + ref: ng + + - name: Deploy docs + uses: mhausenblas/mkdocs-deploy-gh-pages@master + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + CONFIG_FILE: docs/mkdocs.yml + # GITHUB_DOMAIN: github.myenterprise.com diff --git a/docs/docs/imgs/config-plugin.png b/docs/docs/imgs/config-plugin.png new file mode 100644 index 0000000..14f15ba Binary files /dev/null and b/docs/docs/imgs/config-plugin.png differ diff --git a/docs/docs/zh-cn/compile-distribute-plugin.md b/docs/docs/zh-cn/compile-distribute-plugin.md new file mode 100644 index 0000000..7512f20 --- /dev/null +++ b/docs/docs/zh-cn/compile-distribute-plugin.md @@ -0,0 +1,3 @@ +# 编译与分发插件 + + diff --git a/docs/docs/zh-cn/configure-plugin.md b/docs/docs/zh-cn/configure-plugin.md new file mode 100644 index 0000000..27c25aa --- /dev/null +++ b/docs/docs/zh-cn/configure-plugin.md @@ -0,0 +1,29 @@ +# 配置插件 + +!!! info "必须先配置插件" + BBP插件的部分配置项与插件的使用密切相关,只有正确配置了BBP插件,才能够使用BBP插件的全部功能。 + + **无论是第一次安装还是更新**,都要重新配置插件,以确保设置正确。 + +## 打开配置面板 + +开启Blender,选择`编辑 - 偏好设置`,在打开的窗口中转到`插件`选项卡,在`社区`分类下找到BBP插件,名称为`Object: Ballance Blender Plugin`。请确保其左侧的勾已被选中,代表插件已被启用。点击勾左侧的三角箭头展开插件详细信息,如图所示,进入配置面板。 + +![](../imgs/config-plugin.png) + +## 开始配置 + +BBP插件目前有2个设置需要配置。 + +### External Texture Folder + +请填写为Ballance的`Texture`目录,插件将从此目录下调用外置贴图文件(即Ballance原本带有的贴图文件)。点击右侧的文件夹按钮可以浏览文件夹并选择。 + +这是关乎BBP是否正常运行的关键,只有填写正确,BBP才不会在运行中出错。 + +### No Component Collection + +在导入导出BM文件时,处于具有此名称的集合中的物体将被强制指定为非Component。如果留空则表示不需要这个功能。此功能通常用于机关模型强制替换。 + +!!! warning "暂不需填写此设置" + 由于BBP自4.0版本起,支持对Virtools文件的原生导入导出,BM文件导入导出功能便不再使用。因此此字段现已无实际作用,无需填写。 diff --git a/docs/docs/zh-cn/index.md b/docs/docs/zh-cn/index.md index 26cc44c..bf38451 100644 --- a/docs/docs/zh-cn/index.md +++ b/docs/docs/zh-cn/index.md @@ -13,8 +13,8 @@ Ballance Blender Plugin(后文简称BBP)是一款关注Ballance自制地图 ## 入门 -* 安装插件 -* 配置插件 +* [安装插件](./install-plugin.md) +* [配置插件](./configure-plugin.md) ## 基础 @@ -28,7 +28,8 @@ Ballance Blender Plugin(后文简称BBP)是一款关注Ballance自制地图 ## 进阶 -* 编译与分发插件 +* [编译与分发插件](./compile-distribute-plugin.md) +* [技术信息](./tech-infos.md) !!! info "这些并不是全部" 本手册只记录有关此插件的相关操作,并不会在此说明如何制作一份Ballance地图。如需详细了解如何利用Blender和BBP制作Ballance地图,请在Bilibili或YouTube上搜索相关内容。 diff --git a/docs/docs/zh-cn/install-plugin.md b/docs/docs/zh-cn/install-plugin.md new file mode 100644 index 0000000..082bdb1 --- /dev/null +++ b/docs/docs/zh-cn/install-plugin.md @@ -0,0 +1,47 @@ +# 安装插件 + +## 明确版本 + +BBP对Blender支持的原则是支持当前最新的 **LTS** 版本,在最新的LTS版本释出之后会花一些时间迁移插件。当前插件版本 **4.0**,基于Blender **3.6.x** 版本。 + +理论上而言,如果Blender没有做出重大改动,那么BBP可以在其它版本上正常运行。例如你可以尝试在Blender 4.0上运行基于Blender 3.6的BBP插件。但BBP的开发者不会处理仅在非LTS版本中才出现的Bug。在安装插件之前,请先选择适合的版本。 + +## 卸载旧插件 + +如果您之前使用过BBP,那么您需要首先卸载它。旧版的BBP通常被安装在下列的位置中: + +* `Blender/3.6/scripts/addons/ballance_blender_plugin` +* `Blender/3.6/scripts/addons_contrib/ballance_blender_plugin` +* `Blender/3.6/scripts/addons/bbp_ng` + +您只需要删除这些文件夹(如果它们存在的话)即可完全卸载插件。路径中的`Blender`指代您的Blender安装位置。路径中的`3.6`是您安装的Blender的版本号,需要根据您安装的版本进行调整,本手册均以`3.6`为例。 + +!!! info "`ballance_blender_plugin`和`bbp_ng`" + `ballance_blender_plugin`是旧版BBP插件(4.0版本前)的模块名,`bbp_ng`是新版BBP插件(4.0版本后,包括4.0版本)的模块名。为了保证用户确实删除了旧版插件,所以同时提供了这两者。 + +!!! info "`addons`和`addons_contrib`" + 在Blender 3.6 LTS版本,即BBP 3.3版本之后,Blender不再支持Testing类型插件。因而导致安装Testing插件专用的`addons_contrib`文件夹不再使用,插件需要被统一安装在`addons`中。为了保证用户确实删除了旧版插件,所以同时提供了这两者。 + +## 下载插件 + +您可以通过[本工程的GitHub代码库的Release页面](https://github.com/yyc12345/BallanceBlenderHelper/releases)下载最新的插件。插件是以ZIP压缩包形式提供的。 + +此外,您还可以在yyc12345提供的制图教程网盘中获得此插件: + +* 中国特供:[百度网盘](https://pan.baidu.com/s/1QgWz7A7TEit09nPUeQtL7w?pwd=hf2u) (提取码:hf2u,位于`制图插件(新)`下) +* 非中国:[Mega](https://mega.nz/#F!CV5SyapR!LbduTW51xmkDO4EDxMfH9w) (位于`Mapping`目录下) + +!!! warning "不要直接下载本仓库使用" + 请不要直接下载本项目的代码库来进行使用。首先是因为最新的commit不能保证其是稳定可用的。其次是因为本项目中包含了一些需要编译的C++代码,必须经过编译才能使用。参见[编译与分发插件](./compile-distribute-plugin.md)了解更多。 + +## 安装插件 + +开启Blender,选择`编辑 - 偏好设置`,在打开的窗口中转到`插件`选项卡,点击`安装`按钮,选择刚刚下载完毕的ZIP压缩包,即可安装完成。若没有在列表中看到可选择刷新按钮或重启Blender。 + +您也可以选择手动安装插件(如果上述安装方法失败了的话),转到`Blender/3.6/scripts/addons`,将下载好的ZIP压缩包内容解压到此文件夹下,启动Blender,即可在插件列表中找到BBP。 + +BBP插件位于`社区`类别下,名称为`Object: Ballance Blender Plugin`,找到后勾选名称左侧的勾即可启用插件。插件安装成功后的偏好设置页面如下图所示。 + +![](../imgs/config-plugin.png) + +在 **安装或更新** 完插件后,请在使用前务必先[配置插件](./configure-plugin.md),详情请参阅下一章节。 diff --git a/docs/docs/zh-cn/tech-infos.md b/docs/docs/zh-cn/tech-infos.md new file mode 100644 index 0000000..cfbf112 --- /dev/null +++ b/docs/docs/zh-cn/tech-infos.md @@ -0,0 +1,5 @@ +# 技术信息 + +* BM文件标准:https://github.com/yyc12345/gist/blob/master/BMFileSpec/BMSpec_ZH.md +* 制图工具链标准及`meshes`文件夹下的文件的格式:https://github.com/yyc12345/gist/blob/master/BMFileSpec/YYCToolsChainSpec_ZH.md +* BMERevenge的JSON文件的格式:https://github.com/yyc12345/gist/blob/master/BMERevenge/DevDocument_v2.0_ZH.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index dd4a626..3e6f20e 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -10,6 +10,10 @@ nav: - 'Start': 'en/index.md' - 简体中文: - '开始': 'zh-cn/index.md' + - '安装插件': 'zh-cn/install-plugin.md' + - '配置插件': 'zh-cn/configure-plugin.md' + - '编译与分发插件': 'zh-cn/compile-distribute-plugin.md' + - '技术信息': 'zh-cn/tech-infos.md' theme: name: readthedocs