Quark is a framework made to build universal apps using HTML/CSS and JavaScript.
The goal of this project is to make desktop/console development accessible to anyone with (even little) knowledge in web development.
Right now it can be used to write PS vita and GNU/Linux apps using HTML/CSS and JavaScript.
Example apps are available in the examples directory.
Note : It is a very early version and some things will break and not be supported. Please write issues and pull requests if you encounter bugs or can help participate in the project!
- https://github.com/lp1dev/vita_ports_scanner
- https://github.com/lp1dev/vita_virtualkeyboard/
- https://github.com/lp1dev/VipperZero
As of today, the Docker setup is the easiest to get started regardless of your OS, the Dockerfiles in this project should package everything you need to run and debug your quark projects in a few minutes.
As of today, there is three available Dockerfiles to help you build three different images depending on what you need to achieve.
For each of the docker build commands below, run them from the root of this repository!
The default CLI interface, use it to build .vpk files from your project directory.
Build the image with:
docker build -f ./Dockerfiles/Dockerfile -t quark:0.1 .Then, build your own quark project with:
docker run --rm -v {your_project_directory}:/quark/projects/project -it quark:0.1 /quark/projects/project/For the moment, the build scripts absolutely need your project to be in
/quark/projects/{your_project}or/quark/examples/{your_project}!
Your new .vpk files will be created in {your_project_directory}, you can new install them on your PS Vita or in your own emulator!
If you want to use the Linux version of quark and render your project natively using a VNC server, build the VNC version with:
docker build -f ./Dockerfiles/Dockerfile_X11 -t quark:0.1-vnc .Then, run your project in a quark window with :
docker run --rm -p 127.0.0.1:5900:5900 -v {your_project_directory}:/quark/projects/project -it quark:0.1-vnc /quark/projects/project/The prompt will ask you to setup a password.
Once you're done you can connect to 127.0.0.1:5900 using the password you specified with the VNC client of your choice!
Finally, this one will install the Vita3K emulator along VNC, build your project and then run your (if the build was successful) compiled .vpk file in the emulator.
docker build -f ./Dockerfiles/Dockerfile_X11_Vita3k -t quark:0.1-vita3k .Build and run your project with:
docker run --rm -p 5900:5900 -v {your_project_directory}:/quark/projects/project -it quark:0.1-vita3k /quark/projects/project/Here too, the prompt will ask you to setup a password.
Once you're done you can connect to 127.0.0.1:5900 using the password you specified with the VNC client of your choice!
- vita-sdk
- curl
- tar
- unzip
- make
- cmake
Auto install with scripts/setup.sh (the script was made to be run in quark's main directory):
- lexbor (HTML Parsing)
- duktape (JavaScript Engine)
Install manually on your system:
- SDL2
- SDL2_ttf
- SDL2_image
Note: It seems that this step is not required on the latest VitaSDK versions, this will be left here for reference.
Before building your VPK apps, you will also need to install the SDL_ttf lib to your vita-sdk :
And the SDL_Image lib for the vita using :
make -f Makefile.psp2; make -f Makefile.psp2 installThen, to work on a new project, you can either start anew or copy one of the examples.
Create a new projects directory, then create a new directory inside for your project with the name of your choice!
In the directory of your app, run :
./build.sh
Note: The ./build.sh can be copied and adapted from the examples! Same for the other required build files.
And voilà! You should have a working .vpk file that you can install on your console or run in an emulator.
To build a GNU/Linux version of your app (for debugging or to support desktop uses for instance), in the main quark directory, run :
make -f Makefile.Linux
Then, copy the quark binary to the location of your index.html and style.css files.
You will also need to have Sans.ttf and quark.js in the same directory as this binary!
A list of what is currently working on quark's API is available here.
- Add image cache (different from texture cache)
- Support external resources loading in HTML (such as JSON/JS/CSS files)
- Negative padding (and probably margin) crashes Quark
- Setting an undefined or null value in an element might cause a crash
Enhance JS/HTML support to support projects like :
Overall, have more people create cool projects for the PS Vita.
I'd like to keep quark's codebase as "written-by-humans" as possible.
I've been using Claude for some obscure parts of this project for which documentation was scarce (in the PS Vita's USB and TCP/IP implementations) and unfortunately, I still have some non-original code that I still need to replace in the PS Vita's USB section.
It will be replaced by handmade and more readable code that I fully master as soon as possible.
Same goes for the project's "logo".
If you add code to the project, please make sure it's your own, readable and that you fully understand what it does.
That being said, I do not mind example projects or documentations being AI-written, the current API reference was actually written by Claude.
Thanks for your understanding!
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.