/mandarina

🍊 A visual novel JavaScript library

Primary LanguageTypeScript

Mandarina 🍊

Mandarina is a visual novel engine made for be simple.

lajbel - mandarina stars - mandarina forks - mandarina
GitHub tag issues - mandarina

View site - GH Pages view - Documentation

Features

  • 📖 Simple verbal language for creating visual novels.
  • 🧑‍💻 All in coding, no difficult visual editors.
  • 🎨 Fully customizable.
  • 👾 Easy to integrate minigames
  • 💥 Based in kaboom.js

An Example

Start coding/reading mandarina code is quite simple!

import mandarina from "mandarinavn";

// Init options
const m = mandarina({
    textbox: {
        textFont: "comic-sans",
        textSize: 24,
    },
});

// Define characters
m.character("d", "Dude");
m.character("b", "Bro");

// Create the start chapter
m.chapter("start", () => [
    // Show a background
    m.bg(new m.k.Color(255, 255, 255)).fadeIn(),
    // Show our character.
    m.show("t", "normal"),
    // Say something.
    m.say("t", "Hi, I'm Deffy!"),
    m.say("t", "What's your name?"),
    // Ask an input
    m.input("name"),

    // Jump to another chapter
    m.jump("ch1"),
]);

// Start novel
m.start();

Installation

NPM

The mandarina package is not already inside npmjs service, so you can install trough npm with

npm i github:lajbel/mandarina@master