Project settings 1100

From PopcornFX
(Redirected from Project settings)
Jump to navigation Jump to search
! IMPORTANT ! This is a PopcornFX v1 page. PopcornFX v2 documentation can be found here

See also : Project selection.

This page is for version v1.10.0 and above
For the latest version of PopcornFX, see: Project_settings
For previous versions of PopcornFX, see the following pages:

This is the window where you can customize the settings of your project.
It can be accessed either from the Project selection window, or from the Content browser or Particle editor once the project is opened.

Note however, that only a subset of the project settings will be editable once the project is opened in the content browser. To edit all settings, you'll need to close the editor and change the settings from the Project selection window directly.



Popcorn-Fx general project setup

The "Pack root" tells the editor where the pack is physically located.
It can be a path relative to the data-folder, or an absolute path.


Popcorn-Fx scene setup Axis-System

Allows you to choose between the following coordinate systems:

Popcorn-Fx coordinate system : right-hand Y up (OpenGL)
Popcorn-Fx coordinate system : right-hand Z up (Max)
Popcorn-Fx coordinate system : left-hand Y up (DirectX)
Popcorn-Fx coordinate system : left-hand Z up
Right handed Y-Up axis
(aka. OpenGL)
Right handed Z-Up axis
(aka. Max)
Left handed Y-Up axis
(aka. DirectX/Unity)
Left handed Z-Up axis
(aka. UE4)

The popcorn editor will use these values to mimic the data your game engine will feed to the popcorn runtime, so that you may test your effects in the same conditions as in the game-engine.

  • Sample count : Size of the spectrum and waveform your game engine will provide to the popcorn runtime (Must be a power of two)
  • Min frequency : Sampling the spectrum @ cursor = 0.0 will sample this frequency
  • Max frequency : Sampling the spectrum @ cursor = 1.0 will sample this frequency
  • Logarithmic scale : Enable this if your game engine provides the popcorn runtime with spectrums that have logarithmic values


  • Default restitution : Default restitution for the surface of all backdrops
  • Default restitution combine : v1.9.0 Default restitution combine mode for the surface of all backdrops
  • Default friction : Default friction for the surface of all backdrops
  • Default friction combine : v1.9.0 Default friction combined mode for the surface of all backdrops
  • Wind scale : v1.9.0 Scene wind scale, used to scale values wind backdrops inject into the particle sim
  • Surface types : List of surface types made available by your game-engine
  • Collision filters : List of collision filters made available by your game-engine


Popcorn-Fx include/exclude paths

In this panel, you can add a list of paths to be excluded from your project hierarchy. This is useful if you have lots of game-data you don't care about when creating effects.
Ignored folders will not be displayed in the content browser.

You can also add a list of paths to be included _on_top_ of the excluded paths.
As these are applied after, if means you can basically:

  • exclude the project root
  • include only the few FX-related folders

instead of:

  • exclude everything except the few FX-related folders


Popcorn-Fx upgrader command-lines

In this panel, you can specify various command-lines that are to be run each time the editor upgrades a file inside a project.



Popcorn-Fx asset paths

You can add custom resource paths to where your resources are located, to make them browsable from within popcorn.
(absolute paths are forbidden to reference resources in the editor).


Popcorn-Fx resource extensions

This panel allows you to specify which extensions should be treated as which resources.
Currently, it is only useful if you want to forbid browsing certain filetypes from within the popcorn editor.

For example, you can force the editor to only browse and use .dds files, and not show any of the other image filetypes, by just removing them from the list in the 'Textures' tab.


Popcorn-Fx bake targets

Here you can setup your list of output platforms to tell the editor where it should output the baked targets for each platform.

See the AssetBaker page for more details



Popcorn-Fx user general settings

This panel contains all the user-specific configuration.
This is not saved in the PopcornProject.xml file, but in a local directory outside the project.

Therefore, if you check-in the PopcornProject.xml file into a source control system like Perforce, git, svn.. alongside your other assets and effects, you don't have to worry about the settings of the User panels changing the project file.