FreeCraft Configuration Language Description: Config
___________ _________ _____ __
\_ _____/______ ____ ____ \_ ___ \____________ _/ ____\/ |_
| __) \_ __ \_/ __ \_/ __ \/ \ \/\_ __ \__ \\ __\\ __|
| \ | | \/\ ___/\ ___/\ \____| | \// __ \| | | |
\___ / |__| \___ >\___ >\______ /|__| (____ /__| |__|
\/ \/ \/ \/ \/
______________________ ______________________
T H E W A R B E G I N S
FreeCraft - A free fantasy real time strategy game engine
(C) Copyright 2002-2003 by The FreeCraft Project. Distributed under the
"GNU General Public License"
FreeCraft
Readme
FAQ
CCL
PREV
NEXT
Index
a-star
a-star-fixed-unit-cost
a-star-moving-unit-cost
alpha-fog-of-war
decoration-on-top
health-sprite
mana-sprite
no-a-star
original-fog-of-war
reveal-map
right-button-attacks
right-button-moves
set-all-players-building-limit!
set-all-players-food-unit-limit!
set-all-players-total-unit-limit!
set-brightness!
set-building-capture!
set-burn-buildings!
set-color-cycle-all!
set-contrast!
set-double-click-delay!
set-editor-select-icon!
set-editor-units-icon!
set-fancy-buildings!
set-fog-of-war!
set-fog-of-war-brightness!
set-fog-of-war-contrast!
set-fog-of-war-saturation!
set-forest-regeneration!
set-goldmine-depleted!
set-grab-mouse!
set-hitpoint-regeneration!
set-hold-click-delay!
set-key-scroll!
set-key-scroll-speed!
set-leave-stops!
set-menu-background!
set-menu-background-with-title!
set-minimap-terrain!
set-mouse-adjust!
set-mouse-scale!
set-mouse-scroll!
set-mouse-scroll-speed!
set-original-resources!
set-reveal-attacker!
set-reverse-map-move!
set-saturation!
set-selection-style!
set-show-attack-range!
set-show-command-key!
set-show-orders!
set-show-reaction-range!
set-show-sight-range!
set-show-tips!
set-speed-build!
set-speed-chop!
set-speed-gold!
set-speed-haul!
set-speed-mine!
set-speed-oil!
set-speed-research!
set-speed-train!
set-speed-upgrade!
set-speed-wood!
set-speeds!
set-title-screen!
set-training-queue!
set-xp-damage!
shadow-sprite
show-energy-selected-only
show-full
show-health-bar
show-health-dot
show-health-horizontal
show-health-vertical
show-mana-bar
show-mana-dot
show-mana-horizontal
show-mana-vertical
show-no-full
spell-sprite
Intro - Introduction to config functions and variables
General configurations.
Functions
a-star
Description
.
Syntax
(a-star)
Example
(a-star)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
a-star-fixed-unit-cost
Description
.
Syntax
(a-star-fixed-unit-cost cost)
- cost
- .
Example
(a-star-fixed-unit-cost)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
a-star-moving-unit-cost
Description
.
Syntax
(a-star-moving-unit-cost cost)
- cost
- .
Example
(a-star-moving-unit-cost)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
alpha-fog-of-war
Description
Use alpha style fog of war.
Syntax
(alpha-fog-of-war)
Example
(alpha-fog-of-war)
Use alpha style fog of war.
Used
$LIBARYPATH/ccl/freecraft.ccl
decoration-on-top
Description
Show bars and dots always on top. (Planned feature)
Syntax
(decoration-on-top)
Example
(decoration-on-top)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
health-sprite
Description
.
Syntax
(health-sprite file hotx hoty width height)
- file
- .
- hotx
- .
- hoty
- .
- width
- .
- height
- .
Example
(health-sprite "graphics/ui/health2.png" 0 -4 31 4)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
mana-sprite
Description
.
Syntax
(mana-sprite file hotx hoty width height))
- file
- .
- hotx
- .
- hoty
- .
- width
- .
- height
- .
Example
(mana-sprite graphics/ui/mana2.png" 0 -1 31 4)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
no-a-star
Description
.
Syntax
(no-a-star)
Example
(no-a-star)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
original-fog-of-war
Description
Use original style fog of war.
Syntax
(original-fog-of-war)
Example
(original-fog-of-war)
Use original style fog of war.
Used
$LIBARYPATH/ccl/freecraft.ccl
reveal-map
Description
Reveal the entire map.
Syntax
(reveal-map)
Example
(reveal-map)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
right-button-attacks
Description
.
Syntax
(right-button-attacks)
Example
(right-button-attacks)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
right-button-moves
Description
.
Syntax
(right-button-moves)
Example
(right-button-moves)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-all-players-building-limit!
Description
.
Syntax
(set-all-players-building-limit! limit)
- limit
- .
Example
(set-all-players-building-limit! 200)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-all-players-food-unit-limit!
Description
.
Syntax
(set-all-players-food-unit-limit! limit)
- limit
- .
Example
(set-all-players-food-unit-limit! 200)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-all-players-total-unit-limit!
Description
.
Syntax
(set-all-players-total-unit-limit! limit)
- limit
- .
Example
(set-all-players-total-unit-limit! 400)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-brightness!
Description
Change the global game brightness. Use this to adapt FreeCraft to your monitor
settings.
Syntax
(set-brightness! brightness)
- brightness
- Your brightness, can be a value from -100 to 100. 0 is the neutral point.
Example
(set-brightness! 15)
This is the default brightness. A little lighter than the original.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-building-capture!
Description
Enable or disable building capture.
Syntax
(set-building-capture! capture)
- capture
- .
Example
(set-building-capture! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-burn-buildings!
Description
.
Syntax
(set-burn-buildings! percent rate)
- percent
- .
- rate
- .
Example
(set-burn-buildings! 25 2)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-color-cycle-all!
Description
Change how the color cycling is working. This is used to make the water moving
or the circle in the dark portal rotating.
Syntax
(set-color-cycle-all! flag)
- flag
- If flag is true (#t) all images are color cycled. If flag is false (#f) only the tileset and global palettes are color cycled.
Example
(set-color-cycle-all! #t)
This is the default, all images are color cycled.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-contrast!
Description
Change the global game contrast. Use this to adapt FreeCraft to your monitor
settings.
Syntax
(set-contrast! contrast)
- contrast
- Your contrast, can be a value from 0 to 400. 100 is the neutral point.
Example
(set-contrast! 110)
This is the default contrast. A little more than the original.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-double-click-delay!
Description
.
Syntax
(set-double-click-delay! delay)
- delay
- The delay in ms.
Example
(set-double-click-delay! 300)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-editor-select-icon!
Description
.
Syntax
(set-editor-select-icon! icon)
- icon
- The name of the icon.
Example
(set-editor-select-icon! 'icon-human-patrol-land)
Use "icon-human-patrol-land" for the editor's select icon.
Used
$LIBARYPATH/ccl/editor.ccl
set-editor-units-icon!
Description
.
Syntax
(set-editor-units-icon! icon)
- icon
- The name of the icon.
Example
(set-editor-units-icon! 'unit-footman)
Use "icon-footman" for the editor's units icon.
Used
$LIBARYPATH/ccl/editor.ccl
set-fancy-buildings!
Description
.
Syntax
(set-fancy-buildings! fancy)
- fancy
- .
Example
(set-fancy-buildings! #t)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-fog-of-war!
Description
.
Syntax
(set-fog-of-war! fow)
- fow
- .
Example
(set-fog-of-war! #t)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-fog-of-war-brightness!
Description
.
Syntax
(set-fog-of-war-brightness! brightness)
- brightness
- .
Example
(set-fog-of-war-brightness! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-fog-of-war-contrast!
Description
.
Syntax
(set-fog-of-war-contrast! contrast)
- contrast
- .
Example
(set-fog-of-war-contrast! 30)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-fog-of-war-saturation!
Description
.
Syntax
(set-fog-of-war-saturation! saturation)
- saturation
- .
Example
(set-fog-of-war-saturation! 100)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-forest-regeneration!
Description
.
Syntax
(set-forest-regeneration! speed)
- speed
- .
Example
(set-forest-regeneration! 0)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-goldmine-depleted!
Description
Set the option to use depleted goldmines.
Syntax
(set-goldmine-depleted! percent)
- percent
- Players mining a depleted mine receive this percent of the default amount
of gold. Use 0 to disable using depleted mines.
Example
(set-goldmine-depleted! 0)
(set-goldmine-depleted! 20)
The first example disables using depleted mines. The second example lets
players mine depleted mines and gives them 20% of the default amount of gold.
Not Used
set-grab-mouse!
Description
.
Syntax
(set-grab-mouse! grab)
- grab
- .
Example
(set-grab-mouse! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-hitpoint-regeneration!
Description
.
Syntax
(set-hitpoint-regeneration! regen)
- regen
- .
Example
(set-hitpoint-regeneration! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-hold-click-delay!
Description
.
Syntax
(set-hold-click-delay! delay)
- delay
- .
Example
(set-hold-click-delay! 1000)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-key-scroll!
Description
.
Syntax
(set-key-scroll! scroll)
- scroll
- .
Example
(set-key-scroll! #t)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-key-scroll-speed!
Description
.
Syntax
(set-key-scroll-speed! speed)
- speed
- .
Example
(set-key-scroll-speed! 1)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-leave-stops!
Description
.
Syntax
(set-leave-stops! leave)
- leave
- .
Example
(set-leave-stops! #t)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-menu-background!
Description
Set the default menu background.
Syntax
(set-menu-background! image)
- image
- Image to be displayed as menu background, this is the second screen
displayed. The image should be a png file with 640x480 8-bit indexed colormap.
Example
(set-menu-background! "graphics/ui/Menu background without title.png")
This is the default menu background displayed.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-menu-background-with-title!
Description
Set the default menu background with title.
Syntax
(set-menu-background-with-title! image)
- image
- Image to be displayed as menu background with title, this is the second screen
displayed. The image should be a png file with 640x480 8-bit indexed colormap.
Example
(set-menu-background-with-title! "graphics/ui/Menu background with title.png")
This is the default menu background with title displayed.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-minimap-terrain!
Description
.
Syntax
(set-minimap-terrain! terrain)
- terrain
- .
Example
(set-minimap-terrain! #t)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-mouse-adjust!
Description
(Only with SVGALIB).
Syntax
(set-mouse-adjust! speed)
- speed
- .
Example
(set-mouse-adjust! 15)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-mouse-scale!
Description
(Only with SVGALIB).
Syntax
(set-mouse-scale! scale)
- scale
- .
Example
(set-mouse-scale! 1)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-mouse-scroll!
Description
.
Syntax
(set-mouse-scroll! scroll)
- scroll
- .
Example
(set-mouse-scroll! #t)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-mouse-scroll-speed!
Description
.
Syntax
(set-mouse-scroll-speed! speed)
- speed
- .
Example
(set-mouse-scroll-speed! 1)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-original-resources!
Description
.
Syntax
(set-original-resources! resources)
- resources
- .
Example
(set-original-resources! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-reveal-attacker!
Description
.
Syntax
(set-reveal-attacker! reveal)
- reveal
- .
Example
(set-reveal-attacker! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-reverse-map-move!
Description
.
Syntax
(set-reverse-map-move! reverse)
- reverse
- .
Example
(set-reverse-map-move! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-saturation!
Description
Change the global game saturation. Use this to adapt FreeCraft to your monitor
settings.
Syntax
(set-saturation! saturation)
- saturation
- Your saturation, can be a value from -100 to 200. 100 is the neutral point.
Example
(set-saturation! 100)
This is the default saturation.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-selection-style!
Description
.
Syntax
(set-selection-style! style)
- style
- #f,'rectangle,'circle,'alpha-rectangle,'alpha-circle,'corners.
Example
(set-selection-style! 'corners)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-show-attack-range!
Description
.
Syntax
(set-show-attack-range! show)
- show
- .
Example
(set-show-attack-range! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-show-command-key!
Description
.
Syntax
(set-show-command-key! show)
- show
- .
Example
(set-show-command-key! #t)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-show-orders!
Description
Show unit orders.
Syntax
(set-show-orders! show)
- show
- Use #t to always show unit orders, #f to never show orders. Or use a
number to specify the number of seconds an order should be shown.
Example
(set-show-orders! #f)
(set-show-orders! 2)
The first example never shows unit orders. The second example only shows
orders for 2 seconds.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-show-reaction-range!
Description
.
Syntax
(set-show-reaction-range! show)
- show
- .
Example
(set-show-reaction-reaction-range! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-show-sight-range!
Description
.
Syntax
(set-show-sight-range! range)
- range
- #f,'rectangle,'circle,'#t.
Example
(set-show-sight-range! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-show-tips!
Description
.
Syntax
(set-show-tips! tips)
- tips
- .
Example
(set-show-tips! #t)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-build!
Description
Set build speed.
Syntax
(set-speed-build! speed)
- speed
- .
Example
(set-speed-build! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-chop!
Description
Set chop speed.
Syntax
(set-speed-chop! speed)
- speed
- .
Example
(set-speed-chop! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-gold!
Description
Set gold speed.
Syntax
(set-speed-gold! speed)
- speed
- .
Example
(set-speed-gold! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-haul!
Description
Set haul speed.
Syntax
(set-speed-haul! speed)
- speed
- .
Example
(set-speed-haul! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-mine!
Description
Set mine speed.
Syntax
(set-speed-mine! speed)
- speed
- .
Example
(set-speed-mine! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-oil!
Description
Set oil speed.
Syntax
(set-speed-oil! speed)
- speed
- .
Example
(set-speed-oil! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-research!
Description
Set research speed.
Syntax
(set-speed-research! speed)
- speed
- .
Example
(set-speed-research! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-train!
Description
Set train speed.
Syntax
(set-speed-train! speed)
- speed
- .
Example
(set-speed-train! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-upgrade!
Description
Set upgrade speed.
Syntax
(set-speed-upgrade! speed)
- speed
- .
Example
(set-speed-upgrade! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speed-wood!
Description
Set wood speed.
Syntax
(set-speed-wood! speed)
- speed
- .
Example
(set-speed-wood! 10)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-speeds!
Description
Set all speeds.
Syntax
(set-speeds! speed)
- speed
- .
Example
(set-speeds! 1)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-title-screen!
Description
Change the default title screen.
Syntax
(set-title-screen! image)
- image
- Image to be displayed as title screen, this is the first screen
displayed. The image should be a png file with 640x480 8-bit indexed colormap.
Example
(set-title-screen! "graphics/ui/freecraft.png")
This is the default title displayed.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-training-queue!
Description
.
Syntax
(set-training-queue! queue)
- queue
- .
Example
(set-training-queue! #t)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
set-xp-damage!
Description
.
Syntax
(set-xp-damage! damage)
- damage
- .
Example
(set-xp-damage! #f)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
shadow-sprite
Description
.
Syntax
(shadow-sprite file hotx hoty width height)
- file
- .
- hotx
- .
- hoty
- .
- width
- .
- height
- .
Example
(shadow-sprite "graphics/missiles/unit shadow.png" 3 42 32 32)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-energy-selected-only
Description
.
Syntax
(show-energy-selected-only)
Example
(show-energy-selected-only)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-full
Description
.
Syntax
(show-full)
Example
(show-full)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-health-bar
Description
.
Syntax
(show-health-bar)
Example
(show-health-bar)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-health-dot
Description
.
Syntax
(show-health-dot)
Example
(show-health-dot)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-health-horizontal
Description
.
Syntax
(show-health-horizontal)
Example
(show-health-horizontal)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-health-vertical
Description
.
Syntax
(show-health-vertical)
Example
(show-health-vertical)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-mana-bar
Description
.
Syntax
(show-mana-bar)
Example
(show-mana-bar)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-mana-dot
Description
.
Syntax
(show-mana-dot)
Example
(show-mana-dot)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-mana-horizontal
Description
.
Syntax
(show-mana-horizontal)
Example
(show-mana-horizontal)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-mana-vertical
Description
.
Syntax
(show-mana-vertical)
Example
(show-mana-vertical)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
show-no-full
Description
.
Syntax
(show-no-full)
Example
(show-no-full)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
spell-sprite
Description
.
Syntax
(spell-sprite file hotx hoty width height)
- file
- .
- hotx
- .
- hoty
- .
- width
- .
- height
- .
Example
(spell-sprite "graphics/ui/bloodlust,haste,slow,invisible,shield.png" 1 1 16 16)
.
Used
$LIBARYPATH/ccl/freecraft.ccl
Last changed: $Id: config.html,v 1.14 2003/02/05 00:35:02 jsalmon3 Exp $
All trademarks and copyrights on this page are owned by their respective owners.
(c) 2002-2003 by
The FreeCraft Project