This guide will walk you through installing the template, understanding how the files are organized, and getting your first level up and running in under a minute.

Brief Video Guide: https://youtu.be/nIcaDkLwQCw

⚙ Installation

Loading the project into Godot is quick and straightforward.

1. Download and Extract: Download the template ZIP file and extract it to a dedicated folder on your computer (Where you will store and work on your project).

2. Open Godot 4: Launch the Godot 4 engine (ensure you are using Godot 4.x or later).

3. Import the Project:

   • From the Godot Project Manager, click the Import button on the top bar.
   • Navigate to the folder where you extracted the template.
   • Select the project.godot file and click Open.
   • Click Import & Edit to launch the editor.

   💡 Note: The first time you open the project, Godot will spend a few moments importing the assets and shaders. This is normal. You might also see red errors, this is also normal.

   

📂 Folder Structure

The project is built with modularity in mind. To prevent your custom assets from getting mixed up with the template's core mechanics, the folder structure is clearly separated.

• 📁 res://
  • 📂 Core/ [DO NOT MODIFY unless you are extending mechanics. ALWAYS MAKE NEW INHERITED SCENES INSTEAD OF EDITING THEM DIRECTLY]
    • Contains all the foundational scripts, base scenes and core systems.
    • All created scene in the template are inherited from the 📁 Core_Prefabs folder within this folder.
  • 📂 Default_Assets/
    • This is where the template default assets are (such as audio, textures, sprites, enemies…etc).
    • You can duplicate what you want into the Your_Assets folder and modify them (Keeping the original files as backup is highly recommended). You can also see how they’re structured and how the core prefabs are used.
    • All scenes (.tscn) here are inherited from the Core_Prefabs scenes.
  • 📂 Levels/
    • Contains the included demo levels. I recommend saving your custom .tscn level files here.
  • 📂 Your_Assets/
    • This is where you should structure and place all your custom scenes, sprites, textures, audio files, and UI elements.
  • 📂 README.md
    • This file contains information about the project (licensing, support, getting started, link to documentation….etc).
  • 📂 README_THIRD_PARTY_ASSETS.md
    • This file contains the Third-Party Assets credits and their licensing requirements in case you decided to use them.

⏳ Quick Start

The best way to understand the capabilities of U.R.S.T. is to play through the included showcase levels.

1. Run the Project: Press F5 (or click the "Play" button in the top right corner of the Godot editor) to launch the main menu.

   

2. Load the Preview Map: Click Start from the main menu. This will instantly load the primary preview demo map.

   

3. Explore Core Systems: This first map is designed as an interactive showcase of the template. As you walk through, you will see the majority of the core systems and mechanics in action.

   💡 Note: Next to each showcased scene, you will find an in-game image displaying the exact Inspector settings used to configure it.

4. Reach the Level Exit: Once you reach the end of the preview map, interact with the "Level Exit" trigger zone by walking into it. The exit will transition you to a second map. This serves as a basic demo of how a completed, playable game level looks and flows using the template (though it only scratches the surface of what U.R.S.T. can actually do).

🎮 Default Controls