Himmel_Engine/readme.md

Himmel Engine

Himmel(equal to Heaven, but in German) is an engine for Visual Novels, written using Dlang and Lua.

Getting Started

Getting needed components

Build system currently assumes POSIX like system. For building, you need first install next components on:

1. FreeBSD:

   sudo pkg install ldc vlc dub lua53
   

2. Alpine:

   doas apk add ldc2 dub vlc-dev vlc lua5.3-dev 
   

3. Debian:

   sudo apt install dub ldc vlc-dev liblua5.3-dev vlc lua
   

Next, run ./build.sh . Everything will be done automatically!

Features

• Multiple characters on screen
• Backgrounds(can be preloaded and then drawn if needed)
• Text box with skip functionality and choices
• Graphics effects(PNG stored in .bin, its called HPFF - Heaven/Himmel Package File Format)

TODO

• Adding lipsync
• Adding savestates in-engine
• Adding backlog and menus

Documentation

You can see documentation on Himmel's wiki page. It contains cheatsheet and some useful examples for getting started with development.

License

raylib(raylib.com) uses zlib/libpng license

himmel engine uses MIT license

VLC(videolan.org) uses LGPL license

lua(lua.org) uses MIT license