🍃 Hack Club Sprig 🍃

Sprig is a web-based environment for creating tile games. These games run in the browser and on the Sprig Console, a game console where every user is a creator. The only way to obtain a Sprig console is to make a game for it and share it in the Sprig Gallery

Philosophy

As we have said previously, people learn best when they make things that they care about, which they can then share with others. This type of learning philosophy is called constructionism, and Sprig is a type of microworld. A microworld is an environment where you can discover programming by using it to express yourself.

This creative expression takes place in Sprig through game development, allowing users to become creators and make their own games or remix an existing one.

Development

Join the #sprig channel on the Hack Club Slack where you can join the development discussion and ask for help.

We use vite for development.

Clone repo:

$ git clone https://github.com/hackclub/sprig/

To run:

cd sprig
yarn
yarn dev

Visit http://localhost:3000 in your web browser and it should work!

License

The Hack Club Sprig is open source and licensed under the MIT License. Fork, remix, and make it your own! Pull requests and other contributions greatly appreciated.

TODO

now

• empty bitmap should be editable
• fullscreen the game
• style the upload flow
• monkeypatch setInterval
• preview maps
• previews don't update accordingly
• simplify api
  • single character references are confusing
  • matching and replacing can be done manually, more programmatic in a way
  • how to handle maps with multiple sprites in one tile
• map editor
  • render combos
  • add rows and columns
  • under certain conditions editor sets text in wrong range

at some point

• first line bitmap not previewed
• feedback on user inputs
• better error logging
• console
• When typing in browser console get: "Possible side-effect in debug-evaluate" (add error event handler)
• play on phone

maybe

• use index of legend as key in map

• make legend, solids, tilesWith all variadic instead of taking lists

• add ability to delete saved files

• Across all editors, right click to erase

• Exporting:

  • HTML
  • Link

• Remove set size function

• Make sure everything matches docs in general

• BPM isn't a thing anymore, fix that

• Are stacks exclusive or inclusive? Do they replace the whole cell?

• Why does replacePattern return a boolean and not a count?

• Does addSprite add to the front or the back?

• Should we get rid of all the old Game Lab remnants?

• Does patternMap match stack behavior (can you pass a single or an array)?

• Warning when interpolating in tags

• GFM blockquote support

• Code highlighting (should match CodeMirror?)

• Styles for blockquotes

• Styles for images

• Interactive table of contents

• Backwards compatibility / tile engine

• Example games / gallery

• Since docs have moved, the README feels quite skeleton-like... what can we do to improve this?

  • Add images!

• Screen sizes

• Non-cursor interactions for ipad and chromebook

• Make sure if the mouse is unpressed outside an editor canvas that's registered (we need global listeners and proper cleanups to prevent memory leaks)

• charactersitic image

• image gallery

• load images dropping them in

• When editing undersized bitmap: "unknown color: undefined" (kog: is this a bug?)

addressed

• Editors blink when loading
• make deployment build work
• make map size correctly in map editor
• Code folding
• link sharing
• add screen resizing bars
• fix tune editor
• Fix > and < in code blocks showing up as > and <
  • sort of hacked this
• Show warnings in editor
• file or project manager
• Finish docs
• Styles for docs
• Basic README
• Prototype the new PCB-based editor design
• Add local storage
• Sprites, tiles, cells -> bitmaps, sprites, cells
  • Base change
  • Sprite type to bitmapKey
• getFirst function
• Scrap getGrid
• Update parameter names to match docs
• Verify controls against docs
• Make internal functions start with _
• Make sure dx and dy are cleared on every input beginning and ending
• Add wildcard to pattern matching
• setMap supports a sprite combo map too, how should that work?
• In pattern matching, make sure sprites are entirely cleared
• Warning for creating a sprite with multi-character keys, with period as key, with asterisk as key
• Error if bitmap is passed instead of bitmap key (only in addSprite, could be in more!)
• Pattern matching:
  • Error for mismatching size?
  • Error for wildcards?
  • Error for functions in the replacer?
• size the game screen correctly
  • pixels are integers
• Tune gets cleared when you try to edit it
• colors
  • logo color line
  • terminal color system