EPOK DOCUMENTATION
Build your first world.
Then go deeper.
Setup, workflows, native APIs and a source-mapped catalog of every implemented feature.
Learn by doing
01 / VISUAL GAMEPLAY
Build your first Blueprint
Find the editor controls, connect typed pins and inspect a running Actor.
Start the Blueprint tutorial Keep the reference nearby02 / SCRIPTED GAMEPLAY
Build your first Lua class
Create an Actor, expose Inspector properties, move it in Tick and choose how the same source runs on PSX.
Start the Lua tutorial Open the complete reference03 / VISUAL EFFECTS
Create and animate an effect
Choose layers, tune emission, edit curves and preview a repeatable effect.
Open the VFX editor guide Explore scene timelines04 / PUT IT TOGETHER
Move a character through a world
Sculpt ground, bake a walking graph and let an agent cross it while your player runs, jumps and lands.
Sculpt a terrain Bake navigation05 / GENERATED LEVELS
Generate your first dungeon
Play the Dungeon template, roll seeds, edit a recipe and a style, add a minimap and build a room by hand.
Start the dungeon tutorial Build a room by hand06 / 2D GAMES
Make your first 2D platformer
Play the Platformer 2D template, paint a level from tiles and turn a picture into a crate that falls and gets pushed.
Start the platformer tutorial Open the 2D reference01
Release notes
Epok Engine v0.10.0 Epok Engine v0.9.0 Epok Engine v0.8.0 Epok Engine v0.7.0 Epok Engine v0.6.0 Epok Engine v0.5.0 Epok Engine v0.4.0 Epok Engine v0.3.0 Epok Engine v0.2.0 Epok Engine v0.1.102
Start here
Getting started Complete feature catalog Projects Starter templates The editor Content Browser Settings File formats & migration03
Create your world
Blockout modeling Third Person template Dungeon template Dungeon Complete Dungeon generator 2D worlds, 3D worlds & UI Terrain Importing models Skeletal characters Textures PSX texture cooking Your first dungeon Build a dungeon room by hand Your first 2D platformer04
Render & animate
Lighting & shadows Environment effects Palette animation05
Build gameplay
Actors & Components Recreating older projects Scene Blueprints Your first Blueprint Blueprint reference C++ scripting Lua scripting Gameplay API Input & collision Runtime services 3D navigation Cameras World and camera coordinates Asset DataTables Shared resources Memory Card Gameplay actions World gameplay helpers Character movement Character animation Camera rigs Health Projectiles Shared 3D queries Your first Lua class06
Timelines & VFX
Using the VFX editor Timeline reference Sprites & particles Blueprint & VFX troubleshooting07
Sound & interface
Audio playback & MIDI music Assets & audio Full-motion video HUD & UI Procedural UI preview PocketStation Dialogue widgets Native music08
Build, run & ship
Build, measure & iterate Play targets & loading Scenes outside the executable PS-X EXE export Performance World optimization Geometry streaming Standalone runtime Release process PSX runtime hot paths09
Extend & understand
Integrated code editor AI / MCP Architecture Testing Lua VM runtime Scene loading Scene View resources10
API reference
C++ API reference Epok runtime API PsyQo API11
Project
License Third-party notices Runtime noticesBEFORE YOU BUILD
Know the current limits.
- Experimental on Windows x64, macOS Apple Silicon and Linux x86_64. Builds and emulator execution are verified. Blueprint reflection and authoring are available on Windows and Linux; macOS does not yet include that toolchain. Broader physical-console validation is ongoing; the music guide explains the scoped hardware evidence.
- Rigid skeletal animation. Imported skeletal materials support assigned textures. Blended skin weights, animation blending, retargeting and root motion remain outside the current profile.
- Focused editing tools. Blueprint graphs/templates, timelines, effects, Blockout geometry and MCP scene batches have Undo/Redo. Hierarchy supports multiple Actor selection; check each editor tool for its own history and editing limits.
- PSX rendering constraints. Intersecting polygons can still produce sorting artifacts. Capacity limits are not frame-rate guarantees.
- Bounded simulation and resources. Fixed 60 Hz steps, conservative AABB collision and resident data that must fit PSX RAM. Optional editable-mesh geometry streaming uses bounded CD pages; required reads may stall rendering and restart XA music. It is off by default, not general-purpose map or texture streaming.
- Build from source. Build from source or use the available packaged release for your platform; see the installation guide for supported hosts.
Documentation snapshot: 6d01853. Updated from committed engine documentation.