Skip to content

A small suite of tools to generate retro JRPG-style windows and window layouts for streamers.

License

Notifications You must be signed in to change notification settings

codergal6502/ChocoWindow

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

118 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ChocoWindow

A small suite of tools to generate retro JRPG-style windows and window layouts for streamers.

Table of contents

Introduction

ChocoWindow exists to make it easier for retro streamers to create backgrounds reminiscent of the windows used in the JRPGs of 8- and 16-bit platforms.

Using ChocoWindow in your Projects

Download ChocoWindow.js and include it in your web page. You will have to supply your own spritesheet and corresponding ChocoWinTileSet definitions.

Examples

For an example of using the library, please see the Six Window Sample. It demonstrates tile scaling and color substitution.

Running Examples or Studio Locally

If you want to run the examples or Choco Window Studio locally, you first must make symbolic links for ChocoWindow.js in those applications' directories. This can be done by running make-javascript-shortcuts.sh. The .gitignore files are already set up to ignore the symbolic links. Examples can be run using your favorite simple static HTTP server such as http-server. Choco Window Studio requires npm.

License

Copyright 2025, 2026

This project is distributed under the terms of the GPL-3.0 License. The license applies to this file and other files in the GitHub repository hosting this file.

Acknowledgments

Special thanks to The Spriters Resource, which hosts sprites and other images. Thanks also to to Michael Hucka for the README template upon which this README is based. Thanks to vaibhav chandra for free, open-source window code used as the basis for the example project.

About

A small suite of tools to generate retro JRPG-style windows and window layouts for streamers.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages