201flaviosilva / impacto

A modular javascript canvas render

Impacto

Table of Contents

• Impacto
  • Table of Contents
  • Description
  • Get Started

Description

Impacto is a simple render engine for HTML5 canvas. If you have any questions please ask in Discussions (Forum)

Get Started

To get started, you need to install Impacto by NPM Package:

npm install impacto

Use the lib in your project:

import Impacto from "impacto"; // Import the Impacto lib

// Create a simple scene 
class MyScene extends Impacto.Scene {
	start() {
		const myRect = new Impacto.GameObjects.Rectangle(400, 300, 50, 50, "#ff0000"); // Create a red rectangle at position (400x, 300y) with size (50x, 50y)
		this.addChild(myRect); // Add the rectangle to the scene
	}

	update() {
		this.rect2.setAngle(this.rect2.angle + 1); // Rotate the rectangle
	}
}

const game = new Impacto.Game({
	width: 800, // Width of the canvas
	height: 600, // Height of the canvas
	backgroundColor: "#f0f0f0", // Background color of the canvas
	scene: MyScene, // The scene to be rendered
});

For more information about the Impacto API, please check the Doc or check the examples.

impacto's Issues

[Engine]: Document Code (JSDocs)

JSDocs

• Impacto.js
• Game.js
• Core
  • CoreGameManager.js
• GameObjects
  • GameObject2D.js
  • Types.js
  • GameObjects.js
  • AudioPlay
    • AudioPlay.js
  • Circle
    • Circle.js
  • Line
    • Line.js
  • Polygon
    • Polygon.js
  • Rectangle
    • Rectangle.js
  • Sprite
    • Animation.js
    • Animations.js
    • Sprite.js
  • Text
    • Options.js
    • Text.js
  • Triangle.js
    • Triangle.js
• Inputs
  • Inputs.js
  • Keyboard.js
  • Keys.js
  • Mouse.js
• Scenes
  • Scene.js
• State
  • AssetsManager.js
  • CanvasState.js
  • GlobalStateManager.js
  • State.js
• Utils
  • Math.js
  • Utils.js

[Engine]: Preload Images

Create a function to preload images

[Engine]: Set position with an origin other than 0

[Engine]: Rotate Game Object

https://www.w3schools.com/tags/canvas_rotate.asp

[Doc]: Create a Home

Fix created plugin "jsdoc2docusaurus"

Check this:

• https://github.com/tgreyuk/typedoc-plugin-markdown/blob/master/packages/docusaurus-plugin-typedoc/src/plugin.ts
• https://docusaurus.io/docs/using-plugins#installing-presets
• https://docusaurus.io/docs/api/plugin-methods#plugin-constructor

Triangle;

[Bug]:

Engine Version
0.9.0

Describe the bug
If you CD into docs and run npm start the beautiful Docusaurus site displays on localhost 3000. However, if you run npm run build and npm run serve, a plain looking JSDoc site gets served instead. Somehow the Docusaurus site does not get served outside of your local environment.

To Reproduce
Steps to reproduce the behavior:

1. CD into docs
2. Run npm run build
3. Run npm run serve
4. You will see a plain JSDoc site

Expected behavior
I expect the exact same, beautiful Docusaurus site to get served outside of my local environment.

Screenshots
npm start displays the correct Docusaurus site:

npm run build and npm run serve only displays a JSDoc site:

Desktop (please complete the following information):

• OS: MacBook Pro M1 chip
• Browser: Chrome

Additional context
I saw your comments on Docusaurus threads and I've followed many discussions. However, I think both you and I know how unclear some documentation can be for people who are just getting started.

Framework for tests?

Hey there :)

Does anyone have any idea what might be the most suitable tool for testing this project?
I have a little experience in "jasmine", but nothing too relevant.

(If anyone ever sees this and responds, I would be very happy 😅 )

[Engine]: Scale Game Object

https://www.w3schools.com/tags/canvas_scale.asp

Polygon Static Game Object

Some help code used originally for triangle:

import GameObject from "../GameObjectBase.js";
import { CanvasInstance } from "../../Utils/Canvas.js";
import Types from "../Types.js";

export default class Triangle extends GameObject {
	constructor(x, y, vertex1, vertex2, vertex3, fillColor = "#ffffff", strokeColor = "#000000") {
		super(x, y, fillColor, strokeColor);
		this.vertex1 = vertex1;
		this.vertex2 = vertex2;
		this.vertex3 = vertex3;

		this._type = Types.triangle
	}

	get x() { return this._x; }
	get y() { return this._y; }

	// Private
	_renderType() {
		CanvasInstance.context.save();
		CanvasInstance.context.translate(this.x, this.y);

		CanvasInstance.context.beginPath();
		CanvasInstance.context.moveTo(this.vertex1.x, this.vertex1.y);
		CanvasInstance.context.lineTo(this.vertex2.x, this.vertex2.y);
		CanvasInstance.context.lineTo(this.vertex3.x, this.vertex3.y);
		CanvasInstance.context.closePath();
		CanvasInstance.context.stroke();
		CanvasInstance.context.fill();

		CanvasInstance.context.restore();
	}
}

[Engine]: Draw Sprites (Block by Preload function)

Blocked by: #41

[Repository]: Community Standards

https://github.com/201flaviosilva/Impacto/community

• Template issues
• Ex: .npmignore
• ChangeLog
• Update Readme.md
• Code of conduct
• Project description
• Awesome Impacto :,)
• Start Doc with Docusaurus
• GitHub Action (Export and Artifact)
• package.json keywords

[Engine]: Draw objects and Physics objects

Draw Objects:

Simple objects with no physics.
Example:

• Text;
• Triangle;
• Circle;
• Square;
• Etc...;

These objects can:

• Change position;
• Scale;
• Rotate;

Physic Objects:

Objects with are affected by collisions, gravity, etc...
For now, just 2 objects supported:

• Circle;
• Square;

These objects can:

• Everything the other objects do, but will only render, the physics (for now) will not scale and rotate, (only position).

Refs:

• Stackoverflow - ES6 Class Multiple inheritance;

Text;

[Engine]: Draw Sprite Sheet (Block by Preload function)

Blocked by #41 and #42 and #43

Line;

[Engine]: Change Game Gravity

Copy the CHANGELOG and awesome-impacto to docusaurus docs

Create a new docusaurus plugin to do this auto task :)

[Engine]: Change Canvas Background color

[Engine]: Preload function

Create a preload function to load assets:

• #42
• #47
• #49

[Engine]: New Statics Game Objects

New Statics Game Objects:

• #27
• #26
• #28
• #29
• #30

[Engine]: Pause Engine

Preload Sounds

Rounded Rectangle;

Reference: https://stackoverflow.com/questions/1255512/how-to-draw-a-rounded-rectangle-using-html-canvas

Preload Fonts

[Engine]: Center Rectangle (Pivot Point / Anchor / Origin)

Fix the rectangle position to the center and create 2 new proprieties to the game object:

• realX: Represents the real X position in the canvas of the rectangle;
• realY: Represents the real Y position in the canvas of the rectangle;

[Doc]: Auto update GitHub pages on commit

[Engine]: Remove "Plugins" code

Remove and adapt:

• Physics Code
• "Draw" utils class
• Vector2
• Examples
• Etc...

[Engine]: Code improve and organization

• Change "SceneManager" to "GameManager"
• Change GameObejctBase to GameObject2D
• AudioSound delay property
• Add a set X and Y to the game object base

[Engine]: Flipped/Mirror