Source Code Reference - Revision history

Echelon9: /* Alphabetical View */

2015-05-03T05:30:00Z

Alphabetical View

← Older revision		Revision as of 05:30, 3 May 2015
Line 39:		Line 39:
	* fireball (Displays & handles fireballs and warping effects)		* fireball (Displays & handles fireballs and warping effects)
	* freespace2 (Main code - handles engine initialisation, loading resources, plus windows resources like icons & dialog boxes)		* freespace2 (Main code - handles engine initialisation, loading resources, plus windows resources like icons & dialog boxes)
	* ~~fs2open_pxo~~ (~~Network~~ code)		* fs2netd (Game matchmaker network client code)
	* gamehelp (Displays context sensitive help text)		* gamehelp (Displays context sensitive help text)
	* gamesequence (Handles progression of events during a campaign, such as entering a mission, showing credits etc.)		* gamesequence (Handles progression of events during a campaign, such as entering a mission, showing credits etc.)

Echelon9: /* External Libraries */ Update to reflect current source code structure

2015-05-03T05:27:48Z

External Libraries: Update to reflect current source code structure

← Older revision		Revision as of 05:27, 3 May 2015
Line 2:		Line 2:

	FreeSpace 2 relies on the following libraries which are included in the source tree:		FreeSpace 2 relies on the following libraries which are included in the source tree:
	* ~~lua~~: ~~LUA Scripting language~~		* jansson: JSON library
	* libjpeg: JPEG library		* libjpeg: JPEG library
	* libpng: PNG library		* libpng: PNG library
			* lua: LUA Scripting language
			* mongoose: HTTP server library
			* oggvorbis: Ogg Vorbis sound library
			* openal: OpenAL sound library
	* zlib: ZIP compression library; necessary for libpng		* zlib: ZIP compression library; necessary for libpng
	* oggvorbis: Ogg Vorbis sound library
	* dx8sdk: DirectX 8 SDK ([[deprecation\|deprecated]])
	* dx9sdk: DirectX 9 SDK ([[deprecation\|deprecated]])

	~~See msdn.microsoft.com for discussion of the DirectX libraries.~~ For ~~the other libraries~~, look in the README files ~~for more information~~.		For information on each library, look in the respective README files.

	== FreeSpace 2 Source Code ==		== FreeSpace 2 Source Code ==

The E: Updating here....

2011-03-13T12:20:39Z

Updating here....

← Older revision		Revision as of 12:20, 13 March 2011
Line 3:		Line 3:
	FreeSpace 2 relies on the following libraries which are included in the source tree:		FreeSpace 2 relies on the following libraries which are included in the source tree:
	* lua: LUA Scripting language		* lua: LUA Scripting language
	* libjpeg: ~~Jpeg~~ library		* libjpeg: JPEG library
			* libpng: PNG library
			* zlib: ZIP compression library; necessary for libpng
	* oggvorbis: Ogg Vorbis sound library		* oggvorbis: Ogg Vorbis sound library
	* dx8sdk: DirectX 8 SDK ([[deprecation\|deprecated]])		* dx8sdk: DirectX 8 SDK ([[deprecation\|deprecated]])

SypheDMar: More Consistency

2011-03-10T15:17:11Z

More Consistency

← Older revision		Revision as of 15:17, 10 March 2011
Line 1:		Line 1:
	== External ~~libraries~~ ==		== External Libraries ==

	FreeSpace 2 relies on the following libraries which are included in the source tree:		FreeSpace 2 relies on the following libraries which are included in the source tree:
Line 93:		Line 93:
	* wxfred2 (Cross-platform version of FRED2)		* wxfred2 (Cross-platform version of FRED2)

	=== Layer ~~view~~ ===		=== Layer View ===

	* Infrastructure		* Infrastructure

SypheDMar: Fixed some spelling errors.

2011-03-10T15:16:34Z

Fixed some spelling errors.

SypheDMar: moved Sourcecode Reference to Source Code Reference

2011-03-10T15:06:03Z

moved Sourcecode Reference to Source Code Reference

← Older revision	Revision as of 15:06, 10 March 2011
(No difference)

Aardwolf at 07:46, 4 January 2009

2009-01-04T07:46:15Z

← Older revision		Revision as of 07:46, 4 January 2009
Line 5:		Line 5:
	* libjpeg: Jpeg library		* libjpeg: Jpeg library
	* oggvorbis: Ogg Vorbis sound library		* oggvorbis: Ogg Vorbis sound library
	* dx8sdk: DirectX 8 SDK		* dx8sdk: DirectX 8 SDK ([[deprecation\|deprecated]])
	* dx9sdk: DirectX 9 SDK		* dx9sdk: DirectX 9 SDK ([[deprecation\|deprecated]])

	See msdn.microsoft.com for discussion of the DirectX libraries. For the other libraries, look in the README files for more info		See msdn.microsoft.com for discussion of the DirectX libraries. For the other libraries, look in the README files for more info

Aardwolf at 07:38, 4 January 2009

2009-01-04T07:38:25Z

← Older revision		Revision as of 07:38, 4 January 2009
Line 48:		Line 48:
	* [[Source jpgutils\|jpgutils]] (Opens, reads JPG files)		* [[Source jpgutils\|jpgutils]] (Opens, reads JPG files)
	* jumpnode (Displays & handles jump nodes)		* jumpnode (Displays & handles jump nodes)
	* lab (Responsible for lab ~~model display?~~)		* lab (Responsible for WMCoolmon's F3 lab screen)
	* lighting (Handles light sources, and their effect on ships)		* lighting (Handles light sources, and their effect on ships)
	* localization (Handles a global string table for translating all written text into foreign languages)		* localization (Handles a global string table for translating all written text into foreign languages)
Line 60:		Line 60:
	* network (All multi-player code, eg. UI, network traffic)		* network (All multi-player code, eg. UI, network traffic)
	* object (High-level code to handle all objects eg. ships, weapons, debris, asteroids, waypoints, fireballs, shockwaves)		* object (High-level code to handle all objects eg. ships, weapons, debris, asteroids, waypoints, fireballs, shockwaves)
	* observer (~~Handles all non player ship views? Maybe~~ the ~~external views stuff, or death observation?~~)		* observer (Responsible for the multiplayer observer mode)
	* osapi (Wraps low-level Operating System calls, for different OS, eg. multi-threads, windows event loops, main app window)		* osapi (Wraps low-level Operating System calls, for different OS, eg. multi-threads, windows event loops, main app window)
	* padlock (Handles cockpit views with a simulated head tracking of targets relative to the ship)		* padlock (Handles cockpit views with a simulated head tracking of targets relative to the ship)

Aardwolf: /* Alphabetical view */

2009-01-04T07:34:28Z

Alphabetical view

← Older revision		Revision as of 07:34, 4 January 2009
Line 21:		Line 21:
	* autopilot (Handles autopilot control - where if there are no enemies, travelling a long distance etc. control is temporarily switched to the computer)		* autopilot (Handles autopilot control - where if there are no enemies, travelling a long distance etc. control is temporarily switched to the computer)
	* [[Source bmpman\|bmpman]] (Manage 2d graphics files, such as .bmp, .tga, .jpg etc.)		* [[Source bmpman\|bmpman]] (Manage 2d graphics files, such as .bmp, .tga, .jpg etc.)
	* camera (???)		* camera (used for ingame cutscenes ???)
	* cfile (File/directory management routines including .VP file handling that are OS independent eg. handles differences between Linux & Windows)		* cfile (File/directory management routines including .VP file handling that are OS independent eg. handles differences between Linux & Windows)
	* cmdline (Handles command line switches, such as -mipmap etc.)		* cmdline (Handles command line switches, such as -mipmap etc.)
Line 43:		Line 43:
	* [[Source graphics\|graphics]] (Low-level wrapper for all 2d & 3d graphics that handles different display engines (DirectX, OpenGL etc)		* [[Source graphics\|graphics]] (Low-level wrapper for all 2d & 3d graphics that handles different display engines (DirectX, OpenGL etc)
	* hud (Handles the HUD - all the 2d cockpit graphics that the player can see eg. radar, ammo, escort list, sqaud etc)		* hud (Handles the HUD - all the 2d cockpit graphics that the player can see eg. radar, ammo, escort list, sqaud etc)
	* iff_defs (Handles ~~traitor ships???~~)		* iff_defs (Handles the iffs in [[iff_defs.tbl]], controlling what color they show up as and what iffs they attack)
	* io (Handles IO devices, such as keyboard, mouse & joystick)		* io (Handles IO devices, such as keyboard, mouse & joystick)
	* irc (Adds support for an IRC chat client)		* irc (Adds support for an IRC chat client)

KewlToyZ: /* Alphabetical view */

2008-03-28T05:41:29Z

Alphabetical view

← Older revision		Revision as of 05:41, 28 March 2008
Line 62:		Line 62:
	* observer (Handles all non player ship views? Maybe the external views stuff, or death observation?)		* observer (Handles all non player ship views? Maybe the external views stuff, or death observation?)
	* osapi (Wraps low-level Operating System calls, for different OS, eg. multi-threads, windows event loops, main app window)		* osapi (Wraps low-level Operating System calls, for different OS, eg. multi-threads, windows event loops, main app window)
			* padlock (Handles cockpit views with a simulated head tracking of targets relative to the ship)
	* palman (Handles bitmap palettes - different colour maps for the same 2d bitmap)		* palman (Handles bitmap palettes - different colour maps for the same 2d bitmap)
	* parse (Handles scripting files, eg. python, LUA etc)		* parse (Handles scripting files, eg. python, LUA etc)

← Older revision		Revision as of 15:16, 10 March 2011
Line 1:		Line 1:
	== External libraries ==		== External libraries ==

	~~Freespace2~~ relies on the following libraries, which are included in the source tree:		FreeSpace 2 relies on the following libraries which are included in the source tree:
	* lua: LUA Scripting language		* lua: LUA Scripting language
	* libjpeg: Jpeg library		* libjpeg: Jpeg library
Line 8:		Line 8:
	* dx9sdk: DirectX 9 SDK ([[deprecation\|deprecated]])		* dx9sdk: DirectX 9 SDK ([[deprecation\|deprecated]])

	See msdn.microsoft.com for discussion of the DirectX libraries. For the other libraries, look in the README files for more ~~info~~		See msdn.microsoft.com for discussion of the DirectX libraries. For the other libraries, look in the README files for more information.

	== ~~Freespace2~~ Source Code ==		== FreeSpace 2 Source Code ==

	The root also contains the actual ~~Freespace2~~ code, in the code/ directory. The ~~Freespace2~~ source code consists in several components, each of which is kept in a separate subdirectory. These components are listed below, from different views.		The root also contains the actual FreeSpace 2 code, in the code/ directory. The FreeSpace 2 source code consists of several components, each of which is kept in a separate subdirectory. These components are listed below from different views.

	=== Alphabetical ~~view~~ ===		=== Alphabetical View ===

	* [[Source ai\|ai]] (Computer AI)		* [[Source ai\|ai]] (Computer AI)
	* [[Source anim\|anim]] (Displaying .ani animated bitmaps)		* [[Source anim\|anim]] (Displaying .ani animated bitmaps)
	* asteroid (Handle asteroids - movement, collisions, creating smaller ~~asteriods~~ when larger ones are blown up etc.)		* asteroid (Handle asteroids - movement, collisions, creating smaller asteroids when larger ones are blown up etc.)
	* autopilot (Handles autopilot control - where if there are no enemies, travelling a long distance etc. control is temporarily switched to the computer)		* autopilot (Handles autopilot control - where if there are no enemies, travelling a long distance etc. control is temporarily switched to the computer)
	* [[Source bmpman\|bmpman]] (Manage 2d graphics files, such as .bmp, .tga, .jpg etc.)		* [[Source bmpman\|bmpman]] (Manage 2d graphics files, such as .bmp, .tga, .jpg etc.)
	* camera (used for ingame cutscenes ???)		* camera (used for ingame cutscenes ???)
	* cfile (File/directory management routines including .VP file handling that are OS independent eg. handles differences between Linux & Windows)		* cfile (File/directory management routines including .VP file handling that are OS independent e.g. handles differences between Linux & Windows)
	* cmdline (Handles command line switches, such as -mipmap etc.)		* cmdline (Handles command line switches, such as -mipmap etc.)
	* cmeasure (Handles countermeasures - flares that the player & AI can drop to disrupt missiles)		* cmeasure (Handles countermeasures - flares that the player & AI can drop to disrupt missiles)
Line 42:		Line 42:
	* globalincs (Basic global constants & definitions, eg. version, colours)		* globalincs (Basic global constants & definitions, eg. version, colours)
	* [[Source graphics\|graphics]] (Low-level wrapper for all 2d & 3d graphics that handles different display engines (DirectX, OpenGL etc)		* [[Source graphics\|graphics]] (Low-level wrapper for all 2d & 3d graphics that handles different display engines (DirectX, OpenGL etc)
	* hud (Handles the HUD - all the 2d cockpit graphics that the player can see eg. radar, ammo, escort list, ~~sqaud~~ etc)		* hud (Handles the HUD - all the 2d cockpit graphics that the player can see e.g. radar, ammo, escort list, squad etc)
	* iff_defs (Handles the iffs in [[iff_defs.tbl]], controlling what color they show up as and what iffs they attack)		* iff_defs (Handles the iffs in [[iff_defs.tbl]], controlling what color they show up as and what iffs they attack)
	* io (Handles IO devices, such as keyboard, mouse & joystick)		* io (Handles IO devices, such as keyboard, mouse & joystick)
Line 53:		Line 53:
	* math (Library of math routines for handling vectors, splines etc)		* math (Library of math routines for handling vectors, splines etc)
	* menuui (Handles all the misc user interface, such as the main menu, tech room, campaign list etc)		* menuui (Handles all the misc user interface, such as the main menu, tech room, campaign list etc)
	* mission (Handles general mission actions eg. briefing, goals, training info, in-mission messages etc)		* mission (Handles general mission actions e.g. briefing, goals, training info, in-mission messages etc)
	* missionui (Handles UI for general mission actions)		* missionui (Handles UI for general mission actions)
	* mm (Headers for older MS Multimedia library)		* mm (Headers for older MS Multimedia library)
	* model (Displays and handles ship models eg. reading files, ~~collission~~ detection etc)		* model (Displays and handles ship models e.g. reading files, collision detection etc)
	* nebula (Displays and handles nebulae)		* nebula (Displays and handles nebulae)
	* network (All multi-player code, eg. UI, network traffic)		* network (All multi-player code, e.g. UI, network traffic)
	* object (High-level code to handle all objects eg. ships, weapons, debris, asteroids, waypoints, fireballs, shockwaves)		* object (High-level code to handle all objects eg. ships, weapons, debris, asteroids, waypoints, fireballs, shockwaves)
	* observer (Responsible for the multiplayer observer mode)		* observer (Responsible for the multiplayer observer mode)
Line 69:		Line 69:
	* physics (Handles realistic physical behaviour of objects, such as ship acceleration/deceleration, rotation etc.)		* physics (Handles realistic physical behaviour of objects, such as ship acceleration/deceleration, rotation etc.)
	* playerman (Handles pilot files & player ship movement)		* playerman (Handles pilot files & player ship movement)
	* popup (Displays & handles 2d pop-up windows, eg. when the player dies)		* popup (Displays & handles 2d pop-up windows, e.g. when the player dies)
	* radar (Displays & handles the radar)		* radar (Displays & handles the radar)
	* [[Source render\|render]] (Low-level 3d rendering code for some primitives)		* [[Source render\|render]] (Low-level 3d rendering code for some primitives)
	* ship (Displays & handles all ship code, eg. shields, afterburner)		* ship (Displays & handles all ship code, e.g. shields, afterburner)
	* sound (Low-level sound, ~~speach~~ & music routines)		* sound (Low-level sound, speech & music routines)
	* species_defs (Reads species_defs.tbl to handle different behaviour for different species)		* species_defs (Reads species_defs.tbl to handle different behaviour for different species)
	* starfield (Displays & handles background images such as starfields, nebulae etc)		* starfield (Displays & handles background images such as starfields, nebulae etc)
	* stats (Displays & handles player statistics, medals etc)		* stats (Displays & handles player statistics, medals etc)
	* [[Source tgautils\|tgautils]] (Handles .tga 2d graphics files)		* [[Source tgautils\|tgautils]] (Handles .tga 2d graphics files)
	* ui (Low-level user inteface routines eg. buttons, scrollbars)		* ui (Low-level user inteface routines e.g. buttons, scrollbars)
	* vcodec (Handles player voice streaming for multiplayer ???)		* vcodec (Handles player voice streaming for multiplayer ???)
	* weapon (Displays & handles everything to do with weapons)		* weapon (Displays & handles everything to do with weapons)