# grapefruit

**Repository Path**: mirrors_floatdrop/grapefruit

## Basic Information

- **Project Name**: grapefruit
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2026-05-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# GrapeFruit Game Engine

The game engine that powers [lttp-webgl](https://github.com/englercj/lttp-webgl) and [shiv](https://github.com/englercj/shiv).

The goal of this project is for users to be able to make a game with minimal programming and judicious use 
of the [Tiled Map Editor](http://mapeditor.org); while at the same time providing a powerful API for creating
intense and complex 2D games.

Some features that GrapeFruit gives you:

 - WebGL rendering with Canvas Fallback
 - Entity and Tilemap Collisions
 - GUI/HUD system
 - Texture Fonts
 - Support for keyboard, mouse, and gamepad input
 - Channeled audio playback
 - Tiled Map Editor integration
 - Plugin system
 - much more!

## Current State

This project is under heavy development, and the API is subject to change at any time. Check the GitHub issue list
to see what is needed to reach `v0.1.0`, the first unstable release.

## Coming Features

Grapefruit is still a baby, and it is only me working on it in my spare time, so I know it is missing a lot of features.
Below is a list of the features I want to add in. If there is something else I missed, please open
an [Issue](https://github.com/englercj/grapefruit/issues) and we can talk about it.

Soon to come:

- Tilemap Collisions (in there, but wonky)
- Entity Collisions (may convert to QuadTree Interactions)
- Multiple Cameras
- More Entity Physics (like elasticity, and buoyancy)
- Sprite Sheet Animations (without forcing TexturePacker format)

Coming in the future:

- Path Finding
- Touch Gestures
- Particle System
- Game State System
- Generic Text (non-texture based font)

## Rendering Engine

Under the hood gf uses [Pixi.js](https://github.com/GoodBoyDigital/pixi.js) for low-level WebGL Rendering. If you
haven't heard of this library I suggest you check it out, it is a super performant 2D rendering engine. It is what
allows gf to fallback to canvas and support a larger audience.

## License

The MIT License

Copyright (c) 2013-2014 Chad Engler

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.