npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@quarrelgame-framework/common

v1.0.0

Published

A flamework-based flamework for combat game development.

Downloads

9

Readme

Quarrel Game Framework - QGF 💥

Quarrel Game Framework is a series of runtimes that allow developers to create a variety of hand-to-hand combat games similar to other games like Black Magic II, Guilty Gear Strive, and Under Night In-Birth.

Todo

  • [x] 3D Camera
  • [x] 2D Camera

  • [x] Input Registry
  • [x] Frame Data
  • [x] Attack Execution
  • [x] Custom Characters and Movesets
  • [x] Motion Inputs
  • [x] Command Inputs
  • [x] Entities and Combatants
  • [x] Match System Logic
  • [x] Jumping
  • [x] Hitboxes
  • [x] Disjoint Hitboxes
  • [x] No Physics Bouncing
  • [x] Combo Choreography - Gatling / BEAT!
  • [x] Motion Input Controller Overhaul
  • [ ] Entity System Rewrite - Client-side Gameplay, Rollback Templating (Velocity, State Changes)
  • [ ] Combo Choreography - Air Combos
  • [ ] Combo Choreography - Blocking
  • [ ] Combo Choreography - Perfect Blocking
  • [ ] Motion Input Overhaul: Charge Inputs, Charge Inputs with min/max Timing**
  • [ ] Hurtbox Support
  • [ ] Double Jumping
  • [ ] "Matchmaking" System
  • [ ] Attack Cinematics
  • [ ] Defense Cinematics
  • [ ] Animations - On-Demand Inverse Kinematics (grabbing, pinning, etc)
  • [ ] Chickynoid Integration
  • [ ] Rollback Netcode (use Chickynoid)
  • [ ] Component Garbage Collection

Usage

This project depends on Flamework. Flamework is a framework designed to make games simpler to create using a singleton and component structure.

To get started with this package, first install it:

yarn add @rbxts/quarrelgame-framework
npm install @rbxts/quarrelgame-framework

After the package is installed, you'll notice that it does quite a bit of.. nothing.

This project doesn't do much on its own, and it definitely will not be your easy break into making your own fighting game without the adequate knowledge.

This project exports a variety of singletons for the server and the client that can be used as dependencies or superclasses for your own modules. Some singletons are not meant to be used as a superclass; this will be described in the documentation and in the intellisense.

The core of the client is the Client controller. This controller has a variety of methods to handle players and their operations, like events and functions:

export function ExampleFunction()
{
    const { character } = Dependency<Client>();
    character.BreakJoints();
}

On the server, the core is represented through the QuarrelGame service. The QuarrelGame service is a singleton that handles most events that need to be functional immediately when the framework starts. These events have a default functionality, but they can be modified as long as they return the same type as the default. The QuarrelGame service also is intended to automatically add components that are integral to the background functionality of the framework.

To see more regarding the usage of this package, please observe Quarrel Game.