FloorplanToBlender3d 项目使用教程

FloorplanToBlender3d 项目使用教程

FloorplanToBlender3d Create 3d rooms in blender from floorplans. 项目地址: https://gitcode.com/gh_mirrors/fl/FloorplanToBlender3d

1. 项目的目录结构及介绍

FloorplanToBlender3d/
├── Blender/
├── Development Center/
├── Docker/
├── Docs/
├── FloorplanToBlenderLib/
├── Images/
├── Server/
├── Stacking/
├── Testing/
├── .dockerignore
├── .gitattributes
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Dockerfile
├── README.md
├── docker-compose.server.yml
├── docker-compose.yml
├── license
├── main.py
└── requirements.txt

目录结构介绍

• Blender/: 包含与Blender相关的文件和脚本。
• Development Center/: 开发中心，可能包含开发相关的资源或文档。
• Docker/: 包含Docker相关的配置文件和脚本。
• Docs/: 项目文档，包含详细的教程和使用说明。
• FloorplanToBlenderLib/: 核心库，用于将平面图转换为3D模型。
• Images/: 包含项目使用的图片资源。
• Server/: 包含服务器相关的文件和配置。
• Stacking/: 包含堆叠相关的配置文件和脚本。
• Testing/: 包含测试相关的文件和脚本。
• .dockerignore: Docker忽略文件。
• .gitattributes: Git属性配置文件。
• .gitignore: Git忽略配置文件。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• Dockerfile: Docker构建文件。
• README.md: 项目主文档。
• docker-compose.server.yml: 服务器模式的Docker Compose配置文件。
• docker-compose.yml: Docker Compose配置文件。
• license: 项目许可证。
• main.py: 项目主启动文件。
• requirements.txt: 项目依赖包列表。

2. 项目的启动文件介绍

main.py

main.py 是项目的启动文件，负责执行主要的逻辑流程。它通常会调用 FloorplanToBlenderLib 中的函数来处理输入的平面图，并生成相应的3D模型。

启动方式

1. 本地启动:

   python main.py
   

2. Docker启动:

   docker-compose up
   

3. 项目的配置文件介绍

docker-compose.yml

docker-compose.yml 是Docker Compose的配置文件，用于定义和运行多容器Docker应用程序。它包含了项目的不同运行模式（如脚本模式、服务器模式、Jupyter模式）的配置。

docker-compose.server.yml

docker-compose.server.yml 是服务器模式的Docker Compose配置文件，专门用于启动服务器实例。

requirements.txt

requirements.txt 列出了项目所需的所有Python依赖包及其版本。可以通过以下命令安装这些依赖：

pip install -r requirements.txt

ConfigFiles

在 Configs/ 目录下，项目提供了配置文件模板，用于自定义3D模型的生成过程。配置文件包括 system.ini 和 default.ini，分别用于系统级和默认配置。

StackingFiles

在 Stacking/ 目录下，项目提供了堆叠文件模板，用于批量生成多个3D模型。堆叠文件使用自定义的解析语言来描述多个平面图的组合方式。

通过以上介绍，您应该对 FloorplanToBlender3d 项目的目录结构、启动文件和配置文件有了基本的了解。希望这些信息能帮助您更好地使用和开发该项目。

FloorplanToBlender3d Create 3d rooms in blender from floorplans. 项目地址: https://gitcode.com/gh_mirrors/fl/FloorplanToBlender3d