add support for Bitsy 7.10; turn dithering off by default; more help text

Cargo.toml

@@ -1,19 +1,19 @@
 [package]
 name = "pixsy"
-version = "0.72.7"
+version = "0.710.0"
 description = "convert images to Bitsy rooms"
 authors = ["Max Bradbury <max@tinybird.info>"]
 edition = "2018"
 license = "MIT"
-repository = "https://tinybird.dev/max/image-to-bitsy"
+repository = "https://tinybird.dev/max/pixsy"
 
 [lib]
 crate-type = ["cdylib"]
 
 [dependencies]
 base64 = "^0.12.3"
-bitsy-parser = "^0.72.5"
+bitsy-parser = "^0.710.0"
 image = "^0.23.7"
 json = "^0.12.4"
 lazy_static = "^1.4.0"
-wasm-bindgen = "=0.2.64" # newer versions are bugged...
+wasm-bindgen = "^0.2.78"

README.md

@@ -1,3 +1,57 @@
 # pixsy
 
-convert images to rooms for use in Bitsy
+a tool for [Bitsy Game Maker](http://bitsy.org). 
+upload any image and convert it into a room.
+
+## credits
+
+made by [Max Bradbury](http://tinybird.info/). 
+makes use of my own [bitsy parser](https://crates.io/crates/bitsy-parser) library.
+
+uses the [Croppie](https://foliotek.github.io/Croppie/) image crop plugin 
+by [Foliotek](https://www.foliotek.com/)
+
+uses [wasm-bindgen](https://crates.io/crates/wasm-bindgen) to automate WebAssembly bindings.
+
+## thanks
+
+to [Adam Le Doux](http://ledoux.io/) for creating the wonderful and inspiring Bitsy
+
+to [Mark Wonnacott](https://kool.tools/) for their support, encouragement and inspiration
+
+and to everyone in the bitsy community!
+
+## contributing
+
+forks and pull requests welcome!
+
+### development prerequisites
+
+* [rust/cargo](https://rustup.rs/)
+* [pug](https://pugjs.org/)
+* [less](http://lesscss.org/)
+* a bash shell for the build script
+
+## bugs
+
+when importing images, some pixels have errors. 
+it seems to only happen for pixels surrounded at the top and left:
+```
+111    111
+100 => 110
+100    100
+```
+
+pixsy does not work in the Itch desktop program 
+because their bundled version of Chromium does not support WebAssembly.
+
+## to do
+
+* add alternative dithering options (Atkinson, Bayer 8×8)
+* add a 'smoothing' (noise reduction?) stage to remove errant pixels
+
+## could do
+
+* reimplement tile reuse option
+* add camera support so users can take a pic instead of uploading an image
+* allow user to draw to canvas

TODO.md

@@ -1,6 +0,0 @@
-# todo
-
-* tile reuse
-* noise reduction (remove lonely pixels)
-* implement Atkinson and Bayer dithering options
-* fix weird problem with pixels flipping (see test::example)

includes/style.less

@@ -22,6 +22,11 @@ button {
     white-space: nowrap;
     width: 100%;
     
+    &.half {
+        float: left;
+        width: 50%;
+    }
+    
     &.pagination:not(.normal) {
         position: absolute;
         bottom: 5vmin;

index.pug

@@ -8,25 +8,46 @@ html(lang="en-gb")
         script(src="includes/croppie.min.js")
     body
         header
-            h1
+            h1 pixsy
-                | pixsy
-                //img(alt="pixsy" src="includes/pixsy.png")
             p.
-                convert images to Bitsy rooms
+                version 0.710.0
                 |
-                #[a(href="./old/") old version]
+                #[a(href="http://tinybird.info/image-to-bitsy/old/" target="_blank") old version]
                 |
                 #[a(href="mailto:max@tinybird.info") email]
                 |
                 #[a(href="https://twitter.com/synth_ruiner") twitter]
         .pages
             .page#start
+                p.
+                    #[b pixsy] is a tool for #[a(href="https://bitsy.org/") Bitsy Game Maker]
+                    that allows you to generate a room from an image and add it to your game.
+                p.
+                    this version is tested to be compatible with Bitsy version 7.10 and earlier.
+                    later versions may also work fine, but make sure you have a backup of your game data.
+                p.
+                    #[b pixsy] does not currently work via the Itch desktop program.
+                    if pixsy does not work for you, please try the
+                    #[a(href="http://tinybird.info/image-to-bitsy/old/") old version] instead.
+                p.
+                    if your image is already the correct size for a bitsy room (128×128),
+                    simply leave the zoom slider at the default setting.
+                    you can draw your room in a pixel-art program and import it here.
+                p.
+                    full instructions can be found on the
+                    #[a(href="https://ruin.itch.io/pixsy/") itch.io page] -
+                    scroll down to "how to use".
+
                 button.normal.pagination.next#new create a new bitsy game
                 button.normal.pagination.next#load load an existing bitsy game
             .page.game-data
                 h2 game data
 
-                input#game(type="file" autocomplete="off")
+                p.
+                    your game data is available from the #[i game data] window in bitsy,
+                    under the #[i tools] dropdown.
+
+                input#game(type="file" accept=".bitsy,.txt" autocomplete="off")
                 br
 
                 textarea#game-data(
@@ -74,21 +95,22 @@ html(lang="en-gb")
                                         input#colour-foreground(type="color" value="#ffffff")
 
                                 label
-                                    input#dither(type="checkbox" checked=true)
+                                    input#dither(type="checkbox")
                                     | dither
+                                p (approximates a greyscale effect)
                                 br
 
                 button.pagination.prev#back-to-image previous
                 button.pagination.next#room-next add room
             .page.download
+                h2 done!
+
                 p#added
 
-                h2 download
-
                 textarea#output(autocomplete="off")
-                br
 
-                button#download download
+                button#clipboard.half copy to clipboard
+                button#download.half download
 
                 button.pagination.prev#add add another image
                 button.pagination.start#reset start again

script.js

@@ -12,10 +12,6 @@ import init, {
     set_room_name,
 } from './pkg/pixsy.js';
 
-if (typeof WebAssembly !== "object") {
-    window.location = "./old/"
-}
-
 // stolen from https://ourcodeworld.com/articles/read/189/how-to-create-a-file-and-generate-a-download-with-javascript-in-the-browser-without-a-server
 function download(filename, text) {
     let element = document.createElement('a');
@@ -28,6 +24,18 @@ function download(filename, text) {
     document.body.removeChild(element);
 }
 
+function copyToClipboard() {
+    const button = el("clipboard");
+
+    el("output").select();
+    document.execCommand("copy");
+    button.innerText = "copied!";
+
+    setTimeout(() => {
+        button.innerText = "copy to clipboard";
+    }, 2000);
+}
+
 function el(id) {
     return document.getElementById(id);
 }
@@ -60,10 +68,15 @@ function readFile(input, callback, type = "text") {
 }
 
 async function run() {
+    if (typeof WebAssembly !== "object") {
+        window.location = "http://tinybird.info/image-to-bitsy/old/"
+    }
+
     await init();
 
     const buttonAddImage         = el("add");
     const buttonBackToImage      = el("back-to-image");
+    const buttonCopyToClipboard  = el("clipboard")
     const buttonDownload         = el("download");
     const buttonGameDataProceed  = el("game-data-next");
     const buttonImageProceed     = el("image-next");
@@ -126,14 +139,12 @@ async function run() {
     el("game").addEventListener("change", function() {
         readFile(this, function (e) {
             textareaGameDataInput.value = e.target.result;
-            console.log(load_game(e.target.result));
             checkGameData();
         }, "text");
     });
 
     function setPaletteDropdown() {
         const palettes = JSON.parse(get_palettes());
-        console.debug(palettes);
 
         selectPalette.innerHTML = "";
 
@@ -153,7 +164,9 @@ async function run() {
     }
 
     function checkGameData() {
-        if (textareaGameDataInput.value.length > 0) {
+        let result = load_game(textareaGameDataInput.value)
+
+        if (result === "Loaded game") {
             buttonGameDataProceed.removeAttribute("disabled");
             setPaletteDropdown();
         } else {
@@ -241,6 +254,9 @@ async function run() {
         download("output.bitsy", textareaGameDataOutput.value);
     }
 
+    buttonCopyToClipboard.addEventListener("click",    copyToClipboard);
+    buttonCopyToClipboard.addEventListener("touchend", copyToClipboard);
+
     buttonDownload.addEventListener("click",    handleDownload);
     buttonDownload.addEventListener("touchend", handleDownload);
 

src/lib.rs

@@ -1,5 +1,3 @@
-#![feature(clamp)]
-
 use bitsy_parser::game::Game;
 use bitsy_parser::image::Image;
 use bitsy_parser::tile::Tile;
@@ -43,7 +41,7 @@ lazy_static! {
             image:      None,
             room_name:  None,
             palette:    SelectedPalette::None,
-            dither:     true,
+            dither:     false,
             brightness: 0,
         }
     );
@@ -201,7 +199,7 @@ fn palette_from(bg: &bitsy_parser::Colour, fg: &bitsy_parser::Colour) -> bitsy_p
 }
 
 fn render_preview(state: &State) -> DynamicImage {
-    let mut buffer = state.image.as_ref().unwrap().clone().into_rgba();
+    let mut buffer = state.image.as_ref().unwrap().clone().into_rgba8();
 
     let palette = match &state.palette {
         SelectedPalette::None => bitsy_parser::mock::game_default().palettes[0].clone(),
@@ -249,18 +247,18 @@ pub fn add_room() -> String {
     let mut state = STATE.lock().expect("Couldn't lock application state");
 
     if state.game.is_none() {
-        return "No game data loaded".to_string();
+        return "No game data loaded".into();
     }
 
     match &state.palette {
-        SelectedPalette::None => { return "No palette selected".to_string(); },
+        SelectedPalette::None => { return "No palette selected".into(); },
         _ => {}
     };
 
     let mut game = state.game.clone().unwrap();
 
     if state.image.is_none() {
-        return "No image loaded".to_string();
+        return "No image loaded".into();
     }
 
     let palette_id = Some(match &state.palette {
@@ -292,7 +290,7 @@ pub fn add_room() -> String {
 
             fn colour_match(a: &image::Rgb<u8>, b: &bitsy_parser::Colour) -> u8 {
                 if a[0] == b.red && a[1] == b.green && a[2] == b.blue { 1 } else { 0 }
-            };
+            }
 
             for y in (row * SD)..((row + 1) * SD) {
                 for x in (column * SD)..((column + 1) * SD) {
@@ -379,7 +377,7 @@ mod test {
         load_default_game();
         load_image(include_str!("test-resources/colour_input.png.base64").trim().to_string());
         let output = get_preview();
-        let expected = include_str!("test-resources/colour_input.png.base64.greyscale").trim();
+        let expected = include_str!("test-resources/colour_input.png.base64.blueprint").trim();
         assert_eq!(output, expected);
     }
 

src/test-resources/colour_input.png.base64.blueprint

@@ -0,0 +1 @@
+data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAIvUlEQVR4nO2YwbHsuBEEVzbJDvn0PZERskM27UYeMqKiAyA5Q3DAGTAv1dUAe9iPdXr/+vPfv//+62FZngAszhOAxXkCsDhPABbnCcDiPAFYnCcAi/MEYHGeACzOE4DFeQKwOE8AFucJwOI8AVicJwCL8wRgcZ4ALM4TgMV5ArA4TwAW5wnA4jwBWJwnAIvzBGBxngDs8Od////rz3/+3dVv5wlAg6Mf13vqN7JkAPxgqvR8TxN76rewVAB6H6f2q2/hHfVbWSoA4kdTped7mthTv4UlAuBHUSu1Xz0c7YF99c4sEYDEj6JKz6vS81W/hZ8OgB+jqux5qf3qv5mfDkCP/IBZg16Vnq/6bfx0APwoVSu9PuRZ1r/CTweghx9Shayheun1v5UlA9Dj1z7uEZYOwIofvLJ0AB6eACzPE4DFeQKwOE8AFucJwOI8AVicJwCL8wRgcZ4AFN7572B9pvo7s2QAWh8oe1lvUe9V/w0sEQA/jCpb3rqnsufvzs8GYOtD1LPq96j39SpkfWd+LgCtP7w9VXp+TyHrytbZ3fi5ALzDkQ/WumOvqlR/R54ABH6wnkLWLfbO78YTgDfwI/cUsr4zTwA6+AF7+issGwA+pLzzQXme53r6LSwfgL2PxT3uVE1avZFcOf8rAjD6D8C85NXZPM8z6jfzFQEYDR9O9j4gd7lTFahBPwrmjp7ZY8kAwCt/5FfunuWTvwXLBuAo+UGyvppP/dZXBOBTf4w7UHetfjS3CIBLVoWsZzDr9z/1u1MDsLXk1tkvU/eufjRTAlCX0quiV1eh7lv9SKYEQFqLtXrQ6/8Sdcfqr2BqAMRFVbBWVyJ3tlZHc4sAVFrLtnq/Rt2x+iuYGgAXrCp7/lepe1Y/kqkBaFGX3fO/gnupkDVUP4JpAXCZqpA1VL8aV+4/LQAtclFrFazVX8Bd9hSyHsWUALhI1S3qnep/nav2nRIAqAvpeyp7/pvw3ff0Sj4egLpU9S3qnT1/d468b96xVkfy8QBIXUZfVXq+6p2p76jv6SeYFgDYW7Set3ySZ3ci35N3xKN71HvVj+DjAahL6HsKrbqlQH03eDfeCwVqwFP3FLK+go8HQI4u1rpHb4t6fzb5vrwbHk1qr/qrmBKAXK5VVwXro3onfCe0BWfCnS0/mikBkKPLeQ89CvfvQOudebfs61Gp/iqmBKC3nP2Win5PgXomvgfwLukhe9aoVH8FUwJwFP4AwB/B+h14/tP4vvy2NRz16Ce4TQBcOjWx11No1amfgt9rwTt4ljWkpwa89VXcJgAJiwPLW4/CmWgPz9VX8bnUJHtZgx79BLcIgAu3FKzPao96np76FepzeOrUFq0ze+hV3CIAFZa+Av6QzK4qLf8KPlufs59wh74q6amv5nYByOWp9xSsq0LWPXp36L+Kc3jWWlo96Z3Rv5LbBuAs/OFyVvqsK56hr8JzFeZkX19V9KlXcqsAuPARBeuqSe2lt1YTeu/AHJ5Fk1Yv2Trn7CpuF4Cz8MdijirVVzxPfRWeE57Hq5I+a7GXeiW3CQDLAgtT9xSsq7aoZ/qqFfrv0JoFzGud2Vd7cH4FtwvAu/AHYkZVqb5Sz/HvwAyeTU3sqRX7KlBfxS0CwKIsuaVgXXWLekdfVfToO/Bswhx6asW+Wsk+9WhuEQBwyVfhj8KzPZXqK3lO/S45wzqxr1bsqwm90dwiALkoS+qtq0LWW9R76bNO6L9LnccsemqLI2epI7lNAFgMleqTeqZXIWvY8tap7+LzaIs8yxr0agvORnKbAAgL9nzWUL1kP2uovsL5GXI2s/Cq7HmxnzqaWwWABVs1VJ94praoZ/qWnsEZaKX2e17twfkopgeARVkIbVHP9GoLz9Sk1Us4P0POZhZelep7eE8F6pHcIgDCcng12epVrbT69lSgHoHzKszPs/S9OrGPjmJ6AIClKixJX5XqW3hHBWu1BWdnYTZzWirV9/CemtAbwW0CwEKpldrXVz2K91WgPouzWjA/z/U9rdhHR3GbAFRYkr4q1Vc839MK/VEwn3mpSavXwntqQm8EtwkAC6VWal9f9SjeV4F6BM4T5tJTJb212sIzdBS3CUCFJe1nvYd397QFZyNwPvOsk15fPK9aoX+W6QFgMRZJlZ7v6SvkM9boCJiVMJeeKvqqPfKcegTTAwAuJSyXvep7eG9Pe3A+An6DWWiLrTPI86zFHnqW6QFgEWGhI76nR8n71ugomAfMpK6a2FNlzwO9s9wiACyCyp7v4b09lZYfRc6t8Dut81Y/e9apZ5kaAJZIWCh71YM9FbJ+B59HR+Cslib2VNnzQv8sUwMALMYiaI+t8zyzViFr0KsJvVHU2cJvHDnLWuylnmVqAFgiYSF6asW++gqtZ+yljoBZwky8Knq1hWdqhf5ZpgWAhVgAhazFnlrJfqtWRa9W6I+C+cxDk1YP7KstPEs9y7QAAEtUWKrVh9ZZq5dsnXuWOgrmJcw+0gP7VSv0zzItAC7EEtSq6FXRq6KvKnq1BWej8DeYaS21p1d75Dn1CKYFAFwmYbHab/Vk6wx65/ZTR+JMVPZ8kmdZgx49y7QAsACwBLUqPV9V9FVFr7bgbBT5G8w94tUe9Rx/likBYAleHq3UfvWVd8/tq0A9CmYyDwXqLbwH3MVXTeiNYEoAIBdimfRQe/qqkj7rZK+PjoJ5ySuz67MJc/Icf4YpAXABXt4aqodWL6nn6a1V0auCHwVzmae+g8+mJvTOMiUAkMuwiN5alfRZS6tX6d2xj46Cecm7s1tzsoc/w5QAuAAvb92j3kmfdZL9rMWeCtSjYfaoucxKmEsPPcOUAAAvLyyBr5q0emBflT3fgjujyN8aNZeZzEIFf4YpAWABXhzt4bkqejXZ61lv6UiYCaPmOg+YiUfPMCUAwMsDC1BXrbzSr73qW3BnJPweM1GgPguzmIMK/gxTApAL9GAx7qlSvdR+9WCvKlCP5orZzkzOzP8HNQ0vxIkGykwAAAAASUVORK5CYII=

src/test-resources/expected.bitsy

@@ -1,6 +1,6 @@
 Write your game's title here
 
-# BITSY VERSION 7.2
+# BITSY VERSION 7.5
 
 ! ROOM_FORMAT 1