Skip to content

iDev-Games/Gravity-JS

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Gravity.js

License

Gravity.js is a lightweight physics engine that renders using CSS. Configure physics bodies, collisions, and dynamics entirely through data attributes - no JavaScript required for basic physics interactions.

Perfect for creating browser-based games, interactive experiences, and physics simulations without the overhead of canvas rendering. Native DOM elements become physics bodies!


What is Gravity.js?

Gravity.js brings real physics to the browser using:

  • CSS Rendering: No canvas overhead - uses native DOM positioning
  • Data Attribute Configuration: Set up physics bodies with HTML attributes
  • Collision Detection: AABB
  • Zero Dependencies: Standalone library, works great with State.js and Keys.js
  • Lightweight: Minimal footprint, maximum performance

Features

Physics Body Types: Dynamic, Static, and Kinematic bodies ✅ Shape Support: Box (AABB) ✅ Realistic Physics: Mass, restitution, friction, forces, and impulses ✅ Collision Detection: Automatic collision resolution with events ✅ Collision Sensors: Trigger zones without physical response ✅ Collision Groups: Filter which bodies can collide ✅ CSS Variables: Access physics state in your CSS ✅ State.js Integration: Collisions trigger state changes ✅ Keys.js Integration: Player input for interactive games ✅ Sleep System: Bodies at rest are optimized automatically


Installation

NPM

npm i @idevgames/gravity-js

Direct Include

<script src="/js/gravity.js"></script>

CDN

<script src="https://cdn.jsdelivr.net/npm/@idevgames/gravity-js/src/gravity.js"></script>

Quick Start

Basic Physics Body

<div data-gravity data-gravity-type="dynamic">
    I'm a physics body!
</div>

Create a Ground

<div data-gravity data-gravity-type="static" style="position:absolute; bottom:0; width:100%; height:40px;">
    Ground
</div>

Complete Example

<!DOCTYPE html>
<html>
<head>
    <script src="gravity.js"></script>
</head>
<body data-gravity-world-gravity="9.8">
    <!-- Falling box -->
    <div data-gravity
         data-gravity-type="dynamic"
         data-gravity-mass="1"
         data-gravity-restitution="0.5"
         style="position:absolute; top:50px; left:100px; width:50px; height:50px; background:red;">
    </div>

    <!-- Static ground -->
    <div data-gravity
         data-gravity-type="static"
         style="position:absolute; bottom:0; width:100%; height:40px; background:green;">
    </div>
</body>
</html>

Physics Body Types

Set the body type with data-gravity-type:

Dynamic

<div data-gravity data-gravity-type="dynamic">
  • Affected by gravity and forces
  • Collides with all body types
  • Default body type

Static

<div data-gravity data-gravity-type="static">
  • Never moves
  • Infinite mass
  • Perfect for ground, walls, platforms

Kinematic

<div data-gravity data-gravity-type="kinematic">
  • Moves but has infinite mass
  • Not affected by forces
  • Perfect for moving platforms

Shape Types

Set collision shape with data-gravity-shape:

Box (AABB)

<div data-gravity data-gravity-shape="box">
  • Default shape
  • Uses element's width and height
  • Axis-aligned bounding box collision

Physics Properties

Mass

<div data-gravity data-gravity-mass="2">
  • Affects momentum and force response
  • Default: 1

Restitution (Bounciness)

<div data-gravity data-gravity-restitution="0.8">
  • How much velocity is retained after collision
  • Range: 0 (no bounce) to 1 (perfect bounce)
  • Default: 0.3

Friction

<div data-gravity data-gravity-friction="0.7">
  • Surface friction during collisions
  • Range: 0 (slippery) to 1 (sticky)
  • Default: 0.5

Density

<div data-gravity data-gravity-density="2">
  • Material density
  • Default: 1

Fixed Rotation

<div data-gravity data-gravity-fixed-rotation="true">
  • Prevents body from rotating
  • Useful for characters and upright objects
  • Default: false

Initial Velocity & Forces

Initial Velocity

<div data-gravity
     data-gravity-velocity-x="10"
     data-gravity-velocity-y="-5">
  • Set starting velocity
  • X: horizontal, Y: vertical

Continuous Forces

<div data-gravity
     data-gravity-force-x="2"
     data-gravity-force-y="0">
  • Applied every physics update
  • Use for constant propulsion

CSS Variables

Gravity.js exposes physics state as CSS variables for dynamic styling:

.my-element {
    /* Position */
    left: var(--gravity-x);
    top: var(--gravity-y);

    /* Rotation */
    transform: rotate(var(--gravity-rotation));

    /* Velocity-based effects */
    opacity: calc(var(--gravity-speed) / 100);

    /* Collision-based effects */
    background: calc(var(--gravity-collision) * 255, 0, 0);
}

Available CSS Variables

  • --gravity-x - Horizontal position (px)
  • --gravity-y - Vertical position (px)
  • --gravity-rotation - Rotation angle (deg)
  • --gravity-velocity-x - Horizontal velocity
  • --gravity-velocity-y - Vertical velocity
  • --gravity-speed - Total speed magnitude
  • --gravity-collision - 1 when colliding, 0 otherwise

Collision Detection

Collisions are automatically detected and resolved. When a collision occurs:

CSS Classes Added

.gravity-colliding {
    /* Applied to bodies currently in collision */
}

.gravity-collision-playerId {
    /* Applied when colliding with element id="playerId" */
}

Custom Events Dispatched

element.addEventListener('gravitycollision', (e) => {
    console.log('Collision with:', e.detail.other);
    console.log('Other ID:', e.detail.otherId);
});

element.addEventListener('gravityexit', (e) => {
    console.log('Stopped colliding with:', e.detail.other);
});

Data Attributes Updated

<!-- Automatically updated on collision -->
<div data-collision-with="coinId">

Collision Sensors (Triggers)

Create trigger zones that detect collisions without physical response:

<div data-gravity
     data-gravity-type="static"
     data-gravity-sensor="true"
     id="checkpoint"
     style="position:absolute; left:200px; top:100px; width:50px; height:50px;">
</div>

Perfect for:

  • Checkpoint zones
  • Collectible items
  • Trigger areas
  • Event zones

Collision Groups

Filter which bodies can collide:

<!-- Player group -->
<div data-gravity data-gravity-group="player"></div>

<!-- Enemy group -->
<div data-gravity data-gravity-group="enemy"></div>

<!-- Default group (collides with everything) -->
<div data-gravity data-gravity-group="default"></div>

Bodies only collide with:

  • Other bodies in the same group
  • Bodies in the default group

World Settings

Configure global physics on the <body> element:

<body data-gravity-world-gravity="9.8"
      data-gravity-world-gravity-x="0"
      data-gravity-world-gravity-y="9.8"
      data-gravity-damping="0.99"
      data-gravity-angular-damping="0.99">

World Attributes

  • data-gravity-world-gravity - Sets both X and Y gravity
  • data-gravity-world-gravity-x - Horizontal gravity (default: 0)
  • data-gravity-world-gravity-y - Vertical gravity (default: 9.8)
  • data-gravity-damping - Velocity damping (default: 0.99)
  • data-gravity-angular-damping - Rotation damping (default: 0.99)

JavaScript API

While Gravity.js works without JavaScript, you can use these methods for advanced control:

Apply Force

gravity.applyForce('playerId', 50, 0); // Apply continuous force

Apply Impulse

gravity.applyImpulse('playerId', 0, -300); // One-time force (jump)

Set Velocity

gravity.setVelocity('playerId', 10, 0); // Set velocity directly

Get Body Data

const body = gravity.getBody('playerId');
console.log(body.x, body.y, body.velocityX, body.velocityY);

Pause/Resume Simulation

gravity.pauseSimulation();
gravity.resumeSimulation();

Integration with State.js

Gravity.js works seamlessly with State.js for game state management:

<!-- Player with state tracking -->
<div id="player"
     data-gravity
     data-state
     data-state-watch="collision-with,velocity-x,velocity-y">
</div>

<!-- Coin sensor that triggers state changes -->
<div id="coin"
     data-gravity
     data-gravity-sensor="true"
     data-state
     data-state-trigger
     data-state-bind="score"
     data-state-increment="10">
</div>

<!-- Score display -->
<div id="score"
     data-state
     data-score="0"
     data-state-watch="score">
    Score: <span data-state-display="score">0</span>
</div>

When player collides with coin:

  1. Gravity.js detects collision
  2. Updates data-collision-with attribute
  3. State.js watches attribute change
  4. Increments score automatically

Integration with Keys.js

Combine with Keys.js for player input:

<script src="keys.js"></script>
<script src="gravity.js"></script>

<script>
    // Jump on spacebar
    document.addEventListener('keydown', () => {
        if (keys.isKeyDown('space')) {
            gravity.applyImpulse('player', 0, -300);
        }
    });

    // Move with arrow keys
    setInterval(() => {
        const vec = keys.getArrowVector();
        gravity.applyForce('player', vec.x * 50, 0);
    }, 16);
</script>

Complete Game Example

<!DOCTYPE html>
<html>
<head>
    <script src="state.js"></script>
    <script src="keys.js"></script>
    <script src="gravity.js"></script>
    <style>
        .player {
            position: absolute;
            width: 40px;
            height: 40px;
            background: blue;
        }
        .ground {
            position: absolute;
            bottom: 0;
            width: 100%;
            height: 40px;
            background: green;
        }
        .coin {
            position: absolute;
            width: 30px;
            height: 30px;
            background: gold;
            border-radius: 50%;
        }
        .coin.gravity-colliding {
            display: none;
        }
    </style>
</head>
<body data-gravity-world-gravity="9.8">
    <!-- Score -->
    <div data-state data-score="0" data-state-watch="score">
        Score: <span data-state-display="score">0</span>
    </div>

    <!-- Player -->
    <div id="player" class="player"
         data-gravity
         data-gravity-type="dynamic"
         data-gravity-mass="1"
         data-gravity-fixed-rotation="true"
         style="top:100px; left:100px;">
    </div>

    <!-- Coin -->
    <div id="coin" class="coin"
         data-gravity
         data-gravity-type="static"
         data-gravity-sensor="true"
         data-gravity-radius="15"
         data-state
         data-state-trigger
         data-state-bind="score"
         data-state-attr="score"
         data-state-increment="10"
         style="top:200px; left:300px;">
    </div>

    <!-- Ground -->
    <div class="ground"
         data-gravity
         data-gravity-type="static">
    </div>

    <script>
        // Jump on spacebar
        document.addEventListener('keydown', () => {
            if (keys.isKeyDown('space')) {
                gravity.applyImpulse('player', 0, -300);
            }
        });

        // Move with arrow keys
        setInterval(() => {
            const vec = keys.getArrowVector();
            if (vec.x !== 0) {
                gravity.applyForce('player', vec.x * 100, 0);
            }
        }, 16);
    </script>
</body>
</html>

Browser Support

Gravity.js works in all modern browsers:

  • Chrome/Edge (latest)
  • Firefox (latest)
  • Safari (latest)

Requires:

  • ES6 class support
  • requestAnimationFrame
  • CSS custom properties (variables)
  • Map and Set

Performance

Gravity.js is optimized for performance:

  • ✅ Spatial grid for broad-phase collision detection
  • ✅ Sleep system for bodies at rest
  • ✅ Efficient attribute caching
  • ✅ Fixed timestep physics simulation
  • ✅ requestAnimationFrame for smooth rendering

Companion Libraries

Complete Browser Game Engine Stack

Gravity.js (Physics) Physics simulation, collision detection, and dynamics

State.js (State Management) Game state, variables, and reactive data binding

Keys.js (Input) Keyboard input handling and key state tracking

Together they form a complete, zero-dependency game engine for the browser!


Data Attribute Reference

Body Configuration

Attribute Type Default Description
data-gravity - - Enables physics on element
data-gravity-type dynamic|static|kinematic dynamic Body type
data-gravity-shape box box Collision shape
data-gravity-mass number 1 Body mass
data-gravity-restitution 0-1 0.3 Bounciness
data-gravity-friction 0-1 0.5 Surface friction
data-gravity-density number 1 Material density
data-gravity-fixed-rotation boolean false Prevent rotation
data-gravity-sensor boolean false Trigger-only collider
data-gravity-group string default Collision group

Initial Motion

Attribute Type Default Description
data-gravity-velocity-x number 0 Initial horizontal velocity
data-gravity-velocity-y number 0 Initial vertical velocity
data-gravity-force-x number 0 Continuous horizontal force
data-gravity-force-y number 0 Continuous vertical force

World Settings (on <body>)

Attribute Type Default Description
data-gravity-world-gravity number 9.8 Global gravity (X and Y)
data-gravity-world-gravity-x number 0 Horizontal gravity
data-gravity-world-gravity-y number 9.8 Vertical gravity
data-gravity-damping 0-1 0.99 Velocity damping
data-gravity-angular-damping 0-1 0.99 Rotation damping

License

MIT License - feel free to use in personal and commercial projects!


Author

Created by iDev Games

Follow for updates:


Contributing

Contributions welcome! Please open issues and pull requests on GitHub.


Gravity.js - Turn the browser into a physics-powered game engine! 🎮⚡

About

Gravity.js is a lightweight physics ending that renders using CSS.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors