From a6096395855f714c696518b619213853fe89ab97 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikita=20Wi=C5=9Bniewski?= Date: Wed, 9 Aug 2023 12:02:04 +0700 Subject: [PATCH] Add spaces after #, make the commands monospaced --- MODELS.md | 23 ++++++++++++++--------- RELEASE.md | 18 ++++++++++++------ 2 files changed, 26 insertions(+), 15 deletions(-) diff --git a/MODELS.md b/MODELS.md index 4b9094c33..663313f30 100644 --- a/MODELS.md +++ b/MODELS.md @@ -1,13 +1,14 @@ -#Models in Minetest/Mineclone2 +# Models in Minetest/Mineclone2 Models are an important part of all entities & unique nodes in Mineclone2. They provide a 3 dimensional map of an object for which textures are then applied to. This document is for modders, it quickly highlights some important information for the software needed to open models in Mineclone2. ## Minetest Wiki + For more detailed information on actually using blender to create and modify models for Minetest/Mineclone2, please visit the Minetest wiki's page on using Blender [Here](https://wiki.minetest.net/Using_Blender) -##Recommended software +## Recommended software -###Blender +### Blender Blender is a very popular and free modeling software supported on Windows, MacOS, and most Linux distributions. It is recommended to use Blender to create and modify 3D models within the minetest engine. @@ -19,14 +20,16 @@ Blitz 3D (.b3d) Is one of the main animated model formats used for entities in t The most up to date version of this Blender plugin can be downloaded [Here](https://github.com/GreenXenith/io_scene_b3d/releases/tag/f189786) -##Types of model formats +## Types of model formats + +### Animated, skinned models -###Animated, skinned models * Blitz 3D files (.b3d) * Microsoft DirectX (.x) (binary & text, compression is not supported) -###Static meshes +### Static meshes + * Wavefront OBJ (.obj) Note: The sometimes accompanying .mtl files are not supported and can safely be deleted. @@ -45,16 +48,18 @@ Note: Do not use .b3d and .x files for static meshes at the moment, Minetest cur Note: Any formats not mentioned above but known to work in the past were removed in 5.5.0 and aren't supported anymore. -##Pros & Cons of .b3d vs .x +## Pros & Cons of .b3d vs .x + +### B3D -###B3D * [+] Binary format means a small size * [-] Difficult to postprocess after exporting * [-] Difficult to debug problems -###X (text version) +### X (text version) + * [+] Can be parsed easily with lua scripts * [+] Can be easily generated by scripts diff --git a/RELEASE.md b/RELEASE.md index 52be92b6c..3984c4c84 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,10 +1,11 @@ ### Standard Release -#File to document release steps with a view to evolving into a script +# File to document release steps with a view to evolving into a script -#Update CREDITS.md -#Update version in game.conf +# Update CREDITS.md +# Update version in game.conf +``` lua tools/generate_ingame_credits.lua git add CREDITS.md @@ -18,10 +19,11 @@ git commit -m "Pre-release update credits and set version 0.83.0" git tag 0.83.0 git push origin 0.83.0 +``` -#Update version in game.conf to the next version with -SNAPSHOT suffix +# Update version in game.conf to the next version with -SNAPSHOT suffix -git commit -m "Post-release set version 0.84.0-SNAPSHOT" +`git commit -m "Post-release set version 0.84.0-SNAPSHOT"` ### Hotfix Release @@ -32,15 +34,17 @@ To mitigate this, you just release the last release, and the relevant bug fix. F * Create release branch from the last release tag, push it: +``` git checkout -b release/0.82.1 0.82.0 git push origin release/0.82.1 +``` ##### Prepare feature branch and fix * Create feature branch from that release branch (can review it to check only fix is there, nothing else, and use to also merge into master separately) -git checkout -b hotfix_bug_1_branch +`git checkout -b hotfix_bug_1_branch` * Fix crash/serious bug and commit * Push branch and create pr to the release and also the master branch (Do not rebase, to reduce merge conflict risk. Do not delete after first merge or it needs to be repushed) @@ -53,11 +57,13 @@ git checkout -b hotfix_bug_1_branch * Tag it, push tag and branch: +``` git tag 0.82.1 git push origin 0.82.1 git push origin release/0.82.1 +``` Note: If you have to do more than 1 hotfix release, can do it on the same release branch.