Documentation for Tiny Terrain v1.0

Introduction

Thanks for using Tiny Terrain! Don't forget to leave a review on the store page if you liked it, this helps us a lot! https://assetstore.unity.com/packages/slug/236464

Description

Tiny Terrain is a lossy Terrain Data compression technology for Unity Terrain Engine, which allows you to reduce the size of the data that Terrain takes in the project many times and significantly reduce the size of your application.

You pay a little CPU time and additional memory usage, but save tens and hundreds of megabytes for each Terrain in the project.

Even though the compression is lossy, in most cases you won't see any visual difference at all.

A very high compression ratio is achieved due to the author's data preparation algorithms and then compression using Brotli.

Even if your build or AssetBundle is already compressed using LZ4, LZ4HC or LZMA, Tiny Terrain will be able to reduce its size. Of course the difference in size won't be as huge as with the uncompressed data, but it's still pretty big.

Tiny Terrain is not a 3rd party Terrain Engine, and you can use Unity Terrain API and any terrain tools you like, such as Real World Terrain, Gaia, Vegetation Studio, etc.

Quick Start

Select Terrain in the scene, add Tiny Terrain Loader component, change the compression settings if necessary, and click Compress. Wait for Terrain compression to complete.

After compression, three files are created next to the original terrain file: [TERRAIN_NAME].tinyterrain.asset - Contains compressed data. [TERRAIN_NAME].tinyterraininfo.asset - Contains compression information. Not included in the build. [TERRAIN_NAME].runtime.tinyterrain.asset - An empty Terrain Data with minimal settings into which the data will be decompressed. Present to work around a Unity bug that causes the wrong grass shader to be used for dynamic Terrain Data.

The compressed Terrain will be automatically loaded and displayed in the scene instead of the original one.

Tiny Terrain Loader

Tiny Terrain Loader component compresses and decompresses a single Terrain.

When no compressed data is selected, the component will look like this:

Tiny Terrain Data - compressed data to be used. If you select a value, it will be loaded into the current Terrain. If you select None, the original Terrain will be restored. Heighmap Accuracy - The number of bits used to store the heightmap value. Alphamap Accuracy - The number of bits used to store the alphamap value. Compression Mode - Tiny Terrain can compress data in main or separate threads. Compress - Compresses the current Terrain. Restore Previous Compression - Present if the Terrain has already been compressed. Allows the previous compression state to be used.

After Terrain is compressed it will look like this:

Decompression Time - How many seconds was the last decompression, including how long the Unity API took to set values for Terrain. Will update every time the Terrain is loaded.

Decompression Mode - Tiny Terrain can decompress in the following modes:

• Manual - Decompression will not be performed automatically. Use API to load Terrain.
• Main Thread - Decompression will be done on the main thread and may cause editor and application freezes.
• Separate Threads - Each Terrain element (heightmap, alphamap, detailmap, trees, holemap) will be decompressed in a separate thread.
• Async - Decompression will be done asynchronously.

Compressed Size - The total size of the compressed data in bytes.

Compression Time - How many seconds did the compression take.

Saved Space - Reducing the size of compressed data compared to uncompressed ones. Hover over the progress bar for more information. You can expand the progress bar to see how much space is saved for each Terrain element.

On Load Complete - Event called when the Terrain is loaded.

On Progress Changed - Event called when Terrain loading progress has been changed. Important: Use the method in the Dynamic section. Otherwise, you will always have the value specified in the inspector.

Restore Original Terrain - Restores the original Terrain. Use if you want to change Terrain or compression settings.

Convert to Bulk Loader - Moves Terrain load to Bulk Tiny Terrain Loader and removes the current component. If Bulk Tiny Terrain Loader is not present, creates it.

Bulk Tiny Terrain Loader

Bulk Tiny Terrain Loader compresses and decompresses multiple terrains.

Decompression Mode - Tiny Terrain can decompress in the following modes:

• Manual - Decompression will not be performed automatically. Use API to load Terrain.
• Main Thread - Decompression will be done on the main thread and may cause editor and application freezes.
• Separate Threads - Each Terrain element (heightmap, alphamap, detailmap, trees, holemap) will be decompressed in a separate thread.
• Async - Decompression will be done asynchronously.

Items - List of Terrains to load.

• Tiny Data - Compressed data.
• Terrain - Terrain in the scene where the data will be decompressed.
• Runtime Terrain Data - An empty Terrain Data with minimal settings into which the data will be decompressed. Present to work around a Unity bug that causes the wrong grass shader to be used for dynamic TerrainData.

On Load Complete - Event called when Terrains is loaded.

On Progress Changed - Event called when loading progress has been changed. Important: Use the method in the Dynamic section. Otherwise, you will always have the value specified in the inspector.

Heighmap Accuracy - The number of bits used to store the heightmap value.

Alphamap Accuracy - The number of bits used to store the alphamap value.

Compression Mode - Tiny Terrain can compress data in main or separate threads.

Compress All Child Terrains - Compresses all child Terrains.

Compression Algorithm

Tiny Terrain prepares Terrain Data map data and compresses it using Brotli.

Brotli has a very high compression ratio close to LZMA, fast decompression and very good support in the industry.

The downside of Brotli is the slow compression speed, which doesn't matter in this case because you only need to compress Terrain once in the editor.

Note: Trees are not compressed with Brotli. Tiny Terrain removes unused parts of the data, reduces data precision where possible, and only uses 12 bytes per tree.

After compression, three files are created next to the original terrain file: [TERRAIN_NAME].tinyterrain.asset - Contains compressed data. [TERRAIN_NAME].tinyterraininfo.asset - Contains compression information. Not included in the build. [TERRAIN_NAME].runtime.tinyterrain.asset - An empty Terrain Data with minimal settings into which the data will be decompressed. Present to work around a Unity bug that causes the wrong grass shader to be used for dynamic Terrain Data.

Compression Ratio

Heightmap. Unity Terrain Engine stores a heightmap of 2 bytes per value. Tiny Terrain compresses this from 2:1 to 20:1 lossless or lossy.

Alphamap. Unity Terrain Engine stores an alphamap in ARGB8 UNorm textures. Tiny Terrain compresses this from 5:1 to 50:1 of its original size lossless or lossy.

Detailmap. Unfortunately, I don't have exact information on how Unity Terrain Engine stores the detailmap, but my observations is that it uses 1 bytes per value. Tiny Terrain compresses this from 5:1 to 50:1 lossless.

Trees. Unity Terrain Engine stores trees 36 bytes per tree. Tiny Terrain removes unused parts of the data, reduces data precision where possible, and only uses 12 bytes per tree, resulting in 3:1 compression ratio.

Holes. Unity Terrain Engine stores holes of 1 byte per value, which adds over 4 MB when used. This is very wasteful. Tiny Terrain compresses holes from 1000:1 to 10000:1 lossless, making them almost weightless. In most cases, the holemap will be less than 1 KB in size.

On average, in real projects, you can expect an overall compression ratio of 3:1 to 50:1 with no visible difference, and up to 100:1 with visible quality loss.

API

Tiny Terrain has an API for compressing, decompressing and loading Terrain.

You can read more about the description of fields, properties and methods in the API Reference:

https://infinity-code.com/doxygen/tiny-terrain/index.html

Updating Asset

We send to Unity Asset Store only stable versions.

Tiny Terrain has a built-in update system, using which you can download the latest versions of Tiny Terrain and get early access to all versions and updates.

Important: Always back up the project before updating assets.

Select "Tiny Terrain Loader / Help / Check Updates", to open the updater window. Enter your Invoice Number or Order Number, select the update channel and click "Check New Versions".

You can find your Invoice Number in Unity Asset Store order confirmation email, or on the orders page in Unity Asset Store: https://assetstore.unity.com/orders

If more than 10 updates were released in the selected channel from the current version, only the last 10 updates will be shown.

If updates are available, you can read the list of changes and download the update.

If you have problems installing the update, then:

1. Remove "Plugins / Infinity Code / Tiny Terrain" folder.
2. Import the new version of Tiny Terrain into the project.

If you want to return to the previous version of Tiny Terrain, then select the channel "Stable Previous". Using this channel, you can get 10 previous stable versions.

Tiny Terrain automatically checks for updates every 24 hours. If the new version is available, you will see an icon in the Actions. Clicking on this action will open the updater window.

Automatic update check does not require an Invoice Number, and works on a previously selected update channel. If you did not select the update channel, then only stable versions will be checked.

Troubleshooting

Known Issues

Grass is rotated relative to its original Terrain orientation Unity Terrain Engine does not support grass rotation. This is a bug in Unity Terrain Engine displaying grass in dynamic Terrain Data. Waiting for a fix from Unity.

Your problem is not listed

Try to update to the latest version of the asset, using the built-in update system. Perhaps we have already fixed this problem.

If the problem persists, please contact us about this problem using email (support@infinity-code.com), forum (http://forum.infinity-code.com) or discord (https://discord.gg/2XRWwPgZK4). We will try to fix all bugs and release the update as soon as possible.

Support

We provide support using email (support@infinity-code.com) in English and Russian, using forum (https://forum.infinity-code.com) or discord (https://discord.gg/2XRWwPgZK4) in English.

If something does not work for you, you have found a bug, or you have a suggestion, please contact to us. When contacting, please specify your OS, the version of Unity Editor and the version of Tiny Terrain. We try to respond to all request to the support within 24 hours.

Other Infinity Code assets

Huge Texture

https://assetstore.unity.com/packages/tools/input-management/huge-texture-163576

Huge Texture allows you to import and use textures larger than 8192x8192px.

How it works: When importing a texture, Huge Texture splits the texture into pages and saves it as a Texture Array. Texture Array is combined on the shader side, which does not create extra draw calls and has almost no effect on performance.

Features:

• The maximum size of the texture: PNG and JPEG up to 16384x16384px, RAW up to 2GB (0.715 gigapixels, 26624x26624px for square textures without transparency);
• Standard Render Pipeline, Universal Render Pipeline (URP, LWRP), High Definition Render Pipeline (HDRP);
• Compressed and uncompressed formats;
• Does not produce extra draw calls. You will have as many draw calls as you would with a regular texture;
• API for working with huge textures, as with regular Texture2D;
• Integration with Mesh to Terrain, Real World Terrain;
• Built-in update system.

Requirements:

• Not all platforms support Texture Arrays. The list of supported platforms is here: https://docs.unity3d.com/Manual/SL-TextureArrays.html
• The field must accept Texture (not Texture2D), and the component must accept custom material or shader. For example, Huge Texture can be used in Mesh Renderer, Raw Image, etc.

Mesh to Terrain

https://assetstore.unity.com/packages/tools/terrain/mesh-to-terrain-7271

Mesh to Terrain is a tool for easily and quickly converting a 3D terrain model created in 3ds Max, Terragen or any other editor to Unity Terrains. Mesh to Terrain can convert textures to SplatPrototypes (Terrain Layers), generate terrain from several models and split the model into several terrains.

Features:

• Unlimited number of models and terrains used in the component;
• Terrains are created in the same place where the meshes;
• Convert the textures of models to textures of terrain;
• Seamless result, when working with multiple terrains;
• Manually adding models or automatic detection of all models in the layer;
• No need to manually add the components of physics;
• Integration (optional): Huge Texture, Relief Terrain Pack;
• Built-in update system.

Online Maps

https://assetstore.unity.com/packages/tools/integration/online-maps-v3-138509

Online Maps is a universal multi-platform mapping solution for your 2D, 3D, AR / VR and mobile applications and games. Fully customizable, incredibly easy to learn and use, and at the same time is one of the most powerful and flexible solutions in the industry. Supports a huge number of services for any mapping needs, and has integration with the best Asset Store assets. The package contains the complete source code without dependencies, and if you want to add or change some feature, you can easily do it. Don't have programming experience or don't know C# - Online Maps supports visual scripting using Bolt and Playmaker. All the features to create any map in Unity in one asset.

Features:

• Standalone, Android, iOS, Windows Store, WebGL;

• Online and offline maps;

• 2D maps and 3D maps with elevation;

• 2D, 3D, billboard and custom markers;

• You can display the map anywhere: on UI, in a scene, or draw into texture;

• Huge number of predefined tile sources: Google Maps, Mapbox, ArcGIS, Nokia Maps, Bing Maps, Open Street Maps, and many others (16 providers, 88 map types);

• Ability to create your own map style or use your own source of tiles (e.g. WMS);

• Multilingual map with or without labels;

• Support Google API web services: Direction API, Elevation API, Geocode API, Places API, Places Autocomplete API, Roads API;

  • Other web services: AMap Search, Bing Maps Elevation API, Bing Maps Location API, HERE Routing API, Open Route Service Directions, Open Route Service Geocoding, Open Street Map Nominatim, Open Street Map Overpass API, QQ Search, What 3 Words;

• Show Google Street View using uPano;

• Additional Features: GPS (with emulator), cache, traffic, Overlays, Drawing API, runtime 3D buildings;

• Integration with: Bolt, Curved UI, EasyTouch, Fingers - Touch Gestures, NGUI, Playmaker, Real World Terrain, TouchScript, Ultimate Editor Enhancer, uPano;

• Easy-to-use and powerful API. Large number of examples of using is attached. Atlas of Examples;

• Built-in update system.

Real World Terrain

https://assetstore.unity.com/packages/tools/terrain/real-world-terrain-8752

Real World Terrain is a tool for automatically creating high-quality terrains, meshes, Gaia stamps and RAW files based on real-world data with global coverage. Incredibly fast and easy to use, and allows you to create high-quality terrains in a couple of clicks. In addition, Real World Terrain can create buildings, roads, trees, grass, and rivers based on Open Street Map data. Real World Terrain is incredibly powerful and flexible. It has a powerful Editor API to automate the generation of terrains, and Runtime API positioning objects by coordinates, etc. Real World Terrain has integration with the best assets of the Asset Store, which gives almost unlimited possibilities in the generation of terrains.

Features:

• Elevation Heightmaps:

  • ArcGIS resolution of max 10 meter per pixel;
  • Bing Maps resolution of max 10 meter per pixel;
  • Mapbox;
  • SRTM v4.1 resolution of 90 meters per pixel;
  • SRTM30 resolution of 30 meters per pixel.

• Texture providers: ArcGIS, DigitalGlobe, Map Quest, Mapbox, Mapy.CZ, Nokia Maps (here.com), Virtual Earth (Bing Maps), Open Street Map , Sentinel-2 + ability to download tiles from custom url;

  • Satellite images resolution of max 0.25 meter per pixel;

• Can create: Unity Terrains, Meshes, Gaia stamps, RAW files;

• Can generate regular textures and Huge Texture (up to 26624x26624px) for each terrain.

• Can generate Terrain Layers based on Mapbox vector tile data;

• Can create objects based on Open Street Map:

  • Editable roads for EasyRoads3D Pro v3 and Road Architect;
  • Editable buildings for BuildR (editable) or built-in building engine;
  • Rivers as meshes or for R.A.M 2019;
  • Trees;
  • Grass.

• A tool to select area directly on Google Maps;

• A lot of extra tools for working with coordinates, objects and postprocessing;

• Unlimited number of generated terrains;

• Integration (optional): BuildR, EasyRoads3D Pro v3, Gaia 2, Gaia Pro, Huge Texture, Online Maps, Playmaker, R.A.M 2019, Relief Terrain Pack, Road Architect, Ultimate Editor Enhancer, Vegetation Studio, Vegetation Studio Pro, VolumeGrass, WorldStreamer.

Terrain Quality Manager

https://assetstore.unity.com/packages/tools/terrain/terrain-quality-manager-28949

Terrain Quality Manager allows you to change the resolution of Heightmap, Detailmap, Alphamap and Basemap, without losing data. If you need to increase the quality of terrain, or optimize terrain for better performance, with this tool you can do it.

Features:

• Allows you to change resolution of Heightmap, Detailmap, Alphamap, Basemap and Resolution Per Patch, without losing data;
• Works for single terrain, all terrains in scene, all terrains in project;
• Allows you to scale up and scale down terrain maps;
• Seamless result, when working with multiple terrains;
• Very easy to use.

Tree Tool

https://assetstore.unity.com/packages/tools/terrain/tree-tool-221137

Tree Tool allows you to manage each tree individually.

Using this tool, you can perform the following actions on trees:

• Move (with and without snapping to terrain);
• Scale;
• Change color;
• Change prefab;
• Extract;
• Inject;
• Duplicate;
• Delete.

In addition, the tool can perform the following mass actions:

• Clear;
• Extract;
• Inject.

Tree Tool is compatible with all assets that create trees for Terrain.

Ultimate Editor Enhancer

https://assetstore.unity.com/packages/tools/utilities/ultimate-editor-enhancer-141831

Ultimate Editor Enhancer (ex uContext Pro) is productivity PowerPack that take your workflow in Unity Editor to a next level, simplifies working with content, adds new features to the editor, corrects and improves the editor’s built-in behaviors.

Dramatically improves Hierarchy, Inspector, Scene View and the editor itself.

Adds tools for quick navigation, creation and manipulation of objects.

Key Features:

• Extremely easy to use. Even a beginner can learn how to use it in a couple of minutes. Many features do not need to be learn at all. They are where they should be in the editor out of the box, but for some reason they are missing.
• Suitable for everyone. It doesn't matter what role you have in the project and at what stage your project is. Ultimate Editor Enhancer helps you right now and saves you hours of chores every day.
• Huge number of tools. Over 70 useful tools for everyone in one asset.
• Seamless integration into the editor workflow. Many features are integrated into the editor so that you instantly forget that it was not in the editor out of the box.
• Excellent performance. Ultimate Editor Enhancer is very heavily optimized and has almost no effect on the speed of the editor.
• Fully customizable. If some feature does not fit your workflow, you can adjust or disable it.
• Superbly documented. The asset has full documentation for each feature, and an illustrated Getting Started.

List of tools:

• Standalone Tools: Bookmarks, Context Menu, Distance Tool, Editor Icon Browser, Smart Search, Toolbar;
• GameObject Tools: Add Component by Shortcut, Collections, Drop To Floor, Duplicate Tool, Group / Ungroup, Missing Script Fixer, Rename + Mass Rename, Pivot Tool, Rotate by Shortcut, Replace, Select Prefab Instances, Selection History;
• Hierarchy Tools: Backgrounds, Best Icons, Display Errors and Exceptions, Enable/Disable GameObject, Filter by Type, Headers, Highlighter, Solo Visibility, Tree;
• Inspector Tools: Drag from Object Fields, Hide Empty Help Button, Hide Preset Button, Inspector Bar, Nested Editor, Quick Add Events, Object Field Selector, Saving Component at Runtime;
• Navigation Tools: Fast Zoom In/Out, Frame Selected Bounds, Jump To Point, Quick Preview, View Gallery;
• Scene View Tools: Custom Tool Switcher, Highlighter, Object Placer, Object Toolbar, Quick Access Bar, Selection Bounds, Tool Values, Terrain Editor Brush Size, WAILA + Smart Selection;
• Windows Tools: Favorite Windows, Maximize Active Window, Recent Windows, Switcher;
• Improve Built-in Behaviours: Change Numberic Field value using arrows, Drag and Drop to Canvas, Enum Field Search;
• Built-in Update System.

uPano

https://assetstore.unity.com/packages/tools/integration/upano-126396

uPano (Unity Panoramic Framework) is a universal solution for displaying dynamic and static panoramas, and creating virtual tours. uPano is very easy to learn and use, and is great for people who do not have programming experience. Visual Tour Maker lets you create virtual tours in minutes. In most usage scenarios, you can make interactive panoramas without creating your own scripts. If you have some very specific purpose, uPano has a powerful and easy-to-use API that will allow you to implement any behavior. Most of the existing types of panoramas are supported: spherical, cylindrical, cubic panoramas on single or six images, cubemap.

Supported platforms: Standalone, iOS, Android (including Google VR), Universal Windows Platform, WebGL. Other platforms have not been tested, but most likely uPano will work well.

Additional features:

• Can display textures larger than 8192px using Huge Texture;
• Visual Tour Maker;
• Interactive elements (Hot Spots, Directions) + Visual Editor;
• Lots of built-in actions for HotSpots and Directions;
• Compound transitions;
• Download Google Street View panoramas by ID or location;
• Video panoramas;
• Control with: mouse, touch, keyboard, gyro, compass, UI buttons, UI compass, UI joystick;
• Plugins: Auto Rotate, Downloader, Limits, Multi Camera, Orthographic Camera, Timed Gaze;
• (optional) Integration with Online Maps, Playmaker;
• Built-in update system.

Final words

We sincerely hope that you enjoy using Tiny Terrain. If you have any questions or problems, please contact us. We will try to help you as quickly as possible.

Please don't forget to leave a review on the store page if you liked Tiny Terrain, this helps us a lot! It is very important for us to have feedback to make our assets better.

Links

Product page: https://infinity-code.com/assets/tiny-terrain Support: support@infinity-code.com Forum: https://forum.infinity-code.com Discord: https://discord.gg/2XRWwPgZK4 YouTube: https://www.youtube.com/channel/UCxCID3jp7RXKGqiCGpjPuOg Vimeo: https://vimeo.com/infinitycode Twitter: https://twitter.com/InfinityCodeCom