📃
VeinIF documentation
  • Introduction
  • Perquisites
  • Features
  • Tutorial
    • Getting Started
    • Tutorial
    • Extending the framework
  • Components
    • Paragraph
    • Choice
  • Optional Components
    • Precondition
    • Consequence
  • Files
    • File Structures
    • Code snippets
  • Modifying Guide
    • Preface
    • HTML Layout
  • API
    • Formatting
      • capitalise
      • greyOut
    • ParagraphFunctions
      • getCurrentParagraphName
  • Change log
    • Change log
Powered by GitBook
On this page
  • Setting up the development environment
  • Tutorial

Was this helpful?

  1. Tutorial

Getting Started

Quick setup guide - won't guarantee that it'll take less than 5 minutes...

Setting up the development environment

To start using VeinIF,

  1. Make sure that you've got Node.js installed on your machine. - To check if Node is installed, type node -v into your command prompt or terminal. The command prompt should return the version of Node.js installed on your local machine e.g. v12.13.0. - Otherwise, visit Nodejs.org to download & install Node.js.

  2. Download the latest release or a copy of VeinIF repo on GitHub.

  3. Unzip, navigate to the folder containing VeinIF and open a command prompt.

    1. In Windows, type cmd onto the folder address bar to open Command Prompt that location.

  4. Install dependency using Node Package Manager, which comes with the installation of Node. Type the following command into the Command Prompt: 

    npm install

  5. After all packages has been installed, start the development environment by

    1. either typing npm run dev into the terminal...

    2. or for Windows users, use BuildGUI.exe, which included with the package for a GUI with handy buttons that runs the npm commands for you.

  6. Your default browser should open up a localhost page that preview the game.

  7. Open the folder in an IDE. We recommend Visual Studio Code.

And that's it. You can now start coding and make your own game by open src/game/allParagraphs.ts

VeinIF uses lite-server (v0.0.1-alpha.1) and currently webpack-dev-server for web development server. As you save your code, changes will be detected and the web page? Refreshed.

Tutorial

Quickly learn the basics of VeinIF by doing a tutorial in our next section.

PreviousFeaturesNextTutorial

Last updated 3 years ago

Was this helpful?