README
1# Flare
2
3Flare is a single-player 2D action RPG with fast-paced action and a dark fantasy style.
4
5It is built on the FLARE engine (Free/Libre Action Roleplaying Engine). Its repo is at https://github.com/flareteam/flare-engine
6
7Flare 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). Maps are edited using Tiled.
8
9For best results, please use the latest version of the FLARE engine with the game data in this repository. Using an older version of the engine could result in some game elements not working correctly.
10
11
12
13The flare-game content contains depictions of violence, blood, and mild gore.
14
15## Copyright and License
16
17Flare (the game) is Copyright ©2010-2013 Clint Bellanger. Contributors retain copyrights to their original contributions.
18
19The Flare Engine is released under GPL version 3 or later.
20
21All of Flare's art and data files are released under CC-BY-SA 3.0. Later versions are permitted.
22
23The Liberation Sans fonts version 2 are released under the SIL Open Font License, Version 1.1.
24
25The Marck Script font is licensed under the SIL Open Font License, Version 1.1.
26
27
28## Links
29
30* Homepage http://flarerpg.org
31* Repo https://github.com/flareteam/flare-game
32* Binaries https://sourceforge.net/projects/flare-game/
33* Forums http://opengameart.org/forums/flare
34* Email clintbellanger@gmail.com
35
36## The Simplest Setup
37
38If you are building and running Flare Game from source, this is the simplest way to get started on all operating systems. Here you build and play Flare in a local folder instead of installing it to a standard OS folder (e.g. /usr/local or Program Files).
39
40* Clone the flare-engine repo and build the executable.
41* Clone the flare-game repo into your user directory.
42* Copy the flare-engine "default" mod into the flare-game mods folder.
43* Put the flare executable inside the flare-game folder
44* The executable and the "mods" folder should be in the same directory
45* Run Flare
46
47## Building and Running (non-Linux)
48
49See the Flare-Engine repo for instructions on how to build/install Flare:
50
51https://github.com/flareteam/flare-engine
52
53The mods folder should be in the same directory as the flare executable when building from source.
54
55Flare Game is installed as a set of mods for Flare Engine. Place the contents of the "mods" folder inside Flare Engine's mods folder.
56
57Then enable these mods in Flare's Configuration screen.
58
59 fantasycore
60 empyrean_campaign
61
62
63### Building and Running on Linux
64
65Clone the repos:
66
67 git clone https://github.com/flareteam/flare-engine
68 git clone https://github.com/flareteam/flare-game
69
70
71Move to the flare-engine repo and build:
72For instructions more in detail see the INSTALL file in the
73flare-engine repo.
74
75 cd flare-engine
76 cmake . && make
77
78
79From this point we have two options:
80
81Option 1
82Install the game system-wide (requires root access):
83
84 sudo make install
85 cd ../flare-game
86 cmake . && sudo make install
87 cd ~ #this step is important because we don't want to load mods from the repo folders
88 flare #alternatively, launch Flare from the desktop application menu
89
90
91Option 2
92Run the game without installing:
93
94 cd ../flare-game
95 ln -s ../flare-engine/flare flare
96 cd mods
97 ln -s ../../flare-engine/mods/default default
98 cd ..
99 ./flare
100
101
102
103## Settings
104
105Settings are stored in one of these places:
106
107 $XDG_CONFIG_HOME/flare
108 $HOME/.config/flare
109 ./config
110
111Here 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.
112
113## Save Files
114
115Save files are stored in one of these places:
116
117 $XDG_DATA_HOME/flare
118 $HOME/.local/share/flare
119 ./saves
120
121If permissions are correct, the game is automatically saved when you exit.
122
123## Packaging and Distributing
124
125If you are packaging Flare Game for release (e.g. on an operating system's software repo), we suggest creating two packages.
126
127* flare-engine the package that contains the single engine reused by several games
128* flare-game, a package that requires flare-engine that only contains this game data
129
130When distributing flare-game you may elect to omit these folders which are not used at runtime.
131
132* art_src contains the raw files (e.g. Blender files) used to generate Flare's art.
133* tiled contains the Tiled-native map files used to export Flare's maps
134
README.md
1# Flare
2
3Flare is a single-player 2D action RPG with fast-paced action and a dark fantasy style.
4
5It is built on the FLARE engine (Free/Libre Action Roleplaying Engine). Its repo is at https://github.com/flareteam/flare-engine
6
7Flare 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). Maps are edited using Tiled.
8
9For best results, please use the latest version of the FLARE engine with the game data in this repository. Using an older version of the engine could result in some game elements not working correctly.
10
11
12
13The flare-game content contains depictions of violence, blood, and mild gore.
14
15## Copyright and License
16
17Flare (the game) is Copyright ©2010-2013 Clint Bellanger. Contributors retain copyrights to their original contributions.
18
19The Flare Engine is released under GPL version 3 or later.
20
21All of Flare's art and data files are released under CC-BY-SA 3.0. Later versions are permitted.
22
23The Liberation Sans fonts version 2 are released under the SIL Open Font License, Version 1.1.
24
25The Marck Script font is licensed under the SIL Open Font License, Version 1.1.
26
27
28## Links
29
30* Homepage http://flarerpg.org
31* Repo https://github.com/flareteam/flare-game
32* Binaries https://sourceforge.net/projects/flare-game/
33* Forums http://opengameart.org/forums/flare
34* Email clintbellanger@gmail.com
35
36## The Simplest Setup
37
38If you are building and running Flare Game from source, this is the simplest way to get started on all operating systems. Here you build and play Flare in a local folder instead of installing it to a standard OS folder (e.g. /usr/local or Program Files).
39
40* Clone the flare-engine repo and build the executable.
41* Clone the flare-game repo into your user directory.
42* Copy the flare-engine "default" mod into the flare-game mods folder.
43* Put the flare executable inside the flare-game folder
44* The executable and the "mods" folder should be in the same directory
45* Run Flare
46
47## Building and Running (non-Linux)
48
49See the Flare-Engine repo for instructions on how to build/install Flare:
50
51https://github.com/flareteam/flare-engine
52
53The mods folder should be in the same directory as the flare executable when building from source.
54
55Flare Game is installed as a set of mods for Flare Engine. Place the contents of the "mods" folder inside Flare Engine's mods folder.
56
57Then enable these mods in Flare's Configuration screen.
58
59 fantasycore
60 empyrean_campaign
61
62
63### Building and Running on Linux
64
65Clone the repos:
66
67 git clone https://github.com/flareteam/flare-engine
68 git clone https://github.com/flareteam/flare-game
69
70
71Move to the flare-engine repo and build:
72For instructions more in detail see the INSTALL file in the
73flare-engine repo.
74
75 cd flare-engine
76 cmake . && make
77
78
79From this point we have two options:
80
81Option 1
82Install the game system-wide (requires root access):
83
84 sudo make install
85 cd ../flare-game
86 cmake . && sudo make install
87 cd ~ #this step is important because we don't want to load mods from the repo folders
88 flare #alternatively, launch Flare from the desktop application menu
89
90
91Option 2
92Run the game without installing:
93
94 cd ../flare-game
95 ln -s ../flare-engine/flare flare
96 cd mods
97 ln -s ../../flare-engine/mods/default default
98 cd ..
99 ./flare
100
101
102
103## Settings
104
105Settings are stored in one of these places:
106
107 $XDG_CONFIG_HOME/flare
108 $HOME/.config/flare
109 ./config
110
111Here 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.
112
113## Save Files
114
115Save files are stored in one of these places:
116
117 $XDG_DATA_HOME/flare
118 $HOME/.local/share/flare
119 ./saves
120
121If permissions are correct, the game is automatically saved when you exit.
122
123## Packaging and Distributing
124
125If you are packaging Flare Game for release (e.g. on an operating system's software repo), we suggest creating two packages.
126
127* flare-engine the package that contains the single engine reused by several games
128* flare-game, a package that requires flare-engine that only contains this game data
129
130When distributing flare-game you may elect to omit these folders which are not used at runtime.
131
132* art_src contains the raw files (e.g. Blender files) used to generate Flare's art.
133* tiled contains the Tiled-native map files used to export Flare's maps
134
