Update docs

A5H73Y · Dec 27, 2020 · 7624268 · 7624268
1 parent fbbd5da
commit 7624268
Show file tree

Hide file tree

Showing 8 changed files with 47 additions and 10 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -8,5 +8,6 @@
     * [Economy](tutorials/economy.md)
     * [Plugin Configuration](tutorials/plugin-config.md)
     * [Compatible Plugins](tutorials/compatible-plugins.md)
+    * [Custom Models](tutorials/custom-models.md)
 * [Developer Tutorials](developer.md)
 * [Changelog](changelog.md)
diff --git a/docs/developer.md b/docs/developer.md
@@ -1,8 +1,6 @@
 Developer Tutorials
 ======
 
-## Description
-
 Are you a developer? Great! You can make the most of out Carz's functionality to create the perfect experience for your server. I've made the plugin super easy to expand and integrate into, first we will import Carz project to begin working with it.
 
 ## Importing Carz into your Project

diff --git a/docs/files/Minecart.bbmodel b/docs/files/Minecart.bbmodel
diff --git a/docs/tutorials/block-types.md b/docs/tutorials/block-types.md
@@ -1,8 +1,6 @@
 Block Types
 ======
 
-## Description
-
 For each Block Type, you are able to specify a list of Materials which make up that action. The available actions include: `climb, placeable, speed & launch`.
 
 Each of these can be added to using `/carz add (type) (Material)`. Some may need an extra argument for the amount, such as the strength of the speed block, or the amount of height from a launch block.

diff --git a/docs/tutorials/compatible-plugins.md b/docs/tutorials/compatible-plugins.md
@@ -1,8 +1,6 @@
 Compatible Plugins
 ======
 
-## Description
-
 Carz is able to integrate with supported plugins to extend functionality. If integration is desired, make sure the plugin(s) are installed and start correctly, then Carz will display a success message on start up (if configured).
 
 ## Economy / Vault

diff --git a/docs/tutorials/custom-models.md b/docs/tutorials/custom-models.md
@@ -0,0 +1,45 @@
+Custom Car Models
+======
+
+Carz allows you to apply a model to the Minecart to allow it to appear differently for every car type.
+
+The way it achieves this is by placing a Material inside the Minecart whilst you drive it. This Material will have a custom model and will take the shape of the Minecart plus any details you'd like to add.
+
+**This is fairly unique to Carz and you aren't likely to find any resources online.**
+
+## How do I create my own models?
+
+### Required Software
+
+You'll need to install software which allows you to create 3D models and export them into a format of a Minecraft resource pack.
+
+I would suggest [Blockbench](https://blockbench.net/) as it is free and can be configured to create a Minecraft resource pack using a plugin.
+
+### Configure Software
+
+Once installed I would recommend the following plugins using `Filter -> Plugins`:
+
+- Plaster
+- Resource Pack Exporter
+- Shape Generator
+- Texture Editor
+
+### Creating the Model
+
+Now you are free to use the Software to create your own models which sit upon a Minecart.  
+The Minecart will still be visible but with the shape of the custom model taking form on top, hiding it.
+
+I have created a custom model which should fully consume the default Minecart model and give you some points of reference: [Download here](/files/Minecart.bbmodel)
+
+### Export the Model
+
+Once you're ready to test out your creation, go to `File -> Export -> Export Resource Pack`. Give the Resource Pack a name and description to reference it easily and save it.
+
+The Model will be packaged into a zip file that Minecraft will accept as a Resource Pack. 
+Open up Minecraft `Options... -> Resource Packs... -> Open Pack Folder` drop your freshly created zip file in here. Minecraft should update the results to include your new Resource Pack.
+
+Click the Arrow on your Resource Pack, ignore any message about it possibly being incompatible, and click Done.
+
+**By Default, the Exporting Resource Pack will override the `GLASS` Material (You could change this).**
+
+To test your model, create a new car type `/carz createtype` go through the steps and specify the `Fill Material` as `GLASS`. Obtain the car using `/carz spawn (type)` and place the Minecart received and you should see your new model! 
diff --git a/docs/tutorials/economy.md b/docs/tutorials/economy.md
@@ -1,8 +1,6 @@
 Block Types
 ======
 
-## Description
-
 Carz can link to any Economy plugin that supports Vault.
 
 When linked, each Carz purchase type can have an associated cost. Any economy based purchase will be prevented until the player has earned enough money (for example buying a car).

diff --git a/docs/tutorials/sign-commands.md b/docs/tutorials/sign-commands.md
@@ -1,8 +1,6 @@
 Sign Commands
 ======
 
-## Description
-
 Carz command usage can be completely disabled in the config to allow for full immersion of role-play by using signs for every Carz function. This includes: buying a car, upgrading a car, and refueling your car. Ideally you could have a different building for each of these purposes.
 
 If Carz is linked to an Economy plugin, the cost of the purchase will be displayed at the bottom of the sign.