|
1 | | -# Setup |
| 1 | +# Before creating maps please setup your scene as described [in map export documentation](./) |
| 2 | +If you want to test out your new map you just need to press the export button on whole map export script. |
| 3 | + |
| 4 | +Then after re opening the game you will be able to open your new map! |
| 5 | +# Configuring map settings |
| 6 | +Map script has multiple properties, most important ones are: |
| 7 | +* Name: value of this will be used to name: folder that contains exported map, name that will be used to import this map with "manual map load name", name that will be displayed in game. |
| 8 | +* Speed scale: This value will affect: displayed scale of player, calculated stats of route(length, height), slope. the main usage of it are: when you make the map to big by accident or when bike model is to small. |
| 9 | +* Drag coefficient: Increases the total drag on this map. |
| 10 | +* Routes: you need to place here all routes that you want to export. |
| 11 | +* Can edit bike models: whether the user will be able to edit bike models in game. |
| 12 | +## Creating Bike models |
| 13 | +# Creating terrain |
| 14 | +The terrain tool that is used by this project is [Terrain3D](https://github.com/TokisanGames/Terrain3D) so please refer to their [tutorials](https://terrain3d.readthedocs.io/en/stable/docs/tutorial_videos.html) for instructions. |
| 15 | +Everything from Instance meshes, to textures should be exported smoothly. |
| 16 | +> [!Caution] |
| 17 | +> **Exporting [``Terrain3DMaterial``](https://terrain3d.readthedocs.io/en/stable/api/class_terrain3dmaterial.html) is not currently supported** |
| 18 | +> The default one on main scene's terrain 3D true export will be used on all imported scenes in game. |
| 19 | +# 3D meshes |
| 20 | +You can export any 3D mesh, lights and other things supported by [GLTF format](https://www.khronos.org/files/gltf20-reference-guide.pdf) |
| 21 | +> [!Caution] |
| 22 | +> **Sometimes materials might not be imported correctly** |
| 23 | +> 99% of the time your materials will be exported correctly, but if you try to do something weird then it might not be supported by gltf and Godot. |
| 24 | +> |
| 25 | +> [Custom shaders are not supported! (We might think about adding them in the future if it could be done safely)](https://docs.godotengine.org/en/stable/classes/class_gltfdocument.html#class-gltfdocument) |
| 26 | +
|
| 27 | + |
| 28 | +# Routes |
| 29 | +## Setup: |
| 30 | +Structure all of your routes like this: |
| 31 | + |
| 32 | + |
| 33 | + |
| 34 | +Ensure that you have collision mode set to `` Dynamic / Editor`` with reasonable collision radius(this will depend on your hardware). |
| 35 | + |
| 36 | + |
| 37 | + |
| 38 | +You should be able to see the generated collisions like this: |
| 39 | + |
| 40 | + |
| 41 | + |
| 42 | +Fill references of ``RouteCreationTool`` like this: |
| 43 | + |
| 44 | + |
| 45 | + |
| 46 | +You should copy the ``Slope color gradient`` from routes in included maps. |
| 47 | + |
| 48 | +Check the ``Run`` and ``Highlight Path`` properties |
| 49 | + |
| 50 | +## Making new route |
| 51 | + |
| 52 | +You use the ``rough`` path to tell the output path where it should go. |
| 53 | + |
| 54 | +You can edit it just by selecting it and using default Godot tools |
| 55 | + |
| 56 | + |
| 57 | + |
| 58 | +``output`` path should automatically follow the terrain3D, in the part that has generated collision mesh(Or any other object with colider). |
| 59 | + |
| 60 | +To generate output path at certain point, just move your camera over it! |
| 61 | + |
| 62 | +To change resolution of output path change the bake interval on your rough path. |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | +> [!Note] |
| 67 | +> After changing bake interval you will need to go over and regenerate all of output path |
| 68 | +
|
| 69 | +The points that are generated on top of the terrain show path of your output path and color of them shows slope. |
| 70 | + |
| 71 | + |
| 72 | + |
| 73 | +## Configuring your route |
| 74 | +You can also change settings of your route. |
| 75 | + |
| 76 | + |
| 77 | + |
| 78 | +Route stats show automatically calculated values of your route |
| 79 | +# [Example video](./ExportingMaps.md) |
0 commit comments