Skip to content

Commit f2d45e4

Browse files
committed
Add ToC and logo terms of use
1 parent 31a35a9 commit f2d45e4

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

+18-6
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,16 @@
77
[![License](https://img.shields.io/github/license/blueburncz/YAMC)](LICENSE)
88
[![Discord](https://img.shields.io/discord/298884075585011713?label=Discord)](https://discord.gg/ep2BGPm)
99

10-
# About
10+
## Table of Contents
11+
* [About](#about)
12+
* [Features](#features)
13+
* [Limitations](#limitations)
14+
* [Usage](#usage)
15+
* [Building from source](#building-from-source)
16+
* [Logo terms of use](#logo-terms-of-use)
17+
* [Links](#links)
18+
19+
## About
1120
Yet Another Model Converter (YAMC, pronounced yam-sea) is a tiny tool that loads
1221
a model from one of [many supported file formats](https://github.com/assimp/assimp/blob/master/doc/Fileformats.md)
1322
and exports it into a binary file that can be simply loaded in GameMaker using
@@ -21,7 +30,7 @@ using GameMaker's built-in shaders with [lighting](https://manual.yoyogames.com/
2130
[fog](https://manual.yoyogames.com/GameMaker_Language/GML_Reference/Drawing/GPU_Control/gpu_set_fog.htm)
2231
etc. See [examples](examples) folder for little example projects.
2332

24-
# Features
33+
## Features
2534
* Convert static model into a binary file, easily loadable using functions `buffer_load` and `vertex_create_buffer_from_buffer`.
2635
* Customizable vertex format. Supports 3D position, normal, texcoord (up to two layers), color and tangent vector with bitangent sign (float4).
2736
* Invert vertex winding order.
@@ -30,14 +39,14 @@ etc. See [examples](examples) folder for little example projects.
3039
* Flip UV coordinates on the Y axis.
3140
* Bake materials' diffuse colors into vertex colors.
3241

33-
# Limitations
42+
## Limitations
3443
* The entire model is collapsed into a single vertex buffer, therefore it cannot have sub-meshes with different textures/materials/shaders, different vertex formats and different primitive types (the entire model needs to be either point list, line list or a triangle list).
3544
* Animations are not supported.
3645

37-
# Usage
46+
## Usage
3847
Run `yamc -h` to see help message with all arguments and their description.
3948

40-
# Building from source
49+
## Building from source
4150
Following commands build yamc binary into folder [dist](dist).
4251
*Requires [CMake](https://cmake.org/) 3.23 at least and a C++17 compiler!*
4352

@@ -48,6 +57,9 @@ cmake -B build -S .
4857
cmake --build ./build/ --config=Release
4958
```
5059

51-
# Links
60+
## Logo terms of use
61+
YAMC logo is property of [BlueBurn](https://blueburn.cz) and you're not allowed to do any modifications to it! **Only uniform scaling is allowed, to change the logo size as required.**
62+
63+
## Links
5264
* [Assimp](https://github.com/assimp/assimp) - Used to load models.
5365
* [BBMOD](https://github.com/blueburncz/BBMOD) - More advanced tool with support for animated models and a huge library for advanced 3D rendering in GameMaker.

0 commit comments

Comments
 (0)