https://github.com/chigix/rengular

RDF described Visual Novel-style Game Engine atop Web Components
https://github.com/chigix/rengular

angular engine game ranobe visual-novel

Last synced: 6 months ago
JSON representation

RDF described Visual Novel-style Game Engine atop Web Components

• Host: GitHub
• URL: https://github.com/chigix/rengular
• Owner: chigix
• License: mit
• Created: 2019-04-25T17:28:22.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-07T05:11:52.000Z (over 3 years ago)
• Last Synced: 2025-03-31T09:54:52.495Z (about 1 year ago)
• Topics: angular, engine, game, ranobe, visual-novel
• Language: TypeScript
• Homepage: https://rengular.js.org
• Size: 9.01 MB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 51
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# RenGULAR 

[![CircleCI](https://circleci.com/gh/chigix/rengular/tree/master.svg?style=svg)](https://circleci.com/gh/chigix/rengular/tree/master)

[![npm version](https://badge.fury.io/js/%40rengular%2Fnetwork-context.svg)](https://www.npmjs.com/@rengular/network-context)



The modern visual novel-style game engine leveraging the power of

[web](https://www.webcomponents.org/) and [Angular](https://angular.io/) in ultimate stories

-- open source and free to render interactive storytelling on browsers acrossing

variety of smart devices upon the modern Web Components standards embracing the

[New Generation of Internet and Web](https://ieeexplore.ieee.org/document/4620089/?arnumber=4620089).

## Design Overview

Documents are preparing in [Wiki Repository](https://github.com/chigix/rengular/wiki) and in planning to be integrated into [project homepage](https://rengular.js.org).

### Component Theming and Typography

This feature is not required but recommended and currently implemented by default

provided `SimulationService`.

Sample Component:

```javascript

{

  ...

  textbox: {

    // Use Material Dark Theming and Default Typography

    '@theming' : ['mat-dark-theming', 'mat-typography'],

    ...

  },

  ...

}

```

### Scene Program in a Scene (Renaming to Gekijo is in plan)

* Initially, there is one set including one `@program` and one scene(Stage/Gekijo).

* A `GekijoDirective` is with the data structure inherited from the scene itself,

  where the scene data are made modifiable, excepting `@` mark initialled properties.

* `GekijoDirective` would be sent sequentially to the stage from the `@program`.

* If a `GekijoDirective` was sent to Scene(Stage/Gekijo), it would be performed

  immediately.

* The only parameter to arrange the timing for `GekijoDirective` triggering is

  through the sharing property, `delay`, which is default as 0 millisecond and

  optional for an event definition.

* Empty Event

  `{ delay: 0 }`

* Common Event

  `{ delay: 0, textbox: '.....', menu: ['yes', 'no'], ... }`

[Sample Program](https://evangelion.fandom.com/wiki/Episode:06#cite_ref-1):

```javascript

{

  ...

  '@program': [

    { textbox: { text: 'Are you all right? Ayanami! ...' } },

    { textbox: { text: "Don't ever say that ! Just don't say that you have nothing else!" } },

    { delay: 1000, textbox: {

      text: "And don't say goodbye when you leave for a mission, it's just too sad."}},

    { textbox: {

      text: "Why are you crying? I'm very sorry I don't know what I should do or feel at a time like this"}},

    { delay: 2000, textbox: 'Smile is all~' },

  ],

  ...

}

```

## RenGULAR Programming Interface (RenPI)

Initially, RenPI is designed using [Resource Description Framework](https://www.w3.org/TR/rdf11-concepts/) (RDF) with [JSON-LD](https://json-ld.org/) in default.

### DEMO: Simple Quest JSON Repository

There is a [pure json repository](https://github.com/chigix/rengular-api-starter) designed to be used as a starter template or

understanding RenGULAR Programing Interface, deeply representing the core concept

and possible practice on:

* RenGULAR Simulation Framework

* RenGULAR Gekijo Container

### Why JSON-LD

* Simulation Framework design makes the data describing scenes as json linking data.

* JSON-LD makes components data self-describing:

  * Given Objects types

  * Associate properties with IRIs

  * Use [terms](https://w3c.github.io/json-ld-syntax/#dfn-term) defined in a referenced context

  * Property types are specified in context

  * Subject Chaining Definition, Subject Reference, Single Value to Unordered Values,

  terms shorting property names, `@type` coercion, Named Graphs defined in Language

  Feature.

* [Compaction, Expansion, Flattening and Framing](https://w3c.github.io/json-ld-syntax/#forms-of-json-ld)

  designed in json-ld makes RenPI both developer and machine understanding friendly.

## RenGULAR Components v.s ANGULAR Components

Generally, ANGULAR Components, especially the Amazing Material Components set, are

directly able to be installed and used in the whole RenGULAR environment, even

through RenPI operations.

However mostly RenGULAR Components are unable to be directly used onto other

ANGULAR environments due to the dependency of RenGULAR Kernel Services and some

common basic components, RenGULAR Primitive Components.

## RenGULAR Primitive Components (RenCom)

* ChoiceMenu

* LayeredImage

* OarsPocket

* Scene

* Textbox

## RenGULAR Simple Components (RenSimCom)

* SimpleEntry

* SimpleNavi

## RenGULAR Context Actions

* `http://rengular.js.org/schema/StyleAction`: Component Level Styling

  provided for directly applying CSS styles onto target component element.

  However this styling feature is exactly restricted to very few components

  which are created and managed by RenGULAR only.

* `http://rengular.js.org/schema/ComponentAction`: Load New Component

* `http://rengular.js.org/schema/StaticSessionAction`: Store Information shared

  by same type.

## Story

Inspired by [Ren'Py](https://www.renpy.org/).

## License

[MIT](https://rengular.js.org/license).