https://github.com/henryksloan/sugarcubes

A library and tool for automata and formal languages, inspired by JFLAP
https://github.com/henryksloan/sugarcubes

Last synced: 3 months ago
JSON representation

A library and tool for automata and formal languages, inspired by JFLAP

• Host: GitHub
• URL: https://github.com/henryksloan/sugarcubes
• Owner: henryksloan
• License: agpl-3.0
• Created: 2021-05-28T20:02:02.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-03-31T14:37:44.000Z (over 2 years ago)
• Last Synced: 2024-05-15T14:38:45.071Z (6 months ago)
• Language: Rust
• Homepage: https://henryksloan.github.io/sugarcubes/
• Size: 38.7 MB
• Stars: 26
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-quads - Sugarcubes - a library and application for automata and formal languages, inspired by JFLAP. (Apps or visualizations / Apps or visualizations: On top of macroquad)

README

        
# Sugarcubes

https://henryksloan.github.io/sugarcubes/

Sugarcubes is a library and application for automata and formal languages. It is inspired by JFLAP, and is intended to eventually to be an alternative to JFLAP.

![Screenshot of a finite automaton in Sugarcubes](screenshots/Sugarcubes.png)

### Usage

Double-click the background to add a state.  

Double-click a state and drag onto another state (or the same state) to add a transition.   

Click and drag a state to move it.

Right click a state for more options, such as deleting it or making it initial or final.

Right click a transition symbol for more options, like deleting it.

## Building

To build the desktop frontend, run:

`cargo run --release`

### WASM

To build for WASM, run:

```

# Add the WASM compilation target if you haven't already

rustup target add wasm32-unknown-unknown

cargo build --release --target wasm32-unknown-unknown

```

This will produce a WASM binary in `target/wasm32-unknown-unknown/release/sugarcubes.wasm`, which can be placed in the `docs` directory and hosted as described [in the miniquad docs](https://github.com/not-fl3/miniquad/#wasm).

# Progress

Sugarcubes is in an early stage of development, having support for editing and simulating finite automata. The first MVP will be a fully usable finite automaton simulator and editor.

## Next steps

* Usable FA edit mode

    * State labels

    * Keyboard shortcuts for context menu operations

    * Multiple select mode

        * Click-drag starting on the background

        * Movement and deletion of multiple objects

* Simulation rewinding (this may require some sophistication to avoid combinatoric memory usage)

* Under consideration

    * Implement undo/redo for moving

    * Editing transitions with the context menu

## Eventual goals

* More automata

    * Push-down automata

    * Turing machines

    * Possibly others like Mealy machines and Moore machines

* Filetype-compatility with JFLAP

    * Can be implemented incrementally, per-model type

* Regular expressions and grammars

* Operations and conversions like minimization

* Graph visual organization like alignment

* Turing machine blocks

* Built-in tutorials

## Stretch goals/pipe dreams

* Collaborative editing

* Generating URLs of models for easy sharing

* Potentially a custom file format for features not present in JFLAP