Documentation

Your guide to setting up and using NeuralScape in your Unreal Engine project.

Getting Started
  1. Enable the the following Plugins in your project - Python Editor Script Plugin, Python Foundation Packages, Editor Scripting Utilities, Geometry Script and Water.
  2. Install Google Gemini (pip Install google-generativeai) into your Unreal python environment. Watch this video if you need help:Tutorial Video
  3. Go to Google AI Studio and create and copy your own api key.Get API Key
  4. Open the event graph within both Editor Utility Widgets and add your api key into the line gemini_api_key = "" within the python script. Compile and save.
  5. Now run the Widget, type a prompt and hit Generate.
How It Works

Precision Mode

Leverage the power of AI to generate detailed and structured scenes from a simple text prompt. This tool spawns a wide array of assets—including Static Meshes, Niagara VFX, and Blueprints—using a vast library of precise placement patterns. Go beyond simple spawning by procedurally configuring PCG graphs, water bodies, fog, and post-process settings for a fully realized environment, all within a user-defined area. Can also control parameter overrides for PCG Graphs,Blueprints,Niagara Systems, post-processing and fog.

Crazy Fun Mode

Unleash creative chaos! This mode discovers all available assets in your project and empowers the AI to act as a wild environment artist. Feed it a prompt, and watch as it intelligently selects from your meshes, Blueprints, and VFX to build surprising scenes. The AI will even attempt to creatively configure parameters on your assets to match the theme, leading to unique, fun, and unpredictable results.

Best Practice

Use PCG volumes for the bounding boxes (user defined areas).

What's Possible: Placement Patterns
A detailed list of all available placement patterns you can use in your prompts.

Environment Types
Examples of environments you can create.
  • Natural Landscapes: Forests, Grasslands, Rocky Terrains, Water Bodies, Beaches, Mountainous Regions.
  • Urban/Civilized Environments: Villages, Towns, Cities, Road Networks, Parks/Gardens.
  • Thematic/Stylized Environments: Magical/Fantasy Landscapes, Sci-Fi/Futuristic Environments, Abstract/Artistic Scenes.
  • Gameplay-Oriented Environments: FPS Maps, Arena/Combat Zones.
Demo

Check out the video demo and the rest of the channel for more examples.