SunWhys Engine - Documentation

# Getting Started

introduction

# How it's work

SunWhys Engine is a collaborative game engine developed in C ++ supporting Lua, Javascript and having a graphic editor.

To contribute, you can go to the github page of the project.

# Architectures tree

SunWhys
|-- SunWhysEngine
    |-- loader.tf
    |-- sunwhysengine.exe
    |-- assets
    |-- scripts
        |-- init.lua
        |-- start.lua

# Loader.tf

The loader.tf file must contain all the .lua scripts executed by the engine knowing that they're read from top to bottom.

WARNING

Warning, lang= is required and an init.lua and start.lua script are required, you must specify your game scripts between init.lua and start.lua.

Example :

lang=lua
init.lua
// game script
start.lua

# SunWhysEngine.exe

SunWhys Engine is the engine itself, you can rename it to the name of your game.

# Scripts

Scripts is a folder that contains all of your game's scripts.

Example :

init.lua

window = Window:new(VideoMode:new(1280, 720), "SunWhysEngine")
event = Event:new()
gameManager = GameManager:new()

function initialization()
    while window:open() do
	    while window:event(event) do
		    if (event.key.code == Keyboard.Escape) then
			    window:close()
			    gameManager:close()
 		    end
 		    gameManager:update()
	    end

        window:clear(Color.Black)
        gameManager:render()
  	    window:display()
    end
end

start.lua

initialization()

# Assets

The assets folder must contain all the images and sounds necessary for the operation of the game.

← Documentation →