separate gitignore and add document

This commit is contained in:
yyc12345 2023-12-31 19:31:41 +08:00
parent 321e1b6fe9
commit 318d661ac1
6 changed files with 133 additions and 9 deletions

View File

@ -1,14 +1,14 @@
# My Ban # My Ban
bbp_ng/PyBMap/*.dll PyBMap/*.dll
bbp_ng/PyBMap/*.so PyBMap/*.so
bbp_ng/PyBMap/*.dylib PyBMap/*.dylib
bbp_ng/PyBMap/*.bin PyBMap/*.bin
bbp_ng/PyBMap/*.pdb PyBMap/*.pdb
bbp_ng/icons/* icons/*
!bbp_ng/icons/.gitkeep !icons/.gitkeep
bbp_ng/jsons/* jsons/*
!bbp_ng/jsons/.gitkeep !jsons/.gitkeep
# Byte-compiled / optimized / DLL files # Byte-compiled / optimized / DLL files
__pycache__/ __pycache__/

2
docs/.gitignore vendored Normal file
View File

@ -0,0 +1,2 @@
# mkdocs
site/

34
docs/docs/en/index.md Normal file
View File

@ -0,0 +1,34 @@
# Ballance Blender Plugin User Manual
!!! info "Work in Progress"
This part of manual still work in progress.
Welcome to the Ballance Blender Plugin, the user manual for the free and open source Ballance map creation suite.
Ballance Blender Plugin (aka BBP) is a plugin that focuses on the creation of Ballance custom maps. It offers a wide range of features that can be used to create Ballance maps by anyone from novice to experienced mappers. BBP provides the ability to import and export formats used in Ballance maps, and a series of convenient features tailored to the creation of Ballance maps: for novice mappers, you can quickly assemble a map with prefabricated road blocks, and for the experienced mappers, the mapping tools needed to build complex structures are also provided.
Compared to other mapping processes, the mapping process with Blender and BBP has unparalleled advantages. First of all, both Blender and BBP are free and open source, unlike 3ds Max and Virtools, which require payment. Secondly, Blender and BBP are still actively updated and therefore run perfectly on today's computer systems, whereas 3ds Max and Virtools only run on certain legacy versions or even 32-bit versions because Virtools is no longer updated, and because of this 3ds Max and Virtools can crash in a variety of ways on today's systems.
Therefore, choosing Blender with BBP for mapping is not only choosing freedom and open source, but also choosing the easiest way of mapping in today's status quo.
## Getting Started
* Installing Plugin
* Configuring Plugin
## Basics
* Virtools Properties
* Importing and Exporting Virtools Documents
* Operating by Groups
* Advanced UV
* Adding Prefabricated Structures
* Adding Rails
* Adding Components
## Advanced
* Compiling and distributing plugins
!!! info "These are not all"
This manual only documents the relevant operations regarding this plugin and does not explain how to make a Ballance map here. For detailed information on how to make a Ballance map with Blender and BBP, please search for content on Bilibili or YouTube.

6
docs/docs/index.md Normal file
View File

@ -0,0 +1,6 @@
# Ballance Blender Plugin
Pick your favorite manual language:
* [English](./en/index.md)
* [简体中文](./zh-cn/index.md)

34
docs/docs/zh-cn/index.md Normal file
View File

@ -0,0 +1,34 @@
# Ballance Blender Plugin用户手册
!!! info "制作中..."
手册的这部分还在制作当中。稍安勿躁。
欢迎来到Ballance Blender Plugin一个自由开源的Ballance地图创作套件的用户手册。
Ballance Blender Plugin后文简称BBP是一款关注Ballance自制地图创建的插件。它提供了相当丰富的功能从制图新手到老手均可利用此插件创作Ballance自制地图。BBP提供了导入导出Ballance地图所用格式的功能并为Ballance地图创作量身打造了一系列便利的功能对于新手可以借助预制路块快速拼接完成一张地图对于老手也提供了构建复杂结构所需的贴图工具。
相比于其它制图流程借助Blender与BBP的制图流程具有无可比拟的优势。首先Blender与BBP均是免费开源的这与3ds Max及Virtools等需要付费的软件大不相同。其次Blender与BBP仍处于活跃更新中因而可以在当代的计算机系统上完美运行而3ds Max与Virtools则由于Virtools不再更新只能运行在某些特定的上古版本甚至是只能以32位运行也正因为如此3ds Max与Virtools在当今系统上运行会出现各种各样的崩溃行为。
因此选择Blender配合BBP进行制图不仅仅是选择了自由与开源更是选择了当今现状下最轻松的制图道路。
## 入门
* 安装插件
* 配置插件
## 基础
* Virtools属性
* 导入导出Virtools文档
* 按组操作
* 高级贴图
* 添加预制结构
* 添加钢轨
* 添加机关
## 进阶
* 编译与分发插件
!!! info "这些并不是全部"
本手册只记录有关此插件的相关操作并不会在此说明如何制作一份Ballance地图。如需详细了解如何利用Blender和BBP制作Ballance地图请在Bilibili或YouTube上搜索相关内容。

48
docs/mkdocs.yml Normal file
View File

@ -0,0 +1,48 @@
site_name: Ballance Blender Plugin Manual
site_description: 'The user manual of Ballance Blender Plugin'
site_author: 'yyc12345'
site_url: 'https://yyc12345.github.io/BallanceBlenderHelper/'
copyright: 'Text is available under the <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC-BY-SA 4.0</a>.'
nav:
- 「 」: 'index.md'
- English:
- 'Start': 'en/index.md'
- 简体中文:
- '开始': 'zh-cn/index.md'
theme:
name: readthedocs
locale: en
include_homepage_in_sidebar: false
plugins: []
extra:
alternate:
- name: English
link: /BallanceBlenderHelper/en/home
lang: en
- name: 简体中文
link: /BallanceBlenderHelper/zh-cn/home
lang: zh
markdown_extensions:
- admonition
- pymdownx.arithmatex
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.critic
- pymdownx.details
- pymdownx.emoji:
emoji_generator: !!python/name:pymdownx.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.magiclink
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde