@bigby/cli
npm i @bigby/cli

@bigby/cli

🕹 The Adequately Astonishing HTML5 Game Development Framework!

by bigby-framework

0.6.0-alpha.7 (see all)License:MITTypeScript:Not Found
npm i @bigby/cli
Readme

bigby

The Adequately Astonishing HTML5 Game Development Framework

npm CI

Summary

🚧 WARNING: UNDER CONSTRUCTION! 🚧

Bigby is a JavaScript/TypeScript framework for the rapid development of HTML5 games. It is currently under heavy development, which is why I'm humbly asking you to not take anything you're seeing here too seriously, as the whole project is going to remain very much in flux for a little while longer. If you want to follow development, please follow @hmans and/or @BigbyFramework on Twitter. Thanks!

Resources

Features / Progress

  • Written in TypeScript, use it with any flavor of JavaScript.
  • Build super-high-performance 2D games (powered by Pixi.js)
  • Simple resource loading
  • Spritesheet support
  • 2D physics
    • Basic physics support
    • Collision management
    • Circle colliders
    • Box colliders
    • Polygon colliders
    • PhysicsEditor import
  • Spatial audio
  • Game controller support

Planned for the future:

  • Networking Layer (use Bigby on the server)
  • 3D support

Structure of this repository

Bigby is split into a collection of packages that are all developed in sync as part of this monorepo:

  • @bigby/core: just the core classes, no game-specific functionality.
  • @bigby/game: the core game engine (2D rendering, sprites, shaders, ...)
  • @bigby/physics2d: 2D physics
  • @bigby/random: A collection of utility functions for generating various kinds of random values.
  • @bigby/timers: Timer-related utility behaviors (eg. Timer, AutoDestroy, Cooldown)
  • @bigby/logger: A Logger behavior that provides an interface to the current environment's logging capabilities.

It is all tied together by the bigby master package, which merely serves as a convenient entrypoint to the framework.

Contributing

🚧 Reminder: Bigby is currently under heavy construction. If you want to contribute, please get in touch first before you start work on your PR. Bigby is moving very fast at the moment, and chances for getting unannounced PRs merged are relatively low.

To get started, clone the repository, and run the following commands:

yarn install  # installs all dependencies
yarn build    # performs an initial build of all packages
yarn dev      # fires up dev/watch mode for everything

"Style Guide"

Not meant as a complete style guide, but we're trying to follow these rules within the repository:

  • Functionality is split into small/micro packages where it makes sense. Specifically, it is assumed that someone building a game with Bigby generally has a very specific idea of the feature set they want to use, and we don't want to force dependencies/imports on them that they won't need.
  • @bigby/* packages are written in TypeScript and compile to ES6 CommonJS modules only, for the time being.
  • Each class lives in its own file of the same name (e.g. Behavior.ts for Behavior.) The class is always the module's default export.
  • Each package's index offers named exports of all classes contained in the package.

Downloads/wk

13

GitHub Stars

11

LAST COMMIT

2yrs ago

MAINTAINERS

1

CONTRIBUTORS

0

OPEN ISSUES

0

OPEN PRs

13
VersionTagPublished
0.6.0-alpha.7
latest
2yrs ago
No alternatives found
No tutorials found
Add a tutorial