Quickstart
The PopcornFX Editor
First of all, download the PopcornFX Editor here.
The Content Examples
If you want just want to try PopcornFX quickly, clone our Content Examples. It’s a Godot project that includes some effects and explains the different features of the plugins. It’s a bit restricted for now, we are growing it bit by bit.
To look into how the showcased effects work, open ContentExamples/Godot/PopcornProject.pkproj, which should launch the PopcornFX editor. Learn more about the editor here.
Otherwise, continue reading to learn how to add our plugin to your project.
Installation
Godot 4.7+
The built-in Asset Store is the best way to install the plugin.
Simply search for PopcornFX in the store and install the plugin! (Make sure to check Ignore asset root)
You should now have a res://addons/popcornfx folder. This specific path is required or the plugin will not work.
Godot 4.6 & lower
You have two choices: Godot’s in-built AssetLib or downloading a package.
If you just want to get the latest version of the plugin, the AssetLib is definitely the better choice. Just search "PopcornFX" and you can install it easily.
However, you can’t install older versions of assets directly from Godot. If you need an older version of the plugin, you can get a build of the plugin as a GitHub release.
Extract the zip into the res://addons folder of your project. You should now have a res://addons/popcornfx folder. This specific path is required or the plugin will not work.
Your first PopcornFX project
Launch the PopcornFX Editor. We suggest using an online package to get started. Specifically, the Tutorials pack lets you explore different effects organized in a progressive order, so you can learn the basics and gradually move on to more advanced concepts.
If you’d like to create a blank project, follow this page then create a simple first effect. In both cases, create the PopcornFX project in your Godot project.
PopcornFX in Godot
Now open your Godot project if you hadn’t already. Open the Project Settings and search for "Source Pack". Select your PopcornFX project & restart the Godot editor.
After Godot has restarted, the effects should import and you should see them in Godot’s FileSystem.
Now it’s time to put some particles in your Godot project.
First, add a PKEmitter3D node to your scene
Learning PopcornFX
As mentioned previously, we recommend starting with the Tutorials Pack, available for free in the Marketplace tab of the Editor Launcher. It lets you explore different effects organized in a progressive order, so you can learn the basics and gradually move on to more advanced concepts.
For a more hands-on introduction, there is also a beginner-friendly tutorial playlist on YouTube
Feedback
Every bit of feedback helps us make the plugin better!
Join us on our Discord Server if you have something you’d like to report, features you want to request or want some help.