This repository contains the code for Starswirl Academy, as well as the scripts
to bring the code and assets together into a playable VN.


================================================================
PREREQUISITES
================================================================

(1) Node.js is used by MetaVN, our VN-code compiler. Get it from nodejs.org.

(2) If image conversion or scaling is performed, ImageMagick is used. Get it
    from imagemagick.org.

(3) Ren'Py is used unmodified. Fetch the latest SDK from renpy.org and extract
    it to a directory named 'renpy' next to this file.
    (Latest as of the time of this writing is 6.16.5)

(4) MetaVN is used to compile our VN-code. Check it out from
    https://bitbucket.org/zap-apple/metavn  into a directory named 'metavn'
    next to this file.

(5) The SA assets are stored in a Google Drive folder named 'Assets'. Download
    it using the Drive web interface, converting documents to plain text. If
    you're using the Google Drive desktop client, you can copy most of the
    Assets directory, but will need to download 'scripts' using the web
    interface to perform the text conversion.


================================================================
BUILDING
================================================================

If on Windows, simply run build.bat .

Otherwise,
$ node build.js -a Assets -s Example/StarswirlPrompt

(Naturally, the starting script will later be changed)

This will create a complete Ren'Py game in the 'starswirlacademy' directory.


================================================================
RUNNING
================================================================

If on Windows, simply run run.bat .

Otherwise,
$ renpy/renpy.sh starswirlacademy


================================================================
MAKING DISTRIBUTABLES
================================================================

If on Windows, simply run distribute.bat .

Otherwise,
$ renpy/renpy.sh renpy distribute starswirlacademy
