https://github.com/lajbel/mandarina

🍊 A visual novel JavaScript library
https://github.com/lajbel/mandarina

game-development game-engine kaboomjs visual-novel

Last synced: about 2 months ago
JSON representation

🍊 A visual novel JavaScript library

• Host: GitHub
• URL: https://github.com/lajbel/mandarina
• Owner: lajbel
• Created: 2023-02-21T18:46:41.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-02-19T15:21:59.000Z (10 months ago)
• Last Synced: 2024-10-11T15:43:55.252Z (2 months ago)
• Topics: game-development, game-engine, kaboomjs, visual-novel
• Language: TypeScript
• Homepage: https://lajbel.github.io/mandarina/
• Size: 831 KB
• Stars: 10
• Watchers: 1
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        
# ![Mandarina 🍊](mandarinalogo.png)



Mandarina is a visual novel engine made for be simple. 



[![lajbel - mandarina](https://img.shields.io/static/v1?label=lajbel&message=mandarina&color=orange&logo=github)](https://github.com/lajbel/mandarina "Go to GitHub repo")

[![stars - mandarina](https://img.shields.io/github/stars/lajbel/mandarina?style=social)](https://github.com/lajbel/mandarina)

[![forks - mandarina](https://img.shields.io/github/forks/lajbel/mandarina?style=social)](https://github.com/lajbel/mandarina) 


[![GitHub tag](https://img.shields.io/github/tag/lajbel/mandarina?include_prereleases=&sort=semver&color=orange)](https://github.com/lajbel/mandarina/releases/)

[![issues - mandarina](https://img.shields.io/github/issues/lajbel/mandarina)](https://github.com/lajbel/mandarina/issues)





[![View site - GH Pages](https://img.shields.io/badge/View_site-GH_Pages-2ea44f?style=for-the-badge)](https://lajbel.github.io/mandarina/)

[![view - Documentation](https://img.shields.io/badge/view-Documentation-blue?style=for-the-badge)](https://github.com/lajbel/mandarina/wiki "Go to project 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!

```js

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();

```

![](https://i.imgur.com/kmwGiux.png)

## Installation

### NPM

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

```

npm i github:lajbel/mandarina@master

```