GameViz HyperKit

GameViz HyperKit is a lightweight Python SDK for creating 2D hypercasual and hybrid-casual game prototypes quickly.

It is designed for beginners, students, game-jam developers, indie developers, and small teams who want to test simple mobile-style game ideas using Python.

HyperKit is not a full game engine like Unity, Unreal Engine, or Godot.
It is a prototype-focused SDK with reusable systems, helper modules, and ready-made templates.

---

Current Release Status

HyperKit is publicly available on PyPI and remains in active alpha development.

Current package status:

• Current package version: 0.2.0
• Installation command: pip install gameviz-hyperkit
• Package maturity: Alpha / early SDK preview
• API stability target: future 1.0.0
• Supported Python versions: Python 3.9–3.12

HyperKit 0.2.0 establishes the core SDK architecture, including runtime context, structured logging, project configuration, platform detection, lifecycle management, deprecation support, and a protected public API contract.

HyperKit is suitable for learning, prototyping, game jams, and early 2D mobile game development. It is not yet intended to replace a full production game engine.

---

Package Identity

• Package name: gameviz-hyperkit
• Import name: hyperkit
• CLI command: hyperkit
• License: MIT

---

Project Links

• PyPI Package
• GitHub Repository
• Issue Tracker
• Changelog
• Version History

---

Who Is HyperKit For?

HyperKit is useful for:

• Learning 2D game development with Python
• Building quick hypercasual game prototypes
• Creating tap, swipe, runner, puzzle, quiz, and physics-style demos
• Testing simple game concepts before moving to a larger engine
• Building game-jam and educational projects
• Students and indie developers who want a small code-first game toolkit

---

Main Features

• 2D game project structure
• Scene system
• GameObject system
• Tap and click input
• Swipe input
• Input action mapping
• Score and high-score system
• Save and persistence system
• Collision helpers
• Simple physics helpers
• Text labels and basic UI helpers
• Responsive virtual canvas scaling
• Asset loading helpers
• Image rendering support
• Audio playback helpers
• Tween and animation helpers
• Sprite animation helper
• Particle helper
• Camera shake helper
• Scene transition helper
• Timer and cooldown helpers
• Level data loading helper
• Camera follow helper
• Screen and world-bound helpers
• UI progress bar helper
• CLI project generator
• Ready-made starter templates
• Generated-project validation
• Project health and release validation commands
• Experimental Android build configuration

---

Installation

Install from PyPI

pip install gameviz-hyperkit

Verify the installation:

hyperkit doctor
hyperkit list-templates

Install for Local Development

Clone the repository:

git clone https://github.com/RifatGameDev/gameviz-hyperkit.git
cd gameviz-hyperkit

Install HyperKit in editable development mode:

pip install -e ".[dev]"

Run the tests:

pytest

---

Quick Start

Create a Tap Counter project:

hyperkit new my-game --template tap-counter
cd my-game
hyperkit run

You may also launch the generated project directly:

python main.py

The name my-game is only an example. You can choose another project name:

hyperkit new flappy-project --template flappy-mini
cd flappy-project
hyperkit run

Generated projects include:

my-game/
├── main.py
├── README.md
├── hyperkit.toml
└── assets/
    ├── README.md
    ├── images/
    ├── audio/
    ├── fonts/
    └── data/

---

Available Templates

List all templates:

hyperkit list-templates

Template	Command Name	Description
Tap Counter	tap-counter	Tap or click scoring prototype
Flappy Mini	flappy-mini	Flappy-style tap-to-jump prototype
Swipe Runner	swipe-runner	Three-lane swipe runner prototype
Puzzle Game	puzzle-game	Color-matching puzzle prototype
Quiz Game	quiz-game	Educational quiz prototype
Simple Physics	simple-physics	Gravity, bounce, and coin-collection prototype

Underscore-style aliases are also accepted:

tap_counter
flappy_mini
swipe_runner
puzzle_game
quiz_game
simple_physics

---

Basic Example

from hyperkit import Game, GameObject, Scene, ScoreManager, TextLabel


class MyScene(Scene):
    def start(self):
        self.score = ScoreManager(
            high_score_key="my_game_high_score"
        )

        self.player = self.add(
            GameObject(
                x=300,
                y=500,
                width=100,
                height=100,
                color=(0.2, 0.75, 1.0, 1),
                shape="circle",
            )
        )

        self.score_label = self.add(
            TextLabel(
                x=30,
                y=1180,
                text="Score: 0",
                font_size=32,
                color=(1, 1, 1, 1),
            )
        )

        self.start_game()

    def on_tap(self, x, y):
        self.player.x = x - self.player.width / 2
        self.player.y = y - self.player.height / 2

        self.score.add(1)
        self.score_label.set_text(
            f"Score: {self.score.value}"
        )


game = Game(
    title="My HyperKit Game",
    width=720,
    height=1280,
)

game.set_scene(MyScene())
game.run()

---

Asset Folders

Generated HyperKit projects use this asset structure:

assets/
├── images/
├── audio/
├── fonts/
└── data/

Folder	Supported Types
assets/images	.png, .jpg, .jpeg, .webp
assets/audio	.wav, .mp3, .ogg
assets/fonts	.ttf, .otf
assets/data	.json, .csv, .txt

FBX files are not directly supported.
For 2D projects, export source assets as PNG images, animation frames, or sprite sheets.

---

CLI Commands

Check the environment

hyperkit doctor

List templates

hyperkit list-templates

Create a project

hyperkit new my-game --template tap-counter

Enter the generated project

cd my-game

Run the project

hyperkit run

Show project metadata

hyperkit info

Validate the current project

hyperkit validate

Show the package health report

hyperkit health

Show release readiness

hyperkit release-check

Run the final pre-release audit

hyperkit pre-release-audit

Validate built-in templates

hyperkit validate-templates

Validate generated projects

hyperkit validate-generated-projects

Validate manual QA evidence

hyperkit validate-release-evidence

Require complete QA evidence

hyperkit validate-release-evidence --require-complete

Create experimental Android configuration

hyperkit init-android

Run the experimental Android build workflow

hyperkit build android

---

Development Commands

Install development dependencies:

pip install -e ".[dev]"

Run the complete test suite:

pytest

Build the wheel and source distribution:

python -m build

Validate the distribution files:

python -m twine check dist/*

Package publication is handled through the project's controlled release workflow.

---

Documentation

• Version History
• Changelog
• Templates Guide
• Template Helper Usage Guide
• Template Quality Checklist
• Release Readiness Checklist
• Generated Project Smoke Tests
• Project Health Report
• Release Build Automation
• Final Pre-release Audit
• Beginner Quick Start Tutorial
• Template Media Guide
• Template Screenshots and Demo Media
• CLI Error Messages
• Template Validation
• Production Template Polish Checklist
• Template Stabilization Checklist
• Template Manual QA Checklist
• Manual QA Result Template
• Release Evidence Structure
• Release Evidence Workspace
• Roadmap to HyperKit 1.0

Template Polish and Runtime Documentation

• Tap Counter Polish - Phase 48
• Flappy Mini Polish - Phase 49
• Swipe Runner Polish - Phase 50
• Puzzle Game Polish - Phase 51
• Quiz Game Polish - Phase 52
• Simple Physics Polish - Phase 53
• Template Polish Summary - Phase 54
• Generated Project Validation - Phase 55
• Template Runtime Readiness - Phase 56
• Runtime QA Tracker - Phase 58

---

Current Limitations

• HyperKit is not a complete general-purpose game engine.
• Advanced 3D rendering is not supported.
• Android APK build support remains experimental.
• AdMob and analytics helper systems are not implemented yet.
• The current focus is 2D hypercasual and hybrid-casual prototypes.
• Templates are intended for learning and prototyping rather than finished commercial production.
• The public API may change before version 1.0.0.

---

Roadmap

Planned improvements include:

• Better beginner documentation
• More polished starter templates
• Template screenshots and animated demonstrations
• Stronger asset and audio workflows
• Improved mobile project structure
• Android build workflow improvements
• AdMob integration helpers
• Analytics integration helpers
• Additional complete example games
• More automated package compatibility testing
• Stable API milestone for version 1.0.0

---

Contributing

Contributions, issue reports, and improvement suggestions are welcome.

Before submitting changes:

pip install -e ".[dev]"
pytest

Use the issue tracker to report bugs or request features.

---

License

GameViz HyperKit is distributed under the MIT License.

See LICENSE for details.

---

Author

Developed by Md. Rifat Hossain Chowdhury / GameViz.

• GitHub: RifatGameDev
• PyPI package: gameviz-hyperkit