https://github.com/tomgroenwoldt/helix-shortcut-quiz

Learn the helix editor keymap on the web!
https://github.com/tomgroenwoldt/helix-shortcut-quiz

game helix-editor learning quiz

Last synced: 4 months ago
JSON representation

Learn the helix editor keymap on the web!

• Host: GitHub
• URL: https://github.com/tomgroenwoldt/helix-shortcut-quiz
• Owner: tomgroenwoldt
• Created: 2023-03-18T14:46:33.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-06-16T00:59:15.000Z (over 1 year ago)
• Last Synced: 2024-08-01T22:57:48.839Z (7 months ago)
• Topics: game, helix-editor, learning, quiz
• Language: Rust
• Homepage: https://tomgroenwoldt.github.io/helix-shortcut-quiz/
• Size: 38.2 MB
• Stars: 26
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-helix - Helix Shortcut Quiz

README

        
[![pages-build-deployment](https://github.com/tomgroenwoldt/helix-shortcut-quiz/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/tomgroenwoldt/helix-shortcut-quiz/actions/workflows/pages/pages-build-deployment)

# Helix Shortcut Quiz

A web quiz built with [yew](https://yew.rs/) for testing your knowledge of [helix editor](https://helix-editor.com/) shortcuts. Try it out [here](https://tomgroenwoldt.github.io/helix-shortcut-quiz/)!

![helix-shortcut-quiz](https://user-images.githubusercontent.com/70777530/228351818-b7ebe8f2-a672-4759-86ab-e395c9cf211b.gif)

## How to play

| Key      |      Action   |

|----------|:-------------:|

`Esc` | Clear input

`Backspace` | Pop last char of input

`Enter` | Submit correct input

`Left arrow` | Skip to left GIF

`Right arrow` | Skip to right GIF

Your category progress is stored in the local storage of your browser. You can reset this store via the `Reset this category`

button.

## Development

### Dependencies

If you don't already have it installed, it's time to install Rust: .

To compile Rust to WASM, we need to have the `wasm32-unknown-unknown` target installed.

Install it with the following command:

```bash

rustup target add wasm32-unknown-unknown

```

Install trunk:

```bash

cargo install trunk

```

### GIF generation

The `yew` app serves GIFs generated by [`vhs`](https://github.com/charmbracelet/vhs). The current state of `vhs` doesn't

support the recording of the helix block cursor. The problem lies deeper within the [`ttyd`](https://github.com/tsl0922/ttyd)

dependency which uses the [`xterm.js`](https://github.com/xtermjs/xterm.js) canvas addon.

If you want to generate the GIFs yourself you should go ahead, clone the custom forks I made and use those binaries instead.

After building the two binaries place them in the `gif_generation/` directory and execute `generate_all_gifs.sh`. 

### Run the application locally

```bash

trunk serve

```

## Contributing

Any kinds of contributions are welcome! Feel free to reach out to me via issues or pull requests :)