https://github.com/jonahss/wyldcard-public

Public code for Wyldcard, e-paper playing cards
https://github.com/jonahss/wyldcard-public

e-ink e-paper e-paperdisplay game-development gamedev tabletop-gaming

Last synced: 2 months ago
JSON representation

Public code for Wyldcard, e-paper playing cards

• Host: GitHub
• URL: https://github.com/jonahss/wyldcard-public
• Owner: Jonahss
• License: agpl-3.0
• Created: 2023-01-10T21:50:02.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-27T22:22:42.000Z (11 months ago)
• Last Synced: 2024-10-14T00:13:42.589Z (2 months ago)
• Topics: e-ink, e-paper, e-paperdisplay, game-development, gamedev, tabletop-gaming
• Language: Rust
• Homepage: https://wyldcard.io
• Size: 2.53 MB
• Stars: 14
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![wyldcard word mark black](https://github.com/Jonahss/wyldcard-public/assets/1521841/7c24295a-98e3-4140-93a7-7143f20b4b6d)

This is the public code repository for all things Wyldcard

----------------------------------------------------------

For an overview on what Wyldcard is, check out [the introductory blog post](https://www.wyldcard.io/blog/introducing-wyldcard).

After spending seven hours in the top position on Hacker News, I decided to crowdfund a [Wyldcard DevKit on Crowd Supply](https://www.crowdsupply.com/wyldcard/wyldcard-devkit)

![wyldcardInAction](https://github.com/Jonahss/wyldcard-public/assets/1521841/a84bec78-5598-4045-8d3f-8a65389ec3c9)

Game Development on Wyldcard

----------------------------------------------------------

If you have a Wyldcard DevKit, you can program your own functionality and implement game mechanics using JavaScript.

(You could also dive into a deeper level and program in any language you want, more on that later)

A simple Wyldcard demo that displays a random image on a card whenever a button is pressed could look like this:

```

let fs = require('fs/promises')

let path = require('path')

let { Plinth, imageUtilities } = require('@wyldcard/drivers')

async function main() {

  let plinth = new Plinth('devkit')

  let displayRandomImage = function(well) {

    return async () => {

      let image = await imageUtilities.randomImage()

      well.displayImage(image)

    }

  }

  plinth.wells.forEach((well) => {

    well.onAButtonPress(displayRandomImage(well))

    well.onBButtonPress(displayRandomImage(well))

    well.onCButtonPress(displayRandomImage(well))

  })

}

main()

```

In order to get to running this code, we need to go over the following:

- [Setting Up a Development Environment](docs/remote-development.md)

- [Using the Wyldcard JavaScript SDK](docs/using-the-wyldcard-javascript-sdk.md)

- [Formatting Images](docs/formatting-images.md)

If you want to design your own Wyldcard-compatible hardware, check out:

- [Hardware Documentation](hardware)

This repo also contains

- [Examples and Demo code](examples)

- [napi-rust-drivers](napi-rust-drivers) - The core Rust code which runs the Wyldcard e-paper displays and the javascript native api wrappers which form the SDK

- [images](images) - Information about images, how to format them, programs for formatting and sending them to the Wyldcard plinth and some sample images to use

For a blog-post style tutorial, see:

- [Implementing a Tarot Deck on Wyldcard](https://www.wyldcard.io/blog/implementing-a-tarot-deck-on-wyldcard)