https://github.com/nrkn/chonkpix

A stupidly simple chonky pixel engine
https://github.com/nrkn/chonkpix

Last synced: 3 months ago
JSON representation

A stupidly simple chonky pixel engine

• Host: GitHub
• URL: https://github.com/nrkn/chonkpix
• Owner: nrkn
• License: mit
• Created: 2025-02-25T20:37:40.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2025-02-25T21:16:20.000Z (3 months ago)
• Last Synced: 2025-02-25T21:32:59.635Z (3 months ago)
• Language: TypeScript
• Size: 0 Bytes
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# chonkpix

 

a stupidly simple chonky pixel engine

defers pretty much everything to the scene, just provides a basic harness

for interacting with the browser, handling input, timing, rendering etc

includes extensive lib for pixel bashing etc

## done

- engine

  - input

    - keyboard

    - mouse

  - timing

    - elapsed

    - frameTime

  - rendering

    - imageData as frame buffer

    - pixel scaling via zoom setting

  - start scene

  - tear down scene

- scenes

  - image test scene

  - text/terminal test scene

  - scene compositor (just basic horizontal split for now)

  - palette test scene

- scene manager

  - move between scenes (basic, just toggle through list for now)

- drawing library

  - blit

  - composite

  - fill

  - line 

  - triangles

  - more

- palettes

  - generate palettes

  - LUTs  

- text/bitmap fonts

  - mono

  - proportional

  - layout

- terminal

  - backed by buffer

  - clear

  - append

  - appendLine

  - backspace

  - view 

    - take (cols,rows) and slice bottom of buffer to available space

- come up with a name

  - we went with chonkpix

## todo

- engine

  - sound, via small sound library like ZzFX or similar

- terminal

  - cursor

  - scroll  

  - delete

  - history

  - add more

- quickstart 

  - very simple 'how to do things' while it is in flux

- examples

  - just fun or to demo features at first

- write rest of todo list - ref chat

## ideas/maybe todo

- write ideas list - ref chat

## todo when stable

don't do these while everything is changing around all the time!

- documentation

- examples tailored to understanding engine and library

## MIT License

MIT License

Copyright (c) 2025 Nik Coughlin

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.