Skip to main content

Installation

Requirements​

The Virtual Rodent project requires:

  • Godot 4.7.1
  • Git
  • Access to the project repository on Gitea
  • A supported desktop operating system

Godot 4.7.1 is required to ensure compatibility with the project's project files, scripts and engine features.

Obtaining the Project​

Clone the project repository from the team's Gitea server:

git clone <project-repository-url>

Navigate into the project directory:

cd <project-directory>

The project should contain the Godot project configuration and source directories.

Opening the Project​

  1. Install and launch Godot 4.7.1.
  2. Select Import from the Godot project manager.
  3. Select the project's project.godot file.
  4. Import the project.
  5. Open the project in Godot.

Godot will load the project and its configured scenes and scripts.

Running the Project​

After importing the project:

  1. Open the project in Godot.
  2. Ensure the correct main scene is configured.
  3. Press the Run Project button.
  4. The Virtual Rodent application should launch.

Verifying the Installation​

A successful installation should allow the user to:

  • Open the project without parser or import errors.
  • Launch the main application.
  • View the simulation environment.
  • Start the simulation.
  • Access the available experiment functionality.

If the project fails to open or run, verify that Godot 4.7.1 is being used.

Development Environment​

Developers working on the project should also ensure that the correct Git repository and feature branch are being used before making changes.

The project's Git workflow is described in the Git Methodology documentation.

AI Attribution: The preceding document was generated and edited with assistance from ChatGPT Web (GPT-5.6 Luna).