/usr/share/doc/sludge/SLUDGEDevKitHelp/File_Formats_Used_by

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>File Formats Used by SLUDGE</TITLE>
  <link rel="stylesheet" type="text/css" href="style.css" />
</head>
<BODY>
<HR>
<div align="center"><img id="headerGraphic" src="images/sludge300.png" alt="SLUDGE"/></div>
<h2>File Formats Used by SLUDGE</h2>
<HR>


<P>
In order to create a game using SLUDGE you will have to be able to handle files 
using your operating system. (Explorer on Windows and Finder on Mac.) Much of the 
file handling in SLUDGE is automated, but in order to use graphics, sounds and 
music (for example) you will have to create and work with the files yourself.
</P>

<P>
<b>*</b>= These file formats can be included in a SLUDGE compiled game. See the 
section on <a href="File_Handling.html">file handling</a> for information on how 
to include these files in a compiled game. Other file types (such as HTML pages 
or PDF files) can be opened by a SLUDGE game using the 
<a href="launch_and_launchWith.html">launch and launchWith</a> commands. 
These files must then be provided with the compiled game, as they will not be 
included inside the file itself.
</P>

<H3>File formats specific to SLUDGE:</H3>

<P>
<B>.SLP</B>
</P>

<P>
The extension given to a SLUDGE project file, as used by the <a href="About_the_SLUDGE_Project_Manager.html">SLUDGE project manager</a> and <a href="About_the_SLUDGE_Compiler.html">SLUDGE compiler</a> - these files contain the filenames of the scripts from which the game is to be built and general project data (such as a game's title, whether it should be run full-screen and so on).
Must be a UTF-8 encoded text file.
</P>

<P>
<B>.SLU</B>
</P>

<P>
A SLUDGE script, containing object definitions and functions. 
See the <a href="SLUDGE_Language_Reference_Manual.html">SLUDGE Language Reference Manual</a> for information on how to use the language.
Must be a UTF-8 encoded text file.
</P>

<P>
<B>.SLD</B>
</P>

<P>
A SLUDGE constant definitions file. Here you can set up your own 
<a href="Using_Constants_in_SLUDGE.html">constant definitions</a> 
(which are used in a similar way to items created using #define in C and C++).
Must be a UTF-8 encoded text file.
</P>

<P>
<B>.TRA</B>
</P>

<P>
A SLUDGE translation file. Contains translations of strings in a game into one different language. Can be
created using the <a href="About_the_SLUDGE_Translation_Editor.html">SLUDGE translation editor</a>.
Must be a UTF-8 encoded text file.
</P>

<P>
<B>.SLG</B>
</P>

<P>
A compiled SLUDGE game. Double click it to play it. Requires an up-to-date version 
of the SLUDGE engine to be installed on your machine. These compiled game files can 
be <a href="release_the_game.html">distributed</a> as you see fit.
</P>

<P>
<B>.INI</B>
</P>

<P>
See <a href="ini.html">.ini files for compiled SLUDGE games</a>.
</P>

<P>
<B>.ZBU *</B>
</P>

<P>
A SLUDGE z-buffer file. These can be created using the 
<a href="About_the_SLUDGE_Z-Buffer_Maker.html">SLUDGE z-buffer maker</a> and can 
be loaded and unloaded using the <a href="setZBuffer.html">setZBuffer</a> function.
</P>

<P>
<B>.FLO *</B>
</P>

<P>
A SLUDGE floor file. These can be created using the 
<a href="About_the_SLUDGE_Floor_Maker.html">SLUDGE floor maker</a> and can be 
loaded and unloaded using the <a href="setFloor.html">setFloor</a> function.
</P>

<P>
<B>.DUC *</B>
</P>

<P>
A SLUDGE sprite bank file, containing one or more (or zero, but that's a bit 
pointless) sprites for use in a game. Sprites are used for mouse cursors, moving 
characters and inventory objects. Create and maintain these files using the 
<a href="About_the_SLUDGE_Sprite_Bank_Editor.html">SLUDGE sprite bank editor</a> 
and use them in animations for your game with the <a href="anim.html">anim</a> 
command. The extension .DUC comes from a previous Hungry Software game, Ducks, 
which used the same file format for its sprites.
</P>

<P>
<B>.SLX</B>
</P>

<P>
An image compressed using the SLUDGE image compression algorithm. These are 
optionally left on your machine after compilation; you can enable and disable this 
feature by selecting &quot;Keep compressed images&quot; from the &quot;SLUDGE 
Settings&quot; <a href="Project_Manager__Menus.html">menu</a> in the 
<a href="About_the_SLUDGE_Project_Manager.html">SLUDGE project manager</a> 
application. Keeping these files decreases the time it takes to compile your game. 
However, you can't actually use them for anything yourself. Don't, for example, 
expect notepad or a paint package to make any sense of them. (These files are not
created when you include PNG files - only TGA files are converted to SLX.)
</P>

<H3>Standard formats used by SLUDGE:</H3>

<P>
<B>.TGA .PNG *</B>
</P>

<P>
The graphics formats with which SLUDGE works. Load images into your game using the <a href="addOverlay.html">addOverlay</a> 
function or convert images into z-buffers and sprite banks using the <a href="About_the_SLUDGE_Z-Buffer_Maker.html">SLUDGE 
z-buffer maker</a> and <a href="About_the_SLUDGE_Sprite_Bank_Editor.html">SLUDGE sprite bank editor</a> respectively.
</P>

<P>
<B>.WAV, .OGG *</B>
</P>

<P>
Sound effects, music and, if you choose, recorded speech. Play these using the 
<a href="playSound.html">playSound</a> function, loop them with 
<a href="loopSound.html">loopSound</a> or make characters say or think them with 
the <a href="say_and_think.html">say and think</a> functions. (Using Ogg Vorbis
rather than WAV is strongly suggested.)
</P>

<P>
<B>.WebM *</B>
</P>

<P>
Movies. Play these using the <a href="playMovie.html">playMovie</a> function.
</P>

<P>
<B>.XM, .IT, .S3M *</B>
</P>

<P>
The track-based music formats supported by SLUDGE. Play these using the <a href="startMusic.html">startMusic</a> function.
</P>

<P>
<B>.MID, .RMI *</B>
</P>

<P>
Midi music. The current SLUDGE engine cannot play these - however, you can still 
try, so that old projects still compile. Trying to do so, however, will produce a 
warning. If you have a midi song you want to use, convert it to Ogg Vorbis and use
that instead.
</P>

<P class="copyright-notice">SLUDGE and this SLUDGE documentation are <A HREF="Copyright.html">copyright</A> Hungry Software and contributors 2000-2012
</P>

<HR>
</BODY>
</html>
sludge-doc 2.2.1-2build2 / usr / share / doc / sludge / SLUDGEDevKitHelp / File_Formats_Used_by_SLUDGE.html
