fruta 0.0.2 → 0.0.4

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.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +18 -14
  3. package/package.json +1 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2023 Jhornan Colina
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 CHANGED
@@ -1,9 +1,14 @@
1
- # Fruta 🍒 - Game Framework
1
+ # Fruta 🍒 (Alpha) - Game Framework [![npm version](https://badge.fury.io/js/fruta.svg)](https://badge.fury.io/js/fruta) ![NPM License](https://img.shields.io/npm/l/fruta)
2
2
 
3
3
  FrutaJs is a 2D game engine based on Canvas and WebGL that allows you to create animations, dynamic elements, and video games. Its main objective is to provide an easy-to-understand and dynamic syntax, which helps people to easily enter the world of development.
4
4
 
5
5
  The idea behind FrutaJs is to provide an additional layer on top of the existing functionalities of Canvas and WebGL, making it easier to use and allowing developers to focus on creating games and animations without having to deal with the technical complexity of these underlying technologies.
6
6
 
7
+ # Warning
8
+ <b>We are still working on many of the features that are still missing, such as animations, UI, gravity, etc. So please do not consider this as a complete version because it is not</b>
9
+
10
+
11
+
7
12
  # Install
8
13
 
9
14
  ```npm
@@ -13,21 +18,20 @@ npm i fruta
13
18
  # Usage
14
19
 
15
20
  ```
16
- import { fruta } from "fruta";
21
+ import Fruta from "fruta"
17
22
 
18
- const frutaC = fruta({
23
+ const config = {
19
24
  scene: {
20
25
  w: 500,
21
26
  h: 500,
22
- id: "main",
27
+ id: 'main',
23
28
  },
24
- });
29
+ }
25
30
 
26
- fruitC.Game.tick.OnRender((tick) => {
27
- // code
28
- });
29
- ```
31
+ const { FontCreator, ShapeCreator, Game } = Fruta(config)
30
32
 
33
+ // Code :)
34
+ ```
31
35
  # Current Short Doc
32
36
 
33
37
  The documentation I have to offer is somewhat early, basically explaining the return of each wrapper made for each method in the canvas.
@@ -36,11 +40,11 @@ It also includes examples where you can understand why things were done the way
36
40
 
37
41
  [Shape, Font and Image Methods](https://github.com/karttofer/Fruta/blob/FEATURE/readme/DOCUMENTATION.MD)
38
42
 
39
- # Important
40
-
41
- I am working hard to have a version one of all this ready, and also to create an API to make it easier to dive into what we are doing.
42
-
43
- So, don't despair, we will have more soon 😮
43
+ # UI Frameworks/Libraries Supported
44
+ <div style="display:flex;">
45
+ <img src="https://upload.wikimedia.org/wikipedia/commons/a/a7/React-icon.svg" width="50" height="50"/>
46
+ <img src="https://upload.wikimedia.org/wikipedia/commons/9/95/Vue.js_Logo_2.svg" width="50" height="50"/>
47
+ </div>
44
48
 
45
49
  # License
46
50
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "fruta",
3
- "version": "0.0.2",
3
+ "version": "0.0.4",
4
4
  "description": "Intuitive Video Game Library Aimed at HTML5 Development.",
5
5
  "browser": "./src/core/fruta.js",
6
6
  "scripts": {