Skip to content

Installation Guide

Jump to bottom
Edward Teach edited this page Apr 10, 2024 · 6 revisions

Welcome to the TerraPrime Installation Guide. Follow these steps to integrate TerraPrime into your Unreal Engine 5.4 project, enabling you to start creating breathtaking landscapes with ease.

Prerequisites

Before proceeding with the installation of TerraPrime, ensure you meet the following requirements:

  • Unreal Engine 5.4 or later installed on your system.
  • Git installed on your machine (if you choose to clone the repository).
  • A basic understanding of Unreal Engine project structure and plugin management.

Installation Methods

TerraPrime can be installed in your project in two primary ways: by cloning it as a Git submodule or by downloading and manually adding it. Choose the method that best fits your workflow.

Method 1: Cloning as a Git Submodule (Recommended)

This method is ideal if you're familiar with Git and manage your project in a Git repository. It allows for easy updates and version control of the TerraPrime plugin.

  1. Open a Terminal or Command Prompt.
  2. Navigate to your project's root directory where the .uproject file is located.

cd path/to/your/project

  1. Execute the following command to add TerraPrime as a Git submodule to your project:

git submodule add https://github.com/OrchidIsle/TerraPrime.git Plugins/TerraPrime

  1. Initialize and update the submodule to ensure you have the latest version of TerraPrime:

git submodule update --init --recursive

  1. Restart Unreal Engine and open your project. Unreal Engine should automatically detect the new plugin and compile it if necessary.

Method 2: Downloading as ZIP and Adding Manually

This method is straightforward and does not require Git. It's suitable if you prefer a simple drag-and-drop approach or are not using version control.

  1. Navigate to the TerraPrime GitHub repository:

    TerraPrime GitHub Repository

  2. Download the repository as a ZIP file by clicking the Code button and selecting Download ZIP.

  3. Extract the ZIP file to a location of your choice.

  4. Copy the extracted TerraPrime folder to your project's Plugins directory. If the Plugins directory does not exist, create it at the root of your project directory, alongside the .uproject file.

  5. Restart Unreal Engine and open your project. Unreal Engine will detect the plugin and, if necessary, prompt you to compile it.

Enabling Tessellation Support

  1. Open your project's DefaultEngine.ini file: Locate this file in your project's Config directory.
  2. Modify Nanite Settings: Add the following lines under [/Script/Engine.RendererSettings] to enable tessellation with Nanite:
r.Nanite.AllowTessellation=True
r.Nanite.Tessellation=True

Adjusting Nanite Tessellation

  • For further customization of Nanite's tessellation, you can adjust r.Nanite.Tessellation directly within the Unreal Engine Console or via script, depending on your project's needs. Note that r.Nanite.Tessellation is a runtime setting and should be adjusted to match the desired level of detail and performance for your landscapes.

Post-Installation Steps

After installing TerraPrime, perform a few quick checks to ensure the plugin is correctly integrated and ready to use:

  1. Verify Plugin Activation: Go to Edit -> Plugins in Unreal Engine, locate TerraPrime in the list, and ensure it is enabled. If not, enable it and restart the editor.

  2. Accessing TerraPrime Content: In the Unreal Engine Editor, open the Content Browser and navigate to the Plugins folder. If you do not see the TerraPrime content, ensure the Show Plugin Content option is enabled in the Content Browser's view options.

  3. Test the Plugin: Try applying a TerraPrime material to a landscape object to confirm everything is working as expected.

Troubleshooting

  • Compilation Errors: If you encounter errors during compilation, verify that you're using a compatible version of Unreal Engine and that all prerequisites are met.
  • Plugin Not Detected: Ensure the TerraPrime folder is correctly placed within the Plugins directory of your project and that you have restarted Unreal Engine after installation.

What Now?

You're now ready to start using TerraPrime to create stunning, dynamic landscapes in Unreal Engine. Explore the Usage Guidelines to learn more about leveraging TerraPrime in your projects.

For further assistance, feedback, or to contribute to the TerraPrime project, please visit the Support and Feedback section of our wiki.

Happy landscape designing with TerraPrime!

Clone this wiki locally