Coder Social home page Coder Social logo

chigix / rengular Goto Github PK

View Code? Open in Web Editor NEW
2.0 4.0 1.0 9.22 MB

RDF described Visual Novel-style Game Engine atop Web Components

Home Page: https://rengular.js.org

License: MIT License

JavaScript 5.33% TypeScript 74.95% HTML 7.89% CSS 11.82%
visual-novel game engine angular ranobe

rengular's Introduction

RenGULAR

CircleCI npm version JSON-LD-logo-88

The modern visual novel-style game engine leveraging the power of web and Angular 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.

Design Overview

Documents are preparing in Wiki Repository and in planning to be integrated into project homepage.

Component Theming and Typography

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

Sample Component:

{
  ...
  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:

{
  ...
  '@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 (RDF) with JSON-LD in default.

DEMO: Simple Quest JSON Repository

There is a pure json repository 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 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 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.

License

MIT.

rengular's People

Contributors

chigix avatar shryics avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

shryics

rengular's Issues

About API v1 protocol design

Demo Scenarios upon Rengular:

  • Slot gaming depiction (スロットゲームの再現シナリオは今深夜思いついた所)

Layout / Loader / SimulationAdapter

  • Layout Probability Abstraction
    • Init configurable layout
    • Scene delegation
    • Predictable scene loader
    • JIT scene loader
    • Squashed Ren PI
    • Long Life Component Space
      • Audio Component
  • RanobeLayout (built-in implementation)
    • Click event on whole scene
    • Next scene pre-load
    • Additional Scene switching effect
  • AdvLayout (built-in implementation)
    • Scene thumb recorder
    • Responsive for mobile, PC and VR
  • VideoLayout (built-in implementation)
    • Load video directly

Restless Bandit Demo

Provide a recipe involving the process model on ChooseAction-AchieveAction Cycle:

choose#1 --result--> win/lose#1 --result--> choose#2 --result--> win/lose#2
win/lose#1 --subjectOf--> A Scene
win/lose#2 --subjectOf--> B Scene

Match Media support in Resolution Solution

A design for solving the problem across various screen solutions:

  • Fixed Ratio as a setting item defined in Context
  • Fit for the full size of the layout container/ screen
    • Complete make use of matchMedia term as a recommended practice

RenGULAR Graph Database

Make Session could be shared across devices and requests for account system-like experience in the next stage.

  • Serialize Session
    • The employment of rdf has made rdf serialization available
  • Generic Session Object
    • Schema free?
  • Session Storage Support --> Algolia or firebase real-time database is in consideration

http://schema.org/actionOption support in ChoiceMenu

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.