Name | Date | Size | #Lines | LOC | ||
---|---|---|---|---|---|---|
.. | 03-May-2022 | - | ||||
build/appveyor/ | H | 11-Jan-2019 | - | 67 | 42 | |
cmake/ | H | 11-Jan-2019 | - | 1,939 | 1,628 | |
dependencies/ | H | 03-May-2022 | - | |||
doc/ | H | 11-Jan-2019 | - | 2,538 | 1,937 | |
engine/ | H | 11-Jan-2019 | - | 96,374 | 59,068 | |
tests/ | H | 11-Jan-2019 | - | 26,098 | 23,185 | |
tools/ | H | 11-Jan-2019 | - | 545 | 391 | |
.astylerc | H A D | 11-Jan-2019 | 1.2 KiB | 58 | 39 | |
.editorconfig | H A D | 11-Jan-2019 | 685 | 31 | 25 | |
.gitattributes | H A D | 11-Jan-2019 | 512 | 32 | 28 | |
.gitignore | H A D | 11-Jan-2019 | 1.8 KiB | 105 | 89 | |
.pylintrc | H A D | 11-Jan-2019 | 12.1 KiB | 378 | 257 | |
.travis.yml | H A D | 11-Jan-2019 | 4 KiB | 101 | 92 | |
AUTHORS | H A D | 11-Jan-2019 | 1.8 KiB | 60 | 59 | |
CHANGELOG.md | H A D | 11-Jan-2019 | 52.3 KiB | 1,090 | 1,000 | |
LICENSE.md | H A D | 11-Jan-2019 | 25.9 KiB | 503 | 418 | |
README.md | H A D | 11-Jan-2019 | 6.5 KiB | 122 | 84 | |
appveyor.yml | H A D | 11-Jan-2019 | 6.9 KiB | 179 | 159 | |
run_tests.py | H A D | 11-Jan-2019 | 6.8 KiB | 228 | 175 | |
setup.py | H A D | 11-Jan-2019 | 2.3 KiB | 62 | 29 |
README.md
1![FIFE LOGO](https://raw.githubusercontent.com/fifengine/fifengine/master/doc/logo/FIFE_small_c3.png) 2 3# FIFE 4 5Flexible Isometric Free Engine (FIFE) is a multi-platform isometric game engine written in C++. 6It comes with Python bindings allowing users to create games using Python as well as C++. 7The engine is extendable and enables you to add any feature you can imagine to your project. 8 9| [Website](http://fifengine.net/) | [![#fife on Freenode](https://img.shields.io/badge/freenode-%23fife-green.svg)](https://webchat.freenode.net/?channels=fife) | [Changelog](https://github.com/fifengine/fifengine/blob/master/CHANGELOG.md) | [Releases](https://github.com/fifengine/fifengine/releases) | [Source Code (zip)](https://github.com/fifengine/fifengine/archive/master.zip) | 10|:--------:|:--------:|:--------:|:--------:|:--------:| 11 12| Continuous Integration | Linux | Mac | Windows | 13|:----------------------:|:-----:|:--------:|:-------:| 14| **Build Status** | [![Travis Build status](https://travis-ci.org/fifengine/fifengine.svg?branch=master)](https://travis-ci.org/fifengine/fifengine) | [![Travis Build status](https://travis-ci.org/fifengine/fifengine.svg?branch=master)](https://travis-ci.org/fifengine/fifengine) | [![Appveyor Build status](https://ci.appveyor.com/api/projects/status/github/fifengine/fifengine?branch=master&svg=true)](https://ci.appveyor.com/project/LinuxDonald/fifengine) | 15| **Development Releases** | - | - | [All artifacts](https://ci.appveyor.com/project/LinuxDonald/fifengine/build/artifacts) | 16 17| **Documentations** | | | | 18|:----------------------:|:----------------:|:-------:|:----------:| 19| [Overview](https://fifengine.github.io/fifengine-docs/) | [Developer Manual](https://fifengine.github.io/fifengine-docs/developer-manual/en/) | [C++ API](http://www.fifengine.net/doxygen) | [Python API](http://www.fifengine.net/epydoc) | 20 21Fifengine is also already available from the following package repositories: 22 23[![Packaging status](https://repology.org/badge/vertical-allrepos/fife.svg)](https://repology.org/metapackage/fife) 24 25# Table of contents 261. [Features](#1-features) 272. [License](#2-license) 283. [Tests](#3-tests) 294. [Python Demos](#4-python-demos) 306. [Python Tutorials](#5-python-tutorials) 315. [C++ Tutorials](#6-c-tutorials) 327. [Troubleshooting](#7-troubleshooting) 338. [Feedback](#8-feedback) 34 35## 1) Features 36 37A [complete list of the features](https://fifengine.github.io/fifengine-docs/user-manual/en/#_features) that FIFE offers can be found in the user-manual. 38 39 40## 2) License 41 42- The source code (*.cpp, *.h & *.py) is licensed under [LGPL v2.1 or newer](http://www.gnu.org/licenses/lgpl-2.1.html). 43- Files in /engine/core/util/utf8/ are under BSL license 44- Content was taken from a lot a lot of different 3rd party sources. Therefore 45each client directory comes with a separate LICENSE file that states the origin 46of the content, the author and the actual license it was published under. 47 48 49## 3) Tests 50 51The test tool can be found within the `<FIFE>/tests/fife_test` directory. 52You can launch it by running `run.py`. Open the console with `F10`. 53To run a test enter `run` and the test name like `PathfinderTest`. 54 55## 4) Python Demos 56 57### [Editor](https://github.com/fifengine/fifengine-editor) 58The Python based editor tool can be found within the [fifengine-editor repo](https://github.com/fifengine/fifengine-editor). 59You can launch it by running `run.py`. It is used to edit map files for the [Rio De Hola demo](https://github.com/fifengine/fifengine-demos/tree/master/rio_de_hola). Other clients extend it and use it to edit their maps. 60 61### [Rio De Hola](https://github.com/fifengine/fifengine-demos/tree/master/rio_de_hola) 62Rio de hola is a technology demo showing off many of the FIFE features. It is 63located in the `rio_de_hola` directory and can be launched by running `run.py`. 64Once started as an example game, it's now a playground for developers to test their code. 65It serves as a good starting point for own game developments. 66 67### [Shooter](https://github.com/fifengine/fifengine-demos/tree/master/shooter) 68The Shooter demo was an attempt to show the versatility and flexibility of FIFE. 69It is a simple side scrolling shooter that has a main menu, one level and an end boss. 70Try your luck and see if you can defeat the boss! 71 72### [PyChan](https://github.com/fifengine/fifengine-demos/tree/master/pychan_demo) 73There is an example client residing in `pychan_demo` that shows how the pychan GUI library works. 74You may start the GUI demo application by running `pychan_demo.py`. 75 76### Configuring the Editor and Demos 77The engine utilizes special settings files for configuring FIFE. This file is 78called `settings.xml` and resides in the `~/.fife` directory (in 79`<User>\Application Data\fife` for Windows users). The Shooter Demo and the 80PyChan demo are exceptions. They both store their `settings.xml` file in their 81root directories. 82 83NOTE that the `settings.xml` file is auto generated and wont be there until you 84run the demos for the first time. FIFE automatically fills the settings file 85with default values. You find more information on [FIFE settings in the 86Developer-Manual](https://fifengine.github.io/fifengine-docs/developer-manual/en/#_engine_settings). 87 88 89## 5) [Python Tutorials](https://github.com/fifengine/python-tutorials) 90 91Our Python tutorials demonstrate how to use the engine when working with Python. 92 93 94## 6) [C++ Tutorials](https://github.com/fifengine/cpp-tutorials) 95 96There is also a set of C++ tutorials demonstrating the usage of the engine, when working with C++. 97 98 99## 7) Troubleshooting 100 101### Video Card/Driver Issues 102There are some known driver/card combinations that exhibit some problems with 103FIFE. Users have reported seeing blank screens or fuzzy images. If this is 104happening to you please report it on our [issue tracker](https://github.com/fifengine/fifengine/issues). 105 106Please include your Card/Driver/OS information in your post. Currently the fix 107is to modify your `settings.xml` file and set both GLUseFramebuffer and GLUseNPOT 108to `False` (they are `True` by default). 109 110### Audio 111Win32 users tend to suffer from problems with the OpenAL drivers. If you don't 112hear sound while running a FIFE client, run `oalinst.exe` that ships with the 113Win32 FIFE Development Kit. This is the latest OpenAL driver for Win32. 114 115 116## 8) Feedback 117 118We appreciate every kind of feedback concerning the release, the project in 119general and the bundled techdemo. Feedback is a great way to help us to improve 120FIFE. If you would like to get in contact with us and provide feedback you can 121either visit our IRC channel: #fife on freenode.net. 122