Setup

Environment

• Cargo 1.51+
• Rust 1.51+
• Node.js 14+
• Pnpm 8+

Install

Misakura has many package name, so you can choose one you like:

pnpm install misakura
pnpm install avgjs

Structure

• my-visual-novel
  • public Static files and misakura scripts files
    • audio
      • music Music files
      • sound Sound effect files
      • voice Characters voice files
    • fonts Font files
    • images
      • background Background images
      • figure Character images
    • scripts Misakura scripts files
    • videos Video files
    • misakura.svg Logo file
  • src TypeScript source code
    • styles
    • index.tsx Loading file of the dom
    • main.ts Entry file of the game
  • src-tauri Rust source code
    • icons Icon files
    • src Rust source code
    • tauri.conf.json Configuration file of the Rust code
    • Cargo.toml Package information
  • package.json Package information
  • index.html HTML template file
  • README.md Readme file
  • .gitignore Git ignore file
  • tsconfig.json TypeScript configuration file

Visual Studio Code Extension

Search for Misakura Script in the Extensions tab of Visual Studio Code.That will get syntax highlighting for Misakura scripts.

Coding

src/main.ts:

import Misakura from 'misakura'
import * as styles from './styles'

function main() {
  const ctx = new Misakura({ entry: 'complex', styles })

  ctx.start()
  return ctx
}

export default main

src/index.tsx:

/* @refresh reload */
import { render } from 'solid-js/web'
import './styles/index.css'
import main from './main'

function App() {
  return <>{main()}</>
}

const root = document.getElementById('root')
render(() => <App />, root as HTMLElement)

src-tauri/src/main.rs:

#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]

#[tauri::command]
fn greet(name: &str) -> String {
    format!("Hello, {}! You've been greeted from Rust and love of Misakura!", name)
}

fn main() {
    tauri::Builder::default()
        .invoke_handler(tauri::generate_handler![greet])
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

Write Scripts

public/scripts/main.mrs: