SWBF-msh-Blender-IO/README.md

# SWBF-msh-Blender-Export
WIP .msh (SWBF toolchain version) exporter for Blender 2.8

Currently capable of exporting the active scene without collision primitives or skinning information. 

### Installing

> TODO: Install instructions.

### Work to be done
- [x] Raise an error when a .msh segment has more than 32767 vertices.
- [x] Convert from Blender's coordinate space to .msh cooordinate space.
- [x] Add support for exporting materials. Blender's materials are all based around it's own renderers, so possibly going to need custom UI and properties in order to provide something useful for .msh files.
- [x] Add support for collision primitives. Blender doesn't seam to support having basic boxes, cylinders or spheres so it's likely some wacky rules and conventions will need to be used by the modeler. "Add a 1m mesh primitive, have "sphere/box/cylinder" in the name and control the size with the object's scale." Less intuitive than I'd like but it might be the best course of action.
- [ ] Investigate and add support for exporting bones and vertex weights.
- [ ] Investigate and add support for exporting animations.
- [ ] Investigate if anything special needs to be done for lod/lowres exporting.
- [ ] Implement .msh importing. Currently you can use the 1.2 release of [swbf-unmunge](releases/tag/v1.2.0) to save out munged models to glTF 2.0 files if you need to open a model in Blender.

### What from [glTF-Blender-IO](https://github.com/KhronosGroup/glTF-Blender-IO) was used?
The `reload_package` function from \_\_init\_\_.py. Before writing this I had barely touched Python and when I saw that glTF-Blender-IO had a function to assist script reloading "I thought that's useful, I think I kinda need that and I don't know how to write something like that myself yet.". And it was very useful, so thank you to all the glTF-Blender-IO developers and contributors.
Create README.md 2019-11-12 02:47:43 +00:00			`# SWBF-msh-Blender-Export`
			`WIP .msh (SWBF toolchain version) exporter for Blender 2.8`

Update README.md 2019-11-15 07:49:29 +00:00			`Currently capable of exporting the active scene without collision primitives or skinning information.`
Create README.md 2019-11-12 02:47:43 +00:00
add exporter docs 2019-11-20 04:37:53 +00:00			`### Installing`
Create README.md 2019-11-12 02:47:43 +00:00
add exporter docs 2019-11-20 04:37:53 +00:00			`> TODO: Install instructions.`
Update README.md 2019-11-15 07:49:29 +00:00
Create README.md 2019-11-12 02:47:43 +00:00			`### Work to be done`
raise an error when an object creates a .msh segment with too many vertices 2019-11-19 14:33:01 +00:00			`- [x] Raise an error when a .msh segment has more than 32767 vertices.`
Update README.md 2019-11-15 07:49:29 +00:00			`- [x] Convert from Blender's coordinate space to .msh cooordinate space.`
			`- [x] Add support for exporting materials. Blender's materials are all based around it's own renderers, so possibly going to need custom UI and properties in order to provide something useful for .msh files.`
raise an error when an object creates a .msh segment with too many vertices 2019-11-19 14:33:01 +00:00			`- [x] Add support for collision primitives. Blender doesn't seam to support having basic boxes, cylinders or spheres so it's likely some wacky rules and conventions will need to be used by the modeler. "Add a 1m mesh primitive, have "sphere/box/cylinder" in the name and control the size with the object's scale." Less intuitive than I'd like but it might be the best course of action.`
Create README.md 2019-11-12 02:47:43 +00:00			`- [ ] Investigate and add support for exporting bones and vertex weights.`
			`- [ ] Investigate and add support for exporting animations.`
			`- [ ] Investigate if anything special needs to be done for lod/lowres exporting.`
			`- [ ] Implement .msh importing. Currently you can use the 1.2 release of [swbf-unmunge](releases/tag/v1.2.0) to save out munged models to glTF 2.0 files if you need to open a model in Blender.`

			`### What from [glTF-Blender-IO](https://github.com/KhronosGroup/glTF-Blender-IO) was used?`
			The `reload_package` function from \_\_init\_\_.py. Before writing this I had barely touched Python and when I saw that glTF-Blender-IO had a function to assist script reloading "I thought that's useful, I think I kinda need that and I don't know how to write something like that myself yet.". And it was very useful, so thank you to all the glTF-Blender-IO developers and contributors.