Skip to content

UpsilonPuzzle/upsilon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

27 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Upsilon

What is Upsilon ?

Upsilon is a C++ game engine, designed to make 2D puzzles. It uses the SDL2 library and the Luwra Lua wrapper. It is distributed under the GNU GPL license.

Subgames are written in Lua. They have to be in the subgames folder.

How to compile and run Upsilon ?

On a GNU/Linux operating system you can do:

Install sdl 2

$ sudo apt-get install libsdl2-dev libsdl2-image-dev

Install lua 5.3

$ sudo apt-get install liblua5.3-0 liblua5.3-dev

Or install by sources

$ wget http://www.lua.org/ftp/lua-5.3.2.tar.gz
$ tar zxf lua-5.3.2.tar.gz
$ rm lua-5.3.2.tar.gz
$ mv lua-5.3.2 lua
$ cd lua
$ make generic -j`nproc`
$ sudo make install

Install git

$ sudo apt-get install git

Clone and compile upsilon

$ git clone https://github.com/UpsilonPuzzle/upsilon.git --recursive
$ cd upsilon
$ g++ src/*.cpp -llua -ldl -lSDL2 -lSDL2_image -g -std=c++0x -o upsilon

I guess Upsilon is compilable on a Microsoft Windows operating system, but sorry, I don't know how. If someone succeded to do this, please contact me by e-mail or open an issue.

To run Upsilon, you may give one argument: the subgame name (which is the subgame folder name). If you don't, Upsilon will ask you the subgame you want to use.
For example:

$ ./upsilon mario_sokoban

How to make a subgame ?

To make a subgame (if you do, you'll make me very happy :D), first learn the Lua programming language (don't worry, it's really easy).

The Lua API documentation will come very soon. For the moment, you can look at the "mario sokoban" subgame (unfinished) and try to understand how it works.

This game engine is in development !

Remember: for the moment, Upsilon is very unfinished. But you can make his development faster by helping to develop it by creating issues, sending pull requests, writing the wiki, etc!!