Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Grille committed May 6, 2024
1 parent 136bdcc commit ca0127d
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
# BeamNG_LevelTemplateCreator

Setting up a new scenario from scratch can be a bit tiresome, especially if you have limited knowledge on how BeamNG handles things.
The goal of this project is to provide an easy solution to create empty map templates.
I also aimed to make it easily extendable for people with deeper knowledge of BeamNG.

## Features
• Setup of needed level folder structure without manual renaming.
• Asset System based on beaming’s Json structure.
• Ability to reference built-in BeamNG content, on export the referenced files are extracted to the template level.

## Assets

### Asset Types

`LevelPreset`
Contains a collection of items that are sorted into `Level_object` on export, preset can by selected in the GUI.

`TerrainMaterial`
BeamNG PBR Terrain Material, multiple can be chosen by user.

`GroundCover`
Ground Cover like grass, indirectly added if used by `TerrainMaterial`

`Material`
Object material, indirectly added if used by any other object.

### Paths

`.`
Relative path from the folder containing the Json file.

`/`
Absolute path either from the local package folder, or alternatively if beginning with `/level` and contains an valid BeamNG-level name e.g `/levels/driver_training/` an pointer to an BeamNG resource.

`#`
Hex color code `#ffffff` used to generate a single-color texture file on export.

0 comments on commit ca0127d

Please sign in to comment.