Giter VIP home page Giter VIP logo

pixi-vn's Introduction

Pixi-VN Build Status

Visual Novel Engine written using pixi.js, ES6 and nodejs.

Installation Instructions

  • Install nodejs
  • Clone this repository
  • Inside the local repository, install dependencies
    npm install
  • If all install correctly, start the server
    npm run start

Setup files

config.json

Specifies all the assets and information you'll use in your visual novel, like character details, views, and script files. The library looks through config.json to find pictures and data it needs to preload.

Scripts

The scripting system is loosely based off of the conversation system from Fungus. Set the startScript in config.json to tell the system what script to start from. From there, it will go in order of the listed scripts.

Contributing

  • Read through the Contributer's Code of Conduct.
  • Bugs - if you see a bug and want to report it, add it to the github issues list, preferably with screenshots and a thurough description of the problem, then tag it as a bug.
  • Feature Requests - Want a feature or want to start working on a feature? Write an issue and tag it as a feature request. People can vote on that feature and give me more of a reason to work on it.
  • Now that you've written an issue, feel free to take up the mantle by forking the repo, adding your changes and submitting a pull request, you awesome person you!

pixi-vn's People

Contributors

lealeelu avatar

Stargazers

 avatar

Watchers

 avatar

pixi-vn's Issues

Sounds - single play

The author should be able to add sound effects into the script that will play only once.
sound: boom

Release Version 1.0

Official Version 1.0 should have thorough testing and completion of the following features:

  • Loading multiple characters on screen at designated positions
  • Dialog display for a character
  • Character animation tweens between positions
  • Jumps and labels
  • Menus
  • Wiki documentation on how to make your own story using pixi-vn and the different options available to you in the language

Add variables

Be able to store javascript objects as variables that can be referenced during gameplay and after a save state is loaded.

This needs to be referenced in the script somehow. Maybe something like...

var lovemeter: 5
var lovemeter: +1

if: lovemeter < 5
elseif: lovemeter < 2   
else:  

but I'm open to suggestions.

2 default test backgrounds

Right now I'm using something I randomly found on the internet for a background, but I would like to have a couple made for the engine in about the same style. One at a shady park and another in a town - maybe a somewhat fantasy setting. No Japanese high schools pleeaaaase.

Saving Function

While the user is playing, they should have the ability to...

  • save at any point
  • look at a list of saves with timestamps and labels
  • select from one of the saves to load from

Wiki documentation

The wiki should have complete start-to-finish instructions on how a creator would...

  • Install everything they need to start working
  • How to write a script with all of the currently available functions
  • How to add pictures
  • How to add scripts
  • How to make the story available to others
  • Documentation for advanced users (design patterns used and what each class does)

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.