Skip to content

Commit

Permalink
Use full Unreal Engine name
Browse files Browse the repository at this point in the history
Similar to ArcGIS MapsSDK for Unreal Engine
  • Loading branch information
bneukom committed Dec 13, 2024
1 parent 1df44e1 commit cfd5080
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 12 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# ArcGIS CityEngine for Unreal
# ArcGIS CityEngine for Unreal Engine

ArcGIS CityEngine for Unreal is an [Unreal Engine 5](https://www.unrealengine.com/en-US/unreal-engine-5) (UE5) plugin which enables the use of ArcGIS CityEngine shape grammar rules in UE5 for the generation of procedural buildings. Therefore, game designers or artists do not have to leave UE5 to make use of CityEngine’s procedural modeling power. The buildings stay procedural all time and artists can change the height, style and appearance of buildings easily with a parametric interface. In addition, buildings can also be generated at runtime.
ArcGIS CityEngine for Unreal Engine is an [Unreal Engine 5](https://www.unrealengine.com/en-US/unreal-engine-5) (UE5) plugin which enables the use of ArcGIS CityEngine shape grammar rules in UE5 for the generation of procedural buildings. Therefore, game designers or artists do not have to leave UE5 to make use of CityEngine’s procedural modeling power. The buildings stay procedural all time and artists can change the height, style and appearance of buildings easily with a parametric interface. In addition, buildings can also be generated at runtime.

As input the plugin requires rule packages (RPK) which are authored in CityEngine. An RPK includes assets and a CGA rule file which encodes an architectural style. The download section below provides links to the several RPKs which can be used out-of-the-box.

The latest release is available in the [downloads section on GitHub](https://github.com/Esri/vitruvio/releases/latest). Please refer to the [installation guide](doc/installation.md) for installation instructions. Examples can be downloaded from [ArcGIS CityEngine for Unreal page](https://esri.github.io/cityengine/vitruvio#examples).
The latest release is available in the [downloads section on GitHub](https://github.com/Esri/vitruvio/releases/latest). Please refer to the [installation guide](doc/installation.md) for installation instructions. Examples can be downloaded from [ArcGIS CityEngine for Unreal Engine page](https://esri.github.io/cityengine/vitruvio#examples).

![City generated using ArcGIS CityEngine for Unreal](doc/img/vitruvio_paris.jpg)
![City generated using ArcGIS CityEngine for Unreal Engine](doc/img/vitruvio_paris.jpg)

## Documentation

Expand Down Expand Up @@ -37,8 +37,8 @@ Esri welcomes contributions from anyone and everyone. Please see our [guidelines

## Licensing Information

CityEngine for Unreal is free for personal, educational, and non-commercial use. Commercial use requires at least one commercial license of the latest CityEngine version installed in the organization. Redistribution or web service offerings are not allowed unless expressly permitted.
CityEngine for Unreal Engine is free for personal, educational, and non-commercial use. Commercial use requires at least one commercial license of the latest CityEngine version installed in the organization. Redistribution or web service offerings are not allowed unless expressly permitted.

CityEngine for Unreal is under the same license as the included [CityEngine SDK](https://github.com/Esri/esri-cityengine-sdk#licensing). An exception is the CityEngine for Unreal source code (without CityEngine SDK, binaries, or object code), which is licensed under the Apache License, Version 2.0 (the “License”); you may not use this work except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.
CityEngine for Unreal Engine is under the same license as the included [CityEngine SDK](https://github.com/Esri/esri-cityengine-sdk#licensing). An exception is the CityEngine for Unreal Engine source code (without CityEngine SDK, binaries, or object code), which is licensed under the Apache License, Version 2.0 (the “License”); you may not use this work except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.

For questions or enquiries, please contact the Esri CityEngine team (cityengine-info@esri.com).
4 changes: 2 additions & 2 deletions VitruvioHost/Plugins/Vitruvio/Vitruvio.uplugin
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
"FileVersion": 3,
"Version": 6,
"VersionName": "2.2 - 2023.1 (CE SDK v3.2.10650)",
"FriendlyName": "ArcGIS CityEngine for Unreal",
"Description": "ArcGIS CityEngine for Unreal adds support for CityEngine's procedural runtime (PRT).",
"FriendlyName": "ArcGIS CityEngine for Unreal Engine",
"Description": "ArcGIS CityEngine for Unreal Engine adds support for CityEngine's procedural runtime (PRT).",
"Category": "Misc",
"CreatedBy": "Esri",
"CreatedByURL": "https://www.esri.com/en-us/home",
Expand Down
Binary file modified doc/img/enable_vitruvio.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions doc/installation.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Installation

This page describes how to install and setup the ArcGIS CityEngine for Unreal.
This page describes how to install and setup the ArcGIS CityEngine for Unreal Engine.

## Download and Install

- Download the MSI installer of the [latest ArcGIS CityEngine for Unreal](https://github.com/Esri/vitruvio/releases/latest) version (alternatively the plugin can also be downloaded as a zip file and extracted directly into your Unreal Engine project). **Note** that the installer contains libraries which are used by the plugin and your browser might warn you not to download them. This warning can be ignored.
- Download the MSI installer of the [latest ArcGIS CityEngine for Unreal Engine](https://github.com/Esri/vitruvio/releases/latest) version (alternatively the plugin can also be downloaded as a zip file and extracted directly into your Unreal Engine project). **Note** that the installer contains libraries which are used by the plugin and your browser might warn you not to download them. This warning can be ignored.

- Follow the instructions of the installer.

Expand Down
2 changes: 1 addition & 1 deletion doc/setup.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Development Setup

This page describes how to setup development for ArcGIS CityEngine for Unreal. This requires [setting up Visual Studio for Unreal Engine](https://docs.unrealengine.com/en-US/ProductionPipelines/DevelopmentSetup/VisualStudioSetup/index.html) and [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).
This page describes how to setup development for ArcGIS CityEngine for Unreal Engine. This requires [setting up Visual Studio for Unreal Engine](https://docs.unrealengine.com/en-US/ProductionPipelines/DevelopmentSetup/VisualStudioSetup/index.html) and [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).

**Note** that the Plugin is called _Vitruvio_ internally.

Expand Down
2 changes: 1 addition & 1 deletion doc/usage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Usage

ArcGIS CityEngine for Unreal leverages CityEngine's Procedural Runtime (PRT) to generate buildings. As input it takes a _rule package (RPK)_, an _initial shape_ and a _set of attributes_. The generation process starts with the initial shape as start shape, from which shape grammar rules are expanded. The attributes are parameters that control shape generation.
ArcGIS CityEngine for Unreal Engine leverages CityEngine's Procedural Runtime (PRT) to generate buildings. As input it takes a _rule package (RPK)_, an _initial shape_ and a _set of attributes_. The generation process starts with the initial shape as start shape, from which shape grammar rules are expanded. The attributes are parameters that control shape generation.

**Note** that the internal name of the Plugin is _Vitruvio_ and therefore all Actors, Components and Functions are referenced by this name.

Expand Down

0 comments on commit cfd5080

Please sign in to comment.