Get Started
- Kwik plugin update
- TODO: Download .ccx from Release instead of exporter_20241111-2115.zip
- Where to check the version number?
Kwik Tools Overview
Kwik Exporter extension for Photoshop
Open from: Plugin > Kwik Exporter
Solar2D Simulator with Kwik Editor
Open from: Window > View As > Kwik Editor Landscape
graph TB subgraph Solar2D subgraph App src[[source <br> Lua files]] subgraph Assets media[(media <br> .mp3 .wav <br> .mp4 .mov )] images end end subgraph KwikEditor anim(animation tool) button(button tool) audio(audio tool) video(video tool) etc( phsics, timer, var ..) end end subgraph Photoshop PSD[[PSD files]] Kwik((extension <br>Kwik Exporter)) end PSD -.-> Kwik Kwik -.-> images Kwik -.-> src
You can scaffold a project template using the Kwik exporter. See introduction/#step-2–using-the-kwik-exporter-in-photoshop
Name Description Path Note kwik exporter Photoshop extension UXP/com.kwiksher.kwik5.exporter-ps_PS.ccx Double-click .ccx to install in Photoshop psd files Photoshop files in a folder Photoshop/book/landscape.psd
Photoshop/book/portrait.psdOpen .psd files from the Kwik Exporter extension panel Solar2D project Solar2D project for Kwik framework Solar2D Open main.lua in Solar2D folder with Solar2D Simulator Folder structure in the kwik5 project template:
Downloadables
The Photoshop plugin com.kwiksher.kwik5.exporter_PS.ccx
is available in the release tab. Please download it:
Use update_kwik.bat
(Windows) or update_kwik.sh
(Mac) to set up lua_modules/kwiksher/kwik
etc. If you don’t use the Kwik exporter in Photoshop, you can clone the repo and use the update_kwik scripts.
Kwik5 Project Format
A typical Kwik project includes these files and folders:
Photoshop
book
landscape.psd
portrait.psd
icon
desktop
icon_splash_launch-assets
icon_splash_launch.psd
Solar2D
App/book
main.lua
build.settings
config.lua
...
update_kwik.bat (Windows)
update_kwik.sh (Mac)
build.settings
Portrait or landscape is set when the Kwik exporter scaffolds a project. See introduction/#step-2–using-the-kwik-exporter-in-photoshop
main.lua
Change
env.mode = "development"
to"production"
for device builds.See [introduction/#mainlua]
config.lua
Change
adaptive
toletterbox
for device builds.Photoshop/book
portrait.psd
andlandscape.psd
in Photoshop/book are explained in Get Started > PSD Screen Size OrientationPhotoshop/icon
This folder contains sample PSDs and files for creating app icons for iOS, Android, macOS, and Win32. See Get Started > App Icon Launch/Splash image
Solar2D project
How to update the tool
Use update_kwik.sh (Mac) or update_kwik.bat (Windows). The script fetches and overwrites lua_modules/kwiksher/kwik
and related files.
When
com.kwiksher.kwik5.exporter-ps_PS.ccx
is updated, you can set up a new Kwik project with the latest modules.
Tips
You can rename “book” in the Photoshop and Solar2D/App folders to something more descriptive, like “game” or “myBook”, and put your PSD files there.
├── BookServer
├── Photoshop
│ └── book
│ ├── landscape.psd
│ └── portrait.psd
├── Solar2D
│ ├── App
│ │ └── book <==== published images/lua files go here
│ ├── LaunchScreen.storyboardc
│ ├── Images.xcassets
│ ├── jp.lproj
│ ├── plugin
│ │ ├── assets
│ │ ├── extlib
│ │ ├── installer
│ │ ├── commands
│ │ ├── controller
│ │ ├── components
│ │ ├── editor
│ │ ├── en.lproj
│ │ ├── template
│ │ ├── test
│ │ └── server
│ ├── build.settings
│ ├── config.lua
│ ├── Icon-osx.icns
│ ├── Icon-win32.ico
│ ├── LaunchScreen.storyboardc
│ ├── main.lua
│ ├── main.lua.debug
│ └── mySplashScreen.png
bookstore.lua
You can specify book folder names to ignore in
bookstore.lua
.The following book folders exist in the kwik5tmplt repository:
local M = { bookignored = {"animation", "asset", "interaction", "keyboard", "lingualSample", "mybook", "page", "physics", "replacement", "shape"} }