Skip to content

bootgly/bootgly-console

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

25 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

bootgly-logo

Bootgly Console

Bootgly Console Platform.

Bootgly License

Bootgly Console Platform composed by the CLI interface.

The opinionated TUI layer over Bootgly\CLI: an application shell for full-screen terminal apps and a module for terminal games. Everything it wires remains plain CLI underneath.

Getting started

Use the canonical installer β€” it sets up a bootgly.kit workspace, where the platforms are unified, and asks which ones to enable (pick Console):

curl -fsSL https://bootgly.com/install | bash

From the kit, the project wizard imports this platform's demo projects (Import projects from Platforms β†’ Console):

php bootgly project create

⚠️ Using this repository directly is discouraged β€” bootgly.kit is the starting point: it is where the Bootgly core and the platforms are mounted and booted together. See Getting started. Cloning bootgly-console standalone is only meant for developing the platform itself.

Modules

  • Console\App β€” the TUI application shell: terminal lifecycle (alternate screen, raw input, resize, restore-on-exit), Screens + Router navigation, Keymaps with chords, Statusbar, Toasts, command Palette and log Tail.
  • Console\Games β€” the game shell over App: fixed-timestep Loop, diff-rendered Canvas, held-key Keyboard heuristics, Scenes, Sprite sheets and 2D math (Vector, Zone).

Demo projects (exportable)

Project Shows
Snake Classic Snake β€” Games module basics: loop, canvas, held-key steering
Pong Pong vs AI β€” paddles, ball physics, scenes
Invaders Space Invaders β€” sprite sheets and 2D math (hitboxes)

After importing them in the kit:

php bootgly project Snake start

Developing the platform

Only for working on bootgly-console itself (with the bootgly core as a sibling checkout):

./bootgly test                                # test suites
vendor/bin/phpstan analyse -c @/phpstan.neon  # static analysis
./bootgly project Snake start                 # run a demo

Documentation β€” see the Console Platform guide and the Console manual pages.

About

πŸ—οΈ Bootgly Console πŸ“Ÿ platform (bootable)

Resources

Stars

Watchers

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages