litecanvas 0.39.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +95 -0
- package/dist/dist.js +921 -0
- package/dist/dist.min.js +2 -0
- package/dist/dist.min.js.map +7 -0
- package/package.json +41 -0
- package/src/index.js +1112 -0
- package/src/palette.js +17 -0
- package/src/sounds.js +11 -0
- package/src/types.js +62 -0
- package/src/zzfx.js +111 -0
- package/types/index.d.ts +657 -0
- package/types/types.d.ts +755 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Luiz Bills
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+

|
|
2
|
+
|
|
3
|
+
# litecanvas
|
|
4
|
+
|
|
5
|
+
[](https://discord.com/invite/r2c3rGsvH3)
|
|
6
|
+
|
|
7
|
+
Lightweight HTML5 canvas engine suitable for small games and animations for people who enjoy coding: there is no fancy interface, no visual helpers, no gui tools... just coding.
|
|
8
|
+
|
|
9
|
+
:warning: **This project is still under development. All feedback is appreciated!** :warning:
|
|
10
|
+
|
|
11
|
+
### Features
|
|
12
|
+
|
|
13
|
+
- **Tiny**: only `~4KB` (minified + gzipped).
|
|
14
|
+
- **Simple API**: just few functions to draw shapes and some utilities to other things like sounds and math.
|
|
15
|
+
- **Offline-first**: You can install the [playground](https://litecanvas.js.org/) as webapp and use anywhere at any time.
|
|
16
|
+
- **Predefined colors**: just use a number (from 0 to 11) to choose a color in our 12-color palette.
|
|
17
|
+
- **Predefined sounds**: packed with 4 sounds created in [ZzFX](https://killedbyapixel.github.io/ZzFX/).
|
|
18
|
+
|
|
19
|
+
[Learn more](https://litecanvas.js.org/about.html)
|
|
20
|
+
|
|
21
|
+
## Getting Started
|
|
22
|
+
|
|
23
|
+
You can try our [online playground](https://litecanvas.github.io) or just installing the [basic template](https://github.com/litecanvas/template):
|
|
24
|
+
|
|
25
|
+
```sh
|
|
26
|
+
# requires Node.js
|
|
27
|
+
npx tiged litecanvas/template my-game
|
|
28
|
+
cd my-game
|
|
29
|
+
npm install
|
|
30
|
+
npm start
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
If you prefer, you can manually install the package via NPM:
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
npm install @litecanvas/litecanvas
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
```js
|
|
40
|
+
import litecanvas from '@litecanvas/litecanvas'
|
|
41
|
+
|
|
42
|
+
// you can setup other configurations here
|
|
43
|
+
// learn more in the cheatsheet
|
|
44
|
+
litecanvas({
|
|
45
|
+
loop: { init, update, draw },
|
|
46
|
+
})
|
|
47
|
+
|
|
48
|
+
// run once before the game starts
|
|
49
|
+
function init() {
|
|
50
|
+
bg = 0
|
|
51
|
+
color = 3
|
|
52
|
+
posx = CENTERX
|
|
53
|
+
posy = CENTERY
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
// called at 60 fps by default
|
|
57
|
+
// use to update your things
|
|
58
|
+
function update(dt) {
|
|
59
|
+
// example: tap to change the circle position
|
|
60
|
+
if (TAPPED) {
|
|
61
|
+
posx = TAPX
|
|
62
|
+
posy = TAPY
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
// use to draw your things
|
|
67
|
+
function draw() {
|
|
68
|
+
clear(bg) // clear the screen
|
|
69
|
+
circfill(posx, posy, 50, color) // draw a circle
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Docs
|
|
74
|
+
|
|
75
|
+
Check out our [Cheatsheet](https://litecanvas.js.org/about.html).
|
|
76
|
+
|
|
77
|
+
## Basic Demos
|
|
78
|
+
|
|
79
|
+
Try some demos in our playground:
|
|
80
|
+
|
|
81
|
+
- [Pong](https://litecanvas.js.org?c=eJy1VV1SE0EQfs8p2qfdJQv5AZSiCFYKIlClYkFKzOO4O5tMuZlNzU6AEvEKnsA3D%2BF5vIBXsHt6drNRtHixKiTT0z1f%2F33d5MrKROhrUYZ3LYAbldrZPmz3uzFKM6mmM7sPO3tO7HRALG1RJiKX%2B5CJvJSt%2B6jVypY6sarQoLSyYQQEtBDpFQyg1%2B%2BycErCLp%2Ff0bnrFRMUdrZJSGVpSUUWKL4XeU7i0ej1eHRR3Uzqmwlswuno7OR0DB3Y8epL9VFWnkge6mlOFw5fGeeZjxN%2FLBdSpnjuu4DKpDCVfa4yWeJ5G89W3lqPfXV2PD5Fl3tkboWx7jlXg4uUFyIFAcmytMUcskJbQsPLF3gMg3mhi6kR8yCGoEPaslNdbVmb4XVoZBnB4NBVEkBl%2FoaiyNYxImch0TnYmSluIDgSGnRhOQqyDtAE23TfaNRykQorw9Rys8jBy%2FPh8dnrkwiMtEuj%2Fe0Tn2HkQ1klPB6%2BeTM6dpf1i3v%2FyldugHWs8KguUzGXUFxL89wXaiZ0iu1RerG0pX9LuC4OdliR4vNn0rzDnjtmdaAfOYcMNEdUzF%2BSEhE9lKPaE4zCgVSInoC5NAtnEbM6hu5Wd7cJmhY6wDJK20BGUXhXZWKk1E1XB5SuhycCua7U2jZHfsgEqg2ZTpxWy6Mx0dsrRh96plc5VLPRe9qtZSL0MxYr5vLvpuM59i67DbebCTIL3GNYFKUiatSD1x7wwGz4CdmA1NYzyMrJupJB3xdIMg%2BKTFurkkdu5sXpf%2FrkvR7UupoALogBbK6S6EUNrnFAD76rRnztFUeZzGTygYNMijxXJU3FjbKzdQahzsjEcuAxJx%2FXrponZhLtM%2Fd9FUMv%2Bi2UKgO3Ytq0AuvYuhxbc0RTI278Lk2QdIZtHj%2BptCtErqY6DBKprTS0buaKkvNLgyxKDD6sltvqOvRLN652Lb7F8YPxOVyOhxdjxGImrTjOXDukEbjzWyGxmcrz8M%2FS0P8Dj4DZKZM4u78VGYfy4XirLbCWrCsD5YrLZar0tJFs2OtiW%2FAv%2BPH128%2FvXyDYMnIhheXgoxh2Gq48ntTpw2h%2FK1010OQIP2EQIONd06MtTPyS4gufoi5aL%2BL%2FaBuG0d9FgJPhqxGcvx1dBHXZ%2F6zmBm7Avd1%2FobW5epdH5xejfUrrEckhqX8Bx8Nfnw%3D%3D)
|
|
82
|
+
- [Bouncing ball](https://litecanvas.js.org?c=eJxtUj1vgzAQ3fkVNxpCAklbqRWlQ9WqZI%2FU2TImsuQCAkOLkvz3GvsKDs3gwff8Pu7OUijOaNnTlvieJ7mCumqFElUJKfSckW0ch%2Fr4Buu5rJhQQ2Jux4b206WhuehaTbp%2F9LyiK5nREKVQxIeTBxMXdT%2F3b4cs2IXZ%2B%2F4jO0Q7P9FvUBGfxAhq6OJodnVOFSe5srp%2FeTc%2FsEonF30LIFcuPlzhg8WdYFYAI8x8h%2BHAMz2K4LXS2ThURQE8P%2FJWV0UBZE62wum8gGkbzmcn9hrBZ4htR1eRghTW2%2BRGNd48PZiyM4AUmKRfteMc4mJC64xeviZelil1fzDlxMkv8wwmz3%2FrcWWWgg7GwN1a3tBv%2FAlMtiQ2%2B2aiYYWQ0g08a4YY%2FW7xAca%2FoRsbrFrDVdeUcBor2vIXzlHggw%3D%3D)
|
|
83
|
+
- [Scroller](https://litecanvas.js.org?c=eJxVUE1PAjEQve%2BvGA%2BGdrdilw%2FFKAcTSDTxYKIJB8Kh7ha2SWnJdtCNhv%2FulAWUQz9m3pv3ZsYa1IVynyowniTLrSvQeAfGGQTG4ScBWOsQ1ErDGDozbQu%2F1oAe7KnwokOkhuDZ8%2BT9if4bZSma98VADMWNuBUjcSdyKfJ8kez%2BmWw3pUINrMTWCKlq%2BvL4%2BjadUBTMtz6KXh966FrtVlgRWhE0lHvjqzH0pYQUSjyTL2v1dZyhsFrVTNKIAEtfA7MawZCGvKfnAc71KZdlbSFAZGJsDTMmu3lq%2BClNB3VN0LE8bD8C1swIyP9Yhbc%2Bkmgt86X1vmaI6fCSwoMdX%2By5qBuMQ7N48VOKrVXDGgE9yTOTRiyV3ZGAKuvJLBgX1QY8rcShHdEatgKFd8Fbmsuv2N6W%2F%2Fclyo5W9guGqpXp)
|
|
84
|
+
- [3D Projection](https://litecanvas.js.org?c=eJyNVU2P2jAQvfMrpodqnWI%2By6kt7WW3hVulrtTuRjk4JCyG4CDHFJYV%2F73jj5CYDUslROx579njGc844yqdMfGXFSRoteZbMVM8F8AFVySAlxZAxkW644lakGGA04IfUhjD7%2Bnt%2FQS%2BwuRu%2BmNyD9%2FKQQ9G8MmhOEbBRubL1K46hhANAOGAQh9%2FEbVTHA%2F8qbaYaaRXyLlQRaXuaB8o1D8RhV4Pwj2FZwqHyPKaaHWkAehcQ2oEf7GLwGt7pxGIqliliT6sNjDxlOlw91vHWna2m4SplCTKZsiS2sjq9gctNMxzCSRLFXAt%2FYyfLy6I3SwVT2qBpnbbigFmuSgU4jrChjVcMyX5nnS7XasKeRQYql5T5opZD5G23mbEGNCtP8Q4ElC9luVf5D6cuI5yhf%2FYzHeul1Eb3lbK6tqdaU5sPJU%2BcSVG%2BOjFOZFs56pglhWkH5gUYUSIvaLff%2F6iMAp0yDfbYkE0riQTRabTUxbBkFbFYUqoKT2j85QIdIpwCoRDGwYBvIcRrZwNfBpSECU1bmBNlwQUeAPhaIptg%2BeoR6EUMQoxdfeoag3EXREWhX39KxnaMPAM8TkjPjE%2B%2Bju6FOoNXfRNntksz%2FQlZahxF7nCZL4z2DkQO1HcIIqdKC4BRPgciN3o3XhsGQGoBX4B%2ByDcSZlLcjPFjpnxBGylpMWNuQR2VZkWZfk2Zdp46mUbBfYuhrZxnVRLq1qiyhwDh5XKVmOxXZv2YC0n5coqV3o%2Fq1zVlWB0bR1KHoWrCD5gfFZRuIwc4ei%2B1jW043ooaZXYUR9XpmorheZ42av6gWQJx2qw%2Bzr2xRdglhcngWmnojatE33El%2FVdK23y5%2BEtf86W8Xe58E6d%2B%2Bg784Ynj%2F%2FvyaU4XA%2FCq4e07onX592r6TsT7rEuw2f9d4i0%2BB%2FEGGLo)
|
|
85
|
+
- [Clip](https://litecanvas.js.org?c=eJx1UE1LxDAUvPdXvNsmNEi2blnw4yCo215kwYJK6aG2qRssaUlTbZX9774mtbgHIR9vhuS9mamlEUWuPvKOUM%2BrelUY2SiQShpC4dsDGOAa1pxjNWK1DT2sXptBdIjSDEHVaCC1MCCR4Zd4XUHIp8L3XYv5w1nbdweS6lyVknAGT%2FFtElEGCxHdxbsoWZgNgy3NKDY44u7kl5ikBKF3%2FKO0b8vcCFIaN0pWQJKb%2FT5%2B2P3Ongwg9WzB6MDL3PSkVanzz9l0UXeET5OtZGoZ2RZSF2RgMDKrhs4Pz%2Bk%2FKTjXtVBv5nAShxaFqWRdE%2FsilVnKMwYLWCMIQrcXMrBJYA5GN%2B%2FCqZsstE1rBRoxmClEXKv7%2FePFyseTwYaixx%2BHoYO9)
|
|
86
|
+
|
|
87
|
+
_See other demos in [samples](samples) folder_
|
|
88
|
+
|
|
89
|
+
## Inspirations
|
|
90
|
+
|
|
91
|
+
- [floppy](https://github.com/lpagg/floppy): a micro game engine for beginners.
|
|
92
|
+
- [PICO-8](https://www.lexaloffle.com/pico-8.php): fantasy console for making, sharing and playing tiny games.
|
|
93
|
+
- [js13kGames](https://js13kgames.com/): a JavaScript coding competition with size limit set to 13 kilobytes.
|
|
94
|
+
- [raylib](https://www.raylib.com/): a simple and easy-to-use gamedev library.
|
|
95
|
+
- [p5.js/Processing](https://p5js.org/): a library for creative coding.
|