Ballistic Unity Tools

From BallisticNG Wiki
Jump to: navigation, search

This article is a stub. You can help BallisticNG Wiki by expanding it.

Ballistic Unity Tools is a suite of tools integrated into Unity which allow you to prepare tracks exported from the Layout Creator for use in the game. As the tools are integrated into Unity, you will need a copy of Unity installed to use them. The game runs on Unity 2017.2.1. Do not use Unity 2017.3 or above!

DirectX 9 support was removed, which will prevent shader swapping from functioning.

Arrow getting started

Installation

If you've already imported BallisticUnityTools.unitypackage, you can skip to Updating.

To install the tools, you need to import the package. Once you have Unity installed and a new project open, go to the toolbar at the top of the window and then navigate to Assets -> Import Package -> Custom Package. After this, navigate to Steam -> steamapps -> common -> BallisticNG and open BallisticUnityTools.unitypackage from the Modding folder.

Updating

When a new version of the Ballistic Unity Tools package is ready, the package file on your PC will be automatically updated thanks to Steam. However, your Unity project will not automatically change to the latest package version.

You can switch your Unity project to the latest package version by importing the package again. This will update any files that have changed.

Custom scripts

Custom tracks cannot contain custom scripts. Custom tracks are compiled as Unity asset bundles, which do not allow scripts to be built into them.

It is possible to save scripts into an assembly and load the scripts from that assembly, but components attached to game objects have asset references serialized (which means that loading a script from an assembly will result in Unity not knowing that the script is actually loaded and usable).

Because of this, it is a goal to over time keep adding new behaviours that modders can use. If you have a behaviour you'd like to see implemented, let Vonsnake know!

Arrow essential knowledge

Essential knowledge that must be understood to create a playable track.

If this is your first time launching Unity, it is recommended to read the pages below in order.

Arrow Unity User Interface

Unity-user-interface.jpg
Getting familiar with the Unity interface.

Arrow Importing a track into Unity

Dragging-track-into-3d-world.jpg
Getting a track from the BNG Track Editor, into Unity.

Arrow Track Wizard

Track-wizard.jpg
Generating track data.

Arrow Track Editor: intro

Track-editor-menu-item.jpg
Start enhancing a track.

Arrow Track Editor: tiles

Tiles-wet-shadow-swooshable.jpg
Enhancing a track by marking tiles.

Arrow Track Editor: atlas

Atlas-tiles.jpg
Enhancing a track by adding textures.

Arrow Unity Tools Lightmapper

Lightmapper-window.jpg
How to use the lightmapper, BallisticNG's proprietary lightmapping tool required for lighting your track.

Arrow Unity Tools Export

Track-built-prompt.jpg
Information on how to export your track from Unity ready to be used in-game.

Arrow supplemental knowledge

Supplemental knowledge to enhance track quality.

Unlike the essential knowledge pages, each page in this section:

  • can be read in any order
  • can be read on demand whenever you want to read up on a specific topic
  • is less of a user guide & more of a technical guide
  • is ordered alphabetically

Arrow Animation System

Uv-scroller-example.jpg
Information on what the animation system is and how to utilize scripts inside of it.

Arrow Asset Configuration

Sound-settings.jpg
Information on import information you should/need to change for different assets to work with the game.

Arrow Flare Tools

Icon UnknownTeam.png
Information on how to configure your scene to occlude flares.

Arrow Materials

Unity-preview-of-material.jpg
Information on the material shaders provided by the BallisticNG Unity Tools package.

Arrow Racing Line Editor

Racing-line-example.jpg
How to use the racing line editor, a tool allowing you to define different offsets along the track that AI can follow.

Arrow Scene Configuration

Scene-configuration-menu.jpg
How to begin setting up your track, an overview of how the scene is configured once you use the Track Wizard and links to the various scripts that can be used throughout your track.

Arrow Ship reflections

Reflection-probe-example.jpg
Information on achieving ship reflections with Unity reflection probes.

Arrow Skies

Sky-example.jpg
Skydomes, the BallisticNG SkyDome shader, & the lightmapper ignore script

Arrow TRM Editor

Trm-editor-window.jpg
How to use the TRM Editor, a tool which lets you convert any mesh into a TRM formatted mesh.

Arrow Track Editor: sections

Sections-metadata.jpg
Enhancing a track by configuring sections.

Arrow Trigger System

Animation-trigger-script-example.jpg
Information on what the trigger system is and how to utilize scripts inside of it.

Arrow Unity Lighting

Light-sponge-options.jpg
Manipulating light on a track.

Arrow Unity Tools Scripts

Ballistic-material-script.jpg
Information on the scripts provided by the BallisticNG Unity Tools package.