Features

From FIFE development wiki

Contents 1 Introduction 2 Audio 3 Development specific features 4 Editor tools 5 Event handling 6 Fonts 7 Graphical user interface 8 Graphics 8.1 General 8.2 Animations 8.3 Effects 9 Maps 9.1 Geometries 9.2 Loaders 9.3 Pathfinding 10 Scripting 11 Renderer 11.1 SDL 11.2 OpenGL 12 Video 13 View 14 Virtual file system

[edit] Introduction

This article describes the current status of the engine. The features are broken down into categories and divided by their current implementation progress: discussed, planned, work in progress & done. The aim is to keep this article in sync with the most recent code; it should be updated after every milestone release to ensure that. The following query can be used to get list of closed non-defect tasks from trac [1].

[edit] Audio

Support for following formats:

• OggVorbis - this feature is already successfully integrated into the engine

[edit] Development specific features

• Logging
  • Module specific logging functionality - this feature is already successfully integrated into the engine
  • Logging according to priority levels - this feature is already successfully integrated into the engine
  • Logging output to file / stdout - this feature is already successfully integrated into the engine
• Automated unit testing framework - this feature is already successfully integrated into the engine

[edit] Editor tools

• Basic map editor tool - this feature is already successfully integrated into the engine
  • Dataset browser - this feature is already successfully integrated into the engine
  • Deleting instances from map layer - this feature is already successfully integrated into the engine
  • Loading existing maps - this feature is already successfully integrated into the engine
  • Placing instances on map layer - this feature is already successfully integrated into the engine
  • Saving maps - this feature is already successfully integrated into the engine
  • Undo/Redo support for instances - this feature is already successfully integrated into the engine
  • Object Editor plugin - this feature is already successfully integrated into the engine

[edit] Event handling

Support for the following event types, can be bind to scripting functionality:

• Mouse events - this feature is already successfully integrated into the engine
• Keyboard events - this feature is already successfully integrated into the engine
• Widget events - this feature is already successfully integrated into the engine
• Custom commands - this feature is already successfully integrated into the engine

[edit] Fonts

Support for following font formats:

• True type - this feature is already successfully integrated into the engine
• Bitmap fonts - this feature is already successfully integrated into the engine

[edit] Graphical user interface

• Ingame console with support for executing Python code / scripts - this feature is already successfully integrated into the engine
• Fully customizable GUIs via our Python wrapper for the guichan user interface library - this feature is already successfully integrated into the engine

[edit] Graphics

[edit] General

• Support for formats implemented by SDL_image [2] - this feature is already successfully integrated into the engine
• Support for the FRM image format (used in Fallout 1 & 2) - this feature is already successfully integrated into the engine
• Palette color index override system for transparency effects - this feature is already successfully integrated into the engine
• Support for the Fallout palette format - this feature is already successfully integrated into the engine
• Take ingame screenshots via hotkey - this feature is already successfully integrated into the engine
• Pooling of image resources, resulting enhanced performance and reduced memory consumption - this feature is already successfully integrated into the engine

[edit] Animations

• Custom FIFE XML-based animation format (can be used with all image formats) - this feature is already successfully integrated into the engine
• Fallout palette animations - this feature is already successfully integrated into the engine

[edit] Effects

• Several possible effects (e.g. fading in/out of instances) - this feature has been dropped for the upcoming release

[edit] Maps

[edit] Geometries

• 3D geometry definition, defined by tilt, rotation and scale - this feature is already successfully integrated into the engine
• Support for different tile and object grids with independent geometries - this feature is already successfully integrated into the engine
• Multiple layers per map - this feature is already successfully integrated into the engine
• All variations of square and hex shape geometries - this feature is already successfully integrated into the engine
• Fringe layer for tiles - this feature was discussed but no decision was made if it should be added

[edit] Loaders

• Support for custom XML-based FIFE map format - this feature is already successfully integrated into the engine

[edit] Pathfinding

• Exchangable pathfinding backends:
  • Linear pather - this feature is already successfully integrated into the engine
  • Route pather - this feature is already successfully integrated into the engine

[edit] Scripting

• Python-based scripting system (out of the box) - this feature is already successfully integrated into the engine
• Scripts be can executed from the console - this feature is already successfully integrated into the engine
• Possible support for more scripting languages by utilizing SWIG - this feature is already successfully integrated into the engine

[edit] Renderer

• Support for different renderers via render backend approach (currently SDL + OpenGL backend available) - this feature is already successfully integrated into the engine
• Free choice:
  • Resolution - this feature is already successfully integrated into the engine
  • Bit-depth (16, 24, 32bit) - this feature is already successfully integrated into the engine
  • Window mode (fullscreen & windowed) - this feature is already successfully integrated into the engine
• Possibility to define separate camera specific viewports with different rotations, zooms and tilts - this feature is already successfully integrated into the engine

[edit] SDL

• Colorkey for fast transparency effects - this feature is already successfully integrated into the engine

[edit] OpenGL

• Transparency for tiles & objects - this feature is already successfully integrated into the engine
• Colorkey for fast transparency effects - this feature is already successfully integrated into the engine

[edit] Video

• Video playback support based on the ffmpeg library - this feature was agreed upon and is now work in progress

[edit] View

• Correct z-order sorting of map instances - this feature is already successfully integrated into the engine
• Support for different renderers:
  • Blocking renderer - this feature is already successfully integrated into the engine
  • Camzone renderer - this feature is already successfully integrated into the engine
  • Cell selection renderer - this feature is already successfully integrated into the engine
  • Coordinate renderer - this feature is already successfully integrated into the engine
  • Floating text renderer - this feature is already successfully integrated into the engine
  • Grid renderer - this feature is already successfully integrated into the engine
  • Instance renderer - this feature is already successfully integrated into the engine
  • Quadtree renderer - this feature is already successfully integrated into the engine

[edit] Virtual file system

• Support for reading files on platforms with different byte orders - this feature is already successfully integrated into the engine
• Read support for Fallout 1 DAT archives (LZSS-based) - this feature is already successfully integrated into the engine
• Read support for Fallout 2 DAT archives - this feature is already successfully integrated into the engine
• Read support for ZIP archives - this feature is already successfully integrated into the engine
• Lazy loading of files for decreased load times - this feature is already successfully integrated into the engine