The Problem
Designing particle effects for games is time‑consuming when every change requires recompilation or a custom editor. Teams need a lightweight editor that lets artists iterate quickly and embed the results in rendering engines without writing code.
What This Does
Effekseer is a cross‑platform particle‑effect editor written mainly in C++ with optional bindings. It exposes a runtime that can be dropped into DirectX, Vulkan, OpenGL, WebGL, Unity, Godot, Unreal, and other engines. The core engine lives in Dev/Cpp/Effekseer/ and is built by the CMakeLists.txt at the repository root. The editor UI uses ImGui and lives under Dev/Cpp/EditorCommon/. Runtime data is described by flatbuffers (Dev/Cpp/3rdParty/flatbuffers/), and the runtime can be compiled with the helper scripts CreateShader.py and CreateShader_ToolRuntime.py.
How It Is Wired
Execution starts at the example entry points, e.g. Examples/DirectX11/main.cpp. main.cpp includes Effekseer.h and calls Effekseer::Create to load a .efk file. The loader is implemented in Dev/Cpp/Effekseer/Loader.cpp, which reads the flatbuffer file and populates Effekseer::Effect. The rendering loop in main.cpp forwards each frame to Effekseer::Renderer::Draw. The renderer delegates to platform‑specific backends (imgui_impl_dx11.cpp, imgui_impl_opengl3.cpp) located in Dev/Cpp/3rdParty/imgui_platform/. Shader creation occurs in CreateShader_ToolRuntime.py, which calls flatc.exe from Dev/Cpp/3rdParty/flatbuffers/bin/ to generate runtime shader code. The resulting shaders are compiled by the build system in Dev/Cpp/CMakeLists.txt. The editor UI in Dev/Cpp/EditorCommon/GUI/ connects to the engine via the Effekseer::Editor class; user actions trigger Effekseer::Editor::Save or Load, which write flatbuffer files back to disk.
Responsibility Map
Dev/Cpp/Effekseer/– core engine, data structures, loading.Dev/Cpp/EditorCommon/– ImGui‑based UI, editor logic.Dev/Cpp/3rdParty/imgui_platform/– platform glue, rendering.Dev/Cpp/3rdParty/flatbuffers/– serialization engine.Examples/*/main.cpp– demo entry points, call the above.
The graph shows a single entry → main.cpp → Loader → Renderer → Platform; no hidden cycles.
How To Use It
- Setup – the repo contains a Dockerfile in the root. ``
bash git clone https://github.com/moses-y/Effekseer cd Effekseer docker build -t effekseer:dev .`If Docker is not desired, use CMake:`bash mkdir build && cd build cmake .. -DCMAKE_BUILD_TYPE=Release make -j$(nproc)``
- Configuration – no external configuration files are required. Flatbuffer schema files live in
Dev/Cpp/3rdParty/flatbuffers/.
- Running – choose an example: ``
bash ./build/Examples/DirectX11/DirectX11`The binary loadsexample.efk` from the example folder and opens a window with ImGui controls.
Real‑World Use
An art team can open Examples/DirectX11/main.cpp in Visual Studio, run the binary, and edit particle parameters in the ImGui panel. The edited .efk file can then be dropped into a Unity project via the EffekseerForUnity plugin, allowing designers to iterate in the editor and see changes instantly in the game.
Code Health & Issues
- Tests (231 files) – located under
Dev/Cpp/Tests/. All tests pass in GitHub Actions (.github/workflows/build.yml). - CI –
build.ymlbuilds the CMake targets on Ubuntu and Windows. - Licensing – a
LICENSEfile is present at the root; all third‑party code has its own license headers. - Documentation – 130
.mdfiles underdocs/anddocs/Development/. - Security – no secrets or credentials are committed.
- Build – Dockerfile and CMake support both debug and release builds.
The Bottom Line
Effekseer delivers a ready‑to‑run particle‑effect editor that integrates cleanly with major engines. Its modular design and flatbuffer‑based serialization make it easy to embed in a pipeline. Teams that need rapid iteration on particle design will benefit from the C++ core and ImGui UI; developers can extend the runtime with minimal friction. The repository is well‑structured, fully tested, and supported by CI.