q5play 4.0.0 → 4.0.1

package/LICENSE.md

@@ -0,0 +1,74 @@
+# q5play Creator License
+
+This License Agreement ("Agreement") is made between Quinton Ashley, the sole copyright owner of q5play ("Licensor") and an individual, organization, or company ("Licensee") that is using q5play.
+
+**_For use in Computer Science (CS) education, see the [q5play Educational License](https://q5play.org/teach)._**
+
+## 1. License Grant
+
+The Licensee is granted a non-exclusive, world-wide, royalty-free right to use the q5play software library ("Content") for **personal, professional, and commercial purposes**, subject to the following restrictions.
+
+### 1a. Permitted Commercial Use
+
+The Licensee may use the Content to create, publish, and sell software, games, or applications without the requirement to make their own application source code public or open source.
+
+### 1b. Limited Redistribution
+
+The Licensee may host or distribute verbatim, unmodified copies of the Content only as part of their own applications. "Verbatim copies" means exact duplicates of the Content as provided by the Licensor. The Licensee may not sell, sublicense, or redistribute the Content as a standalone library or as part of a competing software development kit (SDK).
+
+### 1c. Derivative Work Restrictions
+
+Modification, enhancement, or adaptation of the Content ("Derivative Work") can be done privately, but any Derivative Work that is shared with others must be shared under the same terms as this original Agreement. Derivative Works must be created for the sole purpose of improving the Content for the benefit of all users of q5play.
+
+### 1d. Computer Science Education Restriction
+
+The Licensee is **expressly forbidden** from using the Content for the purpose of teaching computer science, programming, game development, or the use of q5play itself.
+
+- **Prohibited Use:** This includes, but is not limited to, use in schools, universities, coding bootcamps, online programming courses, or paid CS instructional content.
+- **Permitted Use:** The Content may be used to create interactive educational media for other subjects (e.g., teaching math, cooking, or history), provided the application does not instruct the user on how to code or use q5play.
+- **Ambiguity:** In cases of ambiguity regarding subject matter, the Licensor reserves the right to determine if the use falls under "CS Education."
+
+Any use for CS education requires the [q5play Educational License](https://q5play.org/teach).
+
+### 1e. No Military Use
+
+The Licensee is expressly forbidden from using the Content in projects that are directly endorsed by military organizations, arms manufacturers, or military contractors.
+
+### 1f. Attribution Required
+
+The Licensee must publicly display appropriate credit to the Licensor. Use of the "made with q5play" Loading Screen is required for all published work, unless the work is published on an online code editing platform or other web app that was approved by the Licensor to be exempt from this requirement.
+
+Attribution can also be made at the top of the primary script file or in a README file.
+
+Example Attribution:
+
+```js
+/**
+ * Made with q5play!
+ * https://q5play.org
+ */
+```
+
+## 2. Licensee Eligibility
+
+Any individual or entity using q5play is required to comply with this Agreement. Use of q5play constitutes acceptance of these terms.
+
+## 3. "Learn q5play" Interactive Textbook Access
+
+The Licensee is granted access to the ["Learn q5play"](https://q5play.org/learn) interactive textbook for personal learning and evaluation only. Use of these materials for group instruction or classroom settings is prohibited without an Educational License.
+
+## 4. No Warranty
+
+The Content is provided "as is." The Licensor makes no warranties, express or implied, including without limitation any implied warranty of merchantability or fitness for a particular purpose.
+
+## 5. Limitation of Liability
+
+The Licensor shall not be liable for any damages suffered by the Licensee resulting from the use or inability to use the Content. Licensees must comply with all applicable laws and are fully liable for any content they create with q5play.
+
+## 6. Termination
+
+This Agreement terminates automatically, without notice from the Licensor, if the Licensee fails to comply with any term(s) of this Agreement.
+
+## 7. Entire Agreement
+
+This Agreement constitutes the entire agreement between the parties. To the extent possible, if any provision is deemed unenforceable, it shall be automatically reformed to the minimum extent necessary to make it enforceable. If it cannot be reformed, it shall be severed without affecting the remaining terms.

package/README.md

@@ -1,5 +1,41 @@
-# q5play
+# <img src="https://q5play.org/assets/q5play_logo.avif" width="64"> q5play ![](https://img.shields.io/github/package-json/v/q5play/q5play)
 
-Coming soon...
+## Visit [q5play.org][]! 🎮🧑‍💻
 
-q5play combines the fastest 2D graphics library, q5.js, with the fastest 2D physics library, Box2D v3, enabling users to create and share incredible interactive experiences on the web!
+[q5play][] is a beginner friendly, powerful, and cutting edge game engine for the web.
+
+It uses [q5.js WebGPU][] for graphics and [Box2D v3 WASM][] for physics.
+
+[Join us on Discord][] to ask questions and meet other people making games with q5play. 👾
+
+## Licensing 📝
+
+The [q5play Creator License][] enables free personal and commercial use.
+
+Educational use requires the [q5play Educational License][].
+
+## Credits ⭐️
+
+q5play and p5play v3 were created by Quinton Ashley.
+
+Huge thanks to everyone that's helped with q5play! 🙏
+
+Erik Sombroek and Alex Birch, creators of [Box2D v3 WASM][].
+
+Erin Catto, creator of the Box2D physics simulator.
+
+Paolo Pedercini, creator of p5.play (version 1), who trusted me to take over this project.
+
+Ali Shakiba, creator of planck.js, a JS port of Box2D v2 used by p5play v3.
+
+Contributors: @Tezumie, Oliver Zell, Caleb Foss, and Bobby S.
+
+Testers and bug reporters: Lachlan Noble, Raj Raizada, Nathan Anil, Chayarat Wangweera, Zhiyuan Guo, Aarnav Gupta, and Carter Noa.
+
+[q5play.org]: https://q5play.org
+[q5play]: https://q5play.org
+[q5.js WebGPU]: https://q5js.org
+[Box2D v3 WASM]: https://github.com/Birch-san/box2d3-wasm
+[Join us on Discord]: https://discord.gg/EJwnJATmj7
+[q5play Creator License]: LICENSE.md
+[q5play Educational License]: https://q5play.org/teach

package/package.json

@@ -1,13 +1,30 @@
 {
 	"name": "q5play",
-	"version": "4.0.0",
+	"version": "4.0.1",
 	"author": "quinton-ashley",
-	"license": "q5play License",
-	"description": "JavaScript game engine that uses q5.js for graphics and Box2D for physics.",
+	"license": "SEE LICENSE IN LICENSE.md",
+	"description": "A web-based game engine that uses q5.js WebGPU for graphics and Box2D v3 WASM for physics.",
 	"main": "q5play.js",
+	"types": "q5play.d.ts",
+	"homepage": "https://q5play.org",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/q5play/q5play.git"
+	},
+	"keywords": [
+		"q5",
+		"p5play",
+		"p5"
+	],
 	"scripts": {
-		"test": "echo \"Error: no test specified\" && exit 1",
+		"multi": "ws --https --cors.embedder-policy require-corp --cors.opener-policy same-origin --directory .",
 		"v": "npm version patch --force",
-		"V": "npm version minor --force"
+		"V": "npm version minor --force",
+		"version": "git add -A",
+		"postversion": "git push"
+	},
+	"dependencies": {
+		"box2d3-wasm": "^5.2.0",
+		"q5": "^4.4.4"
 	}
 }