Documentation Home
Level Pack Description
Level Packs are defined by a Level Pack Description asset. This asset defines the scenes that are part of the level pack, and the properties of the level pack. A Unity project can have multiple Level Pack descriptions in it.
Settings:
- Name: the display name of the level pack, to display in the level pack chooser
- Desc: the description of the level pack, to display in the level pack chooser
- Version: the version of the level pack. For display only.
- Author: the author information of the level pack.
- Mode: Which mode types the level pack can be played in.
- Campaign: the pack is playable in Campaign and Time Trials modes.
- Battle: the pack is playable in Battle, Tournament, and Minigames modes
Battle levels cannot contain Tank objects.
- Campaign Max Lives: If Mode is set to Campaign, this option controls the number of lives the players start with. Ignored in all other modes.
- Pack Icon: an optional image to display in the level pack chooser. If you are unable to choose an image, make sure that it's inside the Assets folder of your Unity project, and is a format that Unity supports.
- Scenes: The Unity scene files to include in this level pack. A scene may be part of multiple level packs, provided that the level pack is of a compatible Mode.
Exporting and Testing
To export your level pack, select the Level Pack Description asset and press the Export Level Pack button. This will produce a folder containing a JSON file, XML files, and any optional icons.
Do not edit these files, as this can break their internal logic and prevent proper loading.
IMPORTANT! If there are errors during export, they will be logged in the Unity editor Console. The console can be opened via the main menu bar: Window > General > Console.
Exported level packs must be placed inside a specific folder for Tankken to be able to read them.
- macOS: ~/Application Support/RRSoftware/Tankken/levelpacks
- Windows: %APPDATA%/LocalLow/RRSoftware/Tankken/levelpacks
- Linux: ~/.config/unity3d/RRSoftware/Tankken/levelpacks
If in doubt, press the Open Level Pack Folder button in the in-game Level Pack chooser dialog, which can be opened from the game's main menu.
This will open a file browser window pre-set to the correct location.
Publishing and Playing Online
Publishing level packs is very simple. Just create a zip file and give it to your friends, or host it on a website for download.
Note that Tankken does not support loading level packs from zip files, so you'll need to unzip level packs you download before you can play them.
When playing online, only the host of the online lobby needs to have the level pack downloaded. Tankken will stream the level pack data to all connected clients as-needed.