This file is indexed.

/usr/share/doc/sludge/SLUDGEDevKitHelp/ini.html is in sludge-doc 2.2.1-2build2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<TITLE>.ini Files for Compiled SLUDGE Games</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>.ini Files for Compiled SLUDGE Games</h2>
<HR>


<P>
When a game is launched, the SLUDGE engine also attempts to read a file of 
initialisation settings. On Windows, SLUDGE puts settings and saved games 
in the AppData folder, on Mac it's ~/Library/Application Support, and
on Linux it's $HOME/.sludge-engine/. 
In that folder, SLUDGE looks for (or makes) a folder with the name of the 
game.  That's where the file with the initialisation settings should be. 
The file must have the same name as your compiled game file, but with the 
extension ".ini". For example, if the compiler builds you a compiled game 
file called "Turnip Quest VI.slg" your settings file would be called 
"Turnip Quest VI.ini". If you're going to rename your file so that it's 
called "mygame" or "mygame.dat" or "mygame.001" or something, your 
settings should be in a file called "mygame.ini". (If no matching 
file is found, that's fine... the game will run with the default settings.)
</P>

<P>
SLUDGE will write the current settings to that file after the startup window so that they'll be remembered.
</P>

<P>
So, what can go in an .ini file? Well, the list is growing.
</P>

<H3>Choice of language</H3>

<P>
<B>LANGUAGE=</B>
</P>

<P>
If the SLUDGE game's .ini file contains a line which starts with "LANGUAGE=" the rest of the line is used as the ID number of the language the game should be played in. For more information, read how you can use <a href="Multiple_Languages_in_a_Single_Game.html">multiple Languages in a Single Game</a>.
</P>

<P>
If no such line exists, or the .ini file does not exist, the default language ID is used - 0, meaning no translation.
</P>

<H3>Run game in a window</H3>

<P>
<B>WINDOW=</B>
</P>

<P>
If the game's .ini file contains a line which starts with "WINDOW=" the rest of the line defines whether the game should be run in a forced to run in a window. A non-zero number (for example, 1) means the game should be forced to run in a window. A value of "0" or anything else means it shouldn't. (Note that if the compiled game isn't meant to run full screen, this value won't force it to run full screen. It will have no effect.)
</P>

<P>
If no such line exists, or the .ini file does not exist, the default is 0. The game won't be forced to run in a window.

</P>

<H3>Anti-aliasing</H3>

<P>
<B>ANTIALIAS=</B>
</P>

<P>
Turns anti-aliasing on (a value of 1) or off (a value of 0).

</P>

<H3>Disable scaling</H3>

<P>
<B>FIXEDPIXELS=</B>
</P>

<P>
If the FIXEDPIXELS setting is non-zero, the engine disables the scaling of the 
game and simply creates a window with the exact size specified by the game.

</P>

<H3>Disable startup window</H3>

<P>
<B>NOSTARTWINDOW=</B>
</P>

<P>
If the NOSTARTWINDOW setting is non-zero, the engine won't display the settings 
window at startup.

</P>

<H3>Debugging the engine</H3>

<P>
<B>DEBUG=</B>
</P>

<P>
If the DEBUG setting is non-zero, the engine will write debugging information
to a file named "debuggy.txt" in the same folder as the ini file. This is only
useful for debugging the engine, and is off by default.
</P>

<P>
<H3>Other lines in the .ini file</H3>

</P>

<P>
You may not store any additional data in the file along with the above data, since anything else will get overwritten. Instead, you can store your own settings in another .ini file, and then read them using your own code using <a href="loadCustomData_and_saveCustomData.html">loadCustomData</a>.
</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>