Skip to content

Latest commit

 

History

History
137 lines (87 loc) · 4.45 KB

README.md

File metadata and controls

137 lines (87 loc) · 4.45 KB
Raw

q5.js is a spiritual successor to the p5.js and Processing Java graphics libraries.

q5 was designed to make creative coding even more fun and accessible for a new generation of artists, educators, and beginners!

If you're already familiar with p5, you'll find yourself right at home with q5. It's also compatible with popular addons, including p5.sound and p5play.

function setup() {
	createCanvas(100, 100);
	circle(50, 50, 50);
}

No Installation Required

Try out the q5.js template sketch for the Aijs online code editor.

Use q5.js in your own project by adding this line to your HTML file:

<script src="https://q5js.org/q5.js"></script>

q5 is also available on npm!

npm install q5

Using p5 Addon Libraries

q5 is compatible with popular p5 addons and projects that use p5, such as p5play, because it aliases Q5 to p5.

To use addons, simply load them after q5.js:

<script src="https://q5js.org/q5.js"></script>
<!-- load p5 addons after q5 -->
<script src="https://p5play.org/v3/planck.min.js"></script>
<script src="https://p5play.org/v3/p5play.js"></script>

Documentation

Browse the q5 reference pages to learn how to use q5.js.

See the wiki for extended documentation of q5's exclusive features.

Use the q5.d.ts file in Visual Studio Code to get autocompletion and inline hover-over documentation. Simply add this jsconfig.json file to your project folder:

{
	"compilerOptions": {
		"target": "ESNext"
	},
	"include": ["*.js", "**/*.js", "node_modules/q5/q5.d.ts"]
}

Support this project 🤝

q5 is open source and anyone can use it for free under the terms of the LGPL (just like p5.js). 🎉

We need your support though! If you enjoy using q5.js, please donate via GitHub Sponsors or Patreon.

Size Comparison

q5 is 98% smaller than p5.

p5.js is nearly 5MB in size due to lengthy JSDoc comments, the WebGL render, and the dependencies corejs and opentype.

q5's JSDoc comments are stored separately in the q5.d.ts file, which includes type definitions for Visual Studio Code autocompletion. q5 also has no dependencies.

npm packages:

  • p5 7800kb ⚠️
  • @types/p5 1070kb
  • q5 415kb

Unminified:

  • p5.js 5112kb ⚠️
  • p5.sound.js 488kb
  • q5.js 117kb

Minified:

  • p5.min.js 1034kb ⚠️
  • p5.sound.min.js 200kb
  • q5.min.js 73kb 🎉

Modular Use

For extremely lightweight use you can load a subset of scripts from the src folder. See the src/readme.md for more info on modular use.

Contributing

Please report issues or comment on existing issues before working on a pull request.

Check out the q5 planning board.

If the q5 project is successful, all contributing developers will be paid for their work. The project will be run as a worker co-op.

Contributors must agree to the code of conduct.

Licensing

q5.js was created by the q5 team and is licensed under the LGPLv3. q5 is not affiliated with The Processing Foundation.

@LingDong- created the original q5xjs library which is Unlicense licensed.

p5.js is licensed under the LGPLv2, small sections of p5' code directly copied into q5 are credited below. The rest of q5 is a new implementation of part of the p5 API. APIs are not copyrightable in the United States, as decided by the Supreme Court in the Google v Oracle case.

Credits

WebGPU MSDF text rendering: https://webgpu.github.io/webgpu-samples/?sample=textRenderingMsdf

WebGPU blendMode: https://webgpufundamentals.org/webgpu/lessons/webgpu-transparency.html

A JS Implementation of Ziggurat Algorithm: http://ziggurat.glitch.me/

p5.js Vector.slerp: https://github.com/processing/p5.js/blob/v1.10.0/src/math/p5.Vector.js#L2803

p5.js random: https://github.com/processing/p5.js/blob/1.1.9/src/math/noise.js