https://github.com/jetbrains/teamcity-unreal-engine-plugin

Automate builds, testing, and deployment for Unreal Engine projects with TeamCity integration
https://github.com/jetbrains/teamcity-unreal-engine-plugin

teamcity-plugin unreal-engine

Last synced: 18 days ago
JSON representation

Automate builds, testing, and deployment for Unreal Engine projects with TeamCity integration

• Host: GitHub
• URL: https://github.com/jetbrains/teamcity-unreal-engine-plugin
• Owner: JetBrains
• License: apache-2.0
• Created: 2024-11-05T11:57:32.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2025-03-06T19:12:41.000Z (about 2 months ago)
• Last Synced: 2025-03-24T10:06:22.313Z (about 1 month ago)
• Topics: teamcity-plugin, unreal-engine
• Language: Kotlin
• Homepage:
• Size: 1.13 MB
• Stars: 11
• Watchers: 17
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TeamCity Unreal Engine plugin

[![official JetBrains project](http://jb.gg/badges/official.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

![build status](https://teamcity.jetbrains.com/app/rest/builds/buildType:id:TeamCityPluginsByJetBrains_TeamCityUnrealEnginePlugin_MasterBuild/statusIcon.svg)

This plugin allows you to build Unreal Engine projects in TeamCity.

## Features

* Automatically detect Unreal Engine installed on build agents

* Dedicated runner that covers the most common use cases:

    * Execute the `BuildCookRun` command to perform all stages of the build process.

    * Utilize custom BuildGraph scripts.

    * Launch automation tests.

* Automation test reporting

* UGS metadata server integration

* Structured build log with error highlighting, reported as TeamCity Build Problems

For details on usage, please refer to [USAGE.md](USAGE.md).

## Installation

You can download the plugin from the [marketplace][marketplace.plugin-page]. Installation instructions are available

[here][plugin-installation-guide].

## How to Contribute

We highly value user feedback and encourage you to share your experience and suggestions.

You can contribute by sending a Pull Request, opening an issue on GitHub, or reaching out via [YouTrack][youtrack].

## Development

### Prerequisites

* Docker

* Amazon JDK 11

### Building

1. Clone the repo

2. Setup local git hooks

    ```shell

    git config core.hooksPath .githooks

    ```

3. Build the project using Gradle

    ```shell

    ./gradlew build

    ```

## Additional Resources

- [Usage](USAGE.md)

- [Changelog](CHANGELOG.md)

- [Maintainership](MAINTAINERSHIP.md)

- [Configuration](CONFIGURATION.md)

[youtrack]: https://youtrack.jetbrains.com/newIssue?project=TW

[marketplace.plugin-page]: https://plugins.jetbrains.com/plugin/22679-unreal-engine-support

[plugin-installation-guide]: https://www.jetbrains.com/help/teamcity/installing-additional-plugins.html