Join GitHub today
GitHub is home to over 20 million developers working together to host and review code, manage projects, and build software together.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
|Failed to load latest commit information.|
|Launch Flare OSX.command|
|Launch Flare Windows.bat|
Flare README ============ Flare (Free Libre Action Roleplaying Engine) is a simple game engine built to handle a very specific kind of game: single-player 2D action RPGs. Flare is not a reimplementation of an existing game or engine. It is a tribute to and exploration of the action RPG genre. Rather than building a very abstract, robust game engine, the goal of this project is to build several real games and harvest an engine from the common, reusable code. Flare uses simple file formats (INI style config files) for most of the game data, allowing anyone to easily modify game contents. Open formats are preferred (png, ogg). The game code is C++. COPYRIGHT AND LICENSE ===================== Most of Flare is Copyright © 2010-2012 Clint Bellanger. Contributors retain copyrights to their original contributions. Flare's source code is released under the GNU GPL v3. Later versions are permitted. Flare's default mod (includes engine translations) is released under GNU GPL v3 and CC-BY-SA 3.0. Later versions are permitted. The default mod contains the Liberation Sans font which is released under the SIL Open Font License, Version 1.1. LINKS ===== Homepage http://flarerpg.org Source https://github.com/clintbellanger/flare-engine Forums http://opengameart.org/forums/flare Email firstname.lastname@example.org DEPENDENCIES ============ To build flare you need the 1.2 Development Libraries for SDL, SDL_image, SDL_mixer, and SDL_ttf. To run flare you need the equivalent 1.2 Runtime Libraries. http://www.libsdl.org/download-1.2.php For easy building I recommend using cmake and make. --- Installing dependencies on debian based systems (debian, Ubuntu, Kubuntu, etc): sudo apt-get install libsdl1.2-dev libsdl-image1.2-dev libsdl-mixer1.2-dev libsdl-ttf2.0-dev cmake make g++ git There is also a flare build in the Ubuntu (universe) http://packages.ubuntu.com/source/precise/flare Installing dependencies on Arch Linux: pacman -S --asdeps sdl sdl_image sdl_mixer libogg libvorbis hicolor-icon-theme python sdl_ttf There is also a flare-rpg-git pkgbuild at the arch user repository: https://aur.archlinux.org/packages.php?ID=57522 Installing dependencies on openSUSE: sudo zypper in make cmake gcc gcc-c++ libSDL-devel libSDL_image-devel libSDL_mixer-devel libSDL_ttf-devel python There is also a flare build at the openSUSE games repo: http://software.opensuse.org/download.html?project=games&package=flare BUILDING WITH CMAKE =================== To build flare, go to the main directory/folder and run the following commands: mkdir build cd build cmake .. make If you want the game installed system-wide, as root, install with: make install The game will be installed into '/usr/local' by default. You can set different paths in the cmake step, like: cmake -DCMAKE_INSTALL_PREFIX:STRING="/usr" .. or, BUILDING WITH g++ ===================== If you prefer building directly with C++, the command will be something like this. Windows plus MinGW (depending on where your SDL dev headers are) g++ -I C:\MinGW\include\SDL src\*.cpp src\*.c -o flare.exe -lmingw32 -lSDLmain -lSDL -lSDL_image -lSDL_mixer -lSDL_ttf Linux (depending on where your SDL includes are) g++ -I /usr/include/SDL src/*.cpp src/*.c -o flare -lSDL -lSDL_image -lSDL_mixer -lSDL_ttf RUNNING FLARE ============= If the program is installing system-wide (i.e., you typed 'make install' and it worked), you can run it just by executing the 'flare' command. If you did not perform the installation step, you should copy back the binary in 'build' to the top directory, and run it from there, like this: cp flare .. cd .. ./flare Also, in newer versions, the game can be launched from an icon in your main menu in your GUI environment (KDE, GNOME, etc.). If you're running flare from your operating system's gui file browser (e.g. Windows Explorer or OSX Finder), you'll want to use one of the provided launchers. This helps the flare executable use its own working directory, so it can see all those data folders. SETTINGS ======== Settings are stored in one of these places: $XDG_CONFIG_HOME/flare $HOME/.config/flare ./config Here you can enable fullscreen, change the game resolution, enable mouse-move, and change keybindings. The settings files are created the first time you run Flare. SAVE FILES ========== Save files are stored in one of these places: $XDG_DATA_HOME/flare $HOME/.local/share/flare ./saves If permissions are correct, the game is automatically saved when you exit.