@bitsy/hecks
Version:
a collection of re-usable scripts for bitsy game maker
113 lines (86 loc) โข 6.06 kB
Markdown
# @bitsy/hecks
A collection of re-usable scripts for [Adam Le Doux](https://twitter.com/adamledoux)'s [Bitsy Game Maker](https://ledoux.itch.io/bitsy).
## contents
- ๐ฆ [3d](/dist/3d.js): bitsy in three dee
- ๐ฅ [avatar by room](/dist/avatar-by-room.js): change the avatar in certain rooms
- ๐ [basic sfx](/dist/basic-sfx.js): "walk" and "talk" sound effect support
- ๐ [bitsymuse](/dist/bitsymuse.js): A variety of Bitsy sound and music handlers
- ๐ด [canvas replacement](/dist/canvas-replacement.js): WebGLazy bitsy integration (this one's mostly just for me)
- ๐ฝ [character portraits](/dist/character-portraits.js): high quality anime jpegs (or pngs i guess)
- ๐ [character portraits animated](/dist/character-portraits-animated.js): high quality anime gifs
- โ๏ธ [close on ending](/dist/close-on-ending.js): Prevents from playing past an ending
- โฟ [corrupt](/dist/corrupt.js): corrupts gamedata at runtime
- ๐
ฐ [custom text effect](/dist/custom-text-effect.js): make {custom}text effects{custom}
- ๐ [custom-exit-effects](/dist/custom-exit-effects.js): make custom exit transition effects
- ๐ [dialog box transition](/dist/dialog-box-transition.js): adds an easing transition animation to display the dialog box text
- ๐ [dialog choices](/dist/dialog-choices.js): binary dialog choices
- ๐ [dialog jump](/dist/dialog-jump.js): jump from one dialog entry to another
- ๐ฌ [dialog pause](/dist/dialog-pause.js): add pauses in between printing text
- ๐ [direction in dialog](/dist/direction-in-dialog.js): provides a variable with player direction
- โ [directional avatar](/dist/directional-avatar.js): flips the player's sprite based on directional movement
- ๐ผ [dynamic background](/dist/dynamic-background.js): HTML background matching bitsy background
- ๐ [edit dialog from dialog](/dist/edit-dialog-from-dialog.js): edit dialog from dialog (yes really)
- ๐ [edit image from dialog](/dist/edit-image-from-dialog.js): edit sprites, items, and tiles from dialog
- ๐ [end-from-dialog](/dist/end-from-dialog.js): trigger an ending from dialog, including narration text
- ๐ช [exit-from-dialog](/dist/exit-from-dialog.js): exit to another room from dialog, including conditionals
- ๐ฐ [external-game-data](/dist/external-game-data.js): separate Bitsy game data from your (modded) HTML for easier development
- ๐ [favicon-from-sprite](/dist/favicon-from-sprite.js): generate a browser favicon (tab icon) from a Bitsy sprite, including animation!
- ๐ [follower](/dist/follower.js): makes a single sprite follow the player
- ๐ฎ [gamepad input](/dist/gamepad-input.js): HTML5 gamepad support
- ๐ท [itsy-bitsy](/dist/itsy-bitsy.js): for when bitsy's not small enough
- โ [javascript dialog](/dist/javascript-dialog.js): execute arbitrary javascript from dialog
- ๐ [logic-operators-extended](/dist/logic-operators-extended.js): adds conditional logic operators
- ๐ [long dialog](/dist/long-dialog.js): put more words onscreen
- ๐จโ๐จโ๐งโ๐ง [multi-sprite avatar](/dist/multi-sprite-avatar.js): make the player big
- ๐ [noclip](/dist/noclip.js): walk through wall tiles, sprites, items, exits, and endings
- ๐ [online](/dist/online.js): multiplayer bitsy
- โฌ [opaque tiles](/dist/opaque-tiles.js): tiles which hide the player
- ๐ [paragraph-break](/dist/paragraph-break.js): Adds paragraph breaks to the dialogue parser
- โณ [permanent items](/dist/permanent-items.js): prevent some items from being picked up
- ๐ญ [replace drawing](/dist/replace-drawing.js): add name-tags to replace drawings when the game is loading
- ๐พ [save](/dist/save.js): save/load your game
- ๐ [smooth moves](/dist/smooth-moves.js): ease the player's movement
- ๐ [solid items](/dist/solid-items.js): treat some items like sprites that can be placed multiple times
- โฑ๏ธ [stopwatch](/dist/stopwatch.js): time player actions
- ๐ฃ [text-to-speech](/dist/text-to-speech.js): text-to-speech for bitsy dialog
- ๐ฐ [tracery processing](/dist/tracery-processing.js): process all dialog text with a tracery grammar
- ๐ [transitions](/dist/transitions.js): customizable WebGL transitions
- ๐๏ธโ๐จ๏ธ [transparent dialog](/dist/transparent-dialog.js): makes the dialog box have a transparent background
- ๐ [transparent sprites](/dist/transparent-sprites.js): makes all sprites have transparent backgrounds
- ๐ฑ [twine bitsy comms](/dist/twine-bitsy-comms.js): interprocess communication for twine and bitsy
- โ [unique items](/dist/unique-items.js): items which, when picked up, remove all other instances of that item from the game

## how to use
Each script has a short "HOW TO USE" section included in the comments. For steps which say to `Copy-paste this script into a script tag after the bitsy source `, open your exported bitsy game and scroll to the bottom of the file (at the time of writing, it looks like this):
```html
</script>
</head>
<!-- DOCUMENT BODY -->
<body onload='startExportedGame()'>
<!-- GAME CANVAS -->
<canvas id='game'></canvas>
</body>
</html>
```
then edit it to look like this:
```html
</script>
<script>
// and then paste your code here!
</script>
</head>
<!-- DOCUMENT BODY -->
<body onload='startExportedGame()'>
<!-- GAME CANVAS -->
<canvas id='game'></canvas>
</body>
</html>
```
## Further reading
- [Writing hacks with this repo's source code](https://github.com/seleb/bitsy-hacks/wiki)
- [Claire Morley's "A Bitsy Tutorial"](http://www.shimmerwitch.space/bitsyTutorial)
- [Bitsy games!](https://itch.io/games/tag-bitsy)
- [Andrew Yolland's Borksy](https://ayolland.itch.io/borksy): Hack helper
- [ruin's image-to-bitsy](https://ruin.itch.io/image-to-bitsy): Artistic aid
- [Fontsy](https://seansleblanc.itch.io/Fontsy): Typographic tool
If you have any issues, feel free to ping me or ask for help on the [bitsy discord](https://discordapp.com/invite/9rAjhtr)!