-
Notifications
You must be signed in to change notification settings - Fork 9
Setup
The engine Setup program allows the player to customize certain game settings.
NOTE: currently setup program is featured only for Windows.
The options in setup are divided into two parts: common and advanced. Advanced options could be accessed by pressing "Advanced" button.
Driver
Lets player choose a graphics driver. Currently supported are Software renderer (old and slower one, but only driver that fully supports 8-bit games), Direct3D 9 and OpenGL (newer and faster drivers with hardware acceleration, but without proper palette-based effects support).
Start in a windowed mode
If checked, the game will be run in windowed mode, as opposed to fullscreen.
Mode
Lets choose a fullscreen display mode (otherwise shows the approximate size of window the game will be running in). The list of modes depends on graphic card and system capabilities.
Fullscreen scale Windowed scale
These two options determine the way game will be scaled (when required) in fullscreen and windowed modes respectively:
None. The game will be shown in its native resolution. Note that low-resolution games will be running in a tiniest window on modern monitors, so this choice is more suitable for high-resolution games.
Max round multiplier. The game will be scaled up using a maximal round integer (2, 3, 4, etc) multiplier with which it still fits inside the screen.
Stretch to fit screen. The game will be stretched to fill whole screen. Note that if the game's native aspect ratio is different from screen one's, the game image will appear deformed.
Stretch to fit screen (preserve aspect ratio). The game will be stretched to screen borders while respecting game's native aspect ratio (width/height proportions). This ensures that game image will always look correct, but may cause black borders appear at the left&right or top&bottom sides of the screen.
Scaling method
Here player may choose a game scaling algorithm (nearest-neighbor is the simplest one). Some of the methods (notably Hqx) are restricted to which scaling multiplier they may use; if it is not enough to resize the game on its own, the nearest-neighbor method will be applied additionally. The list of available filters depend on graphics driver selection.
Game language
Here player may choose one of the available game translations.
Vertical sync
This option enables vertical synchronization mode, which reduces "tearing" effect on game image, but may decrease the game running speed.
Use 85 Hz display
This option sets the monitor refresh rate to 85 Hz to run the game, which eliminates flicker. However, this does not work on all monitors, and not at all on flat panel displays, which is why it is disabled by default.
Smooth scaled sprites
This option will apply anti-aliasing to scaled characters, in order to give a smoother look to the resizing. This can slow down the game though, so it is off by default.
Render sprites at screen resolution
When enabled, characters and objects are scaled in screen pixels rather than game pixels. What this means is that when low-resolution game is run in larger window, sprites will take advantage of this higher resolution and look less pixelated when scaled down. This option may be locked to certain state by the game itself (according to author's choice), in which case players will not be able to change it.
Digital sound
Here player may choose the digital audio driver, or disable digital sound completely.
MIDI music
Here player may choose the MIDI music playback method, or disable MIDI music completely.
Enable threaded audio
When enabled, engine will process audio on a separate thread. This results in a much smoother playback, but may potentially break game's synchronization with the music (if it had one).
Use voice pack is available
When checked, this option enables voice speech in game (where available).
Auto lock to window
If this option is enabled, the mouse will be locked inside game window whenever player clicks on it or switches into game. The locked mouse cannot leave game window, making it impossible to switch out from the game by mistake (by clicking on desktop, for example). Naturally, this option only has importance if game is run in windowed mode; when in fullscreen the mouse is always locked.
Mouse speed
This slider allows player to set up mouse cursor speed in game. It should be noted that this parameter is only applied if the game is run in fullscreen mode.
Sprite cache max size
This option limits the maximum amount of memory that the game will use for its sprite cache. Sprite cache is used to keep a partition of all the game sprites loaded to the memory, thus reducing loading times between rooms and preventing slowdowns during game play. Of course, higher values make the game use more memory. Usually only high-resolution games with long animations need to have this value increased.
Custom game saves path
When unchecked, the game will store its files - saved games, and custom
runtime data - in the default Windows folders:
C:/Users/<Username>/Saved Games/<Game Title>
and
C:/Program Data/Adventure Game Studio/<Game Title>
respectively.
Players may enable this option and define their own location to store
game files.
See Also: Default setup
Getting Started in AGS
Editor
- New Game templates
- Editor Preferences
- General Settings
- Default Setup
- Colours Editor
- Room Editor
- Character Editor
- Cursor Editor
- Dialog Editor
- Font Preview
- GUI Editor
- Inventory Items Editor
- View Editor
- Sprite Manager
- Music and sound
- Voice speech
- Script Modules
- System limits
- Log Panel
- Plugins
- Other Features
Engine
Scripting
- Scripting Tutorial
- Scripting Language
-
Scripting API
- Script API Overview
- Standard Constants
- Standard Enumerated Types
- Standard Types
- Game variables
- Global arrays
- Global event handlers
- repeatedly_execute / repeatedly_execute_always
- Custom dialog options rendering
- Global functions: general
- Global functions: message display
- Global functions: multimedia actions
- Global functions: palette operations
- Global functions: room actions
- Global functions: screen effects
- Global functions: wait
- AudioChannel functions and properties
- AudioClip functions and properties
- Camera functions and properties
- Character functions and properties
- DateTime functions and properties
- Dialog functions and properties
- DialogOptionsRenderingInfo functions and properties
- Dictionary functions and properties
- DrawingSurface functions and properties
- DynamicSprite functions and properties
- File functions and properties
- Game functions and properties
- GUI functions and properties
- GUI control functions and properties
- GUI Button functions and properties
- GUI InvWindow functions and properties
- GUI Label functions and properties
- GUI List Box functions and properties
- GUI Slider properties
- GUI Text Box functions and properties
- Hotspot functions and properties
- Inventory item functions and properties
- Maths functions and properties
- Mouse functions and properties
- Object functions and properties
- Overlay functions and properties
- Parser functions
- Region functions and properties
- Room functions and properties
- Screen functions and properties
- Set functions and properties
- Speech functions and properties
- String functions
- System functions and properties
- TextWindowGUI functions and properties
- ViewFrame functions and properties
- Viewport functions and properties
- Obsolete Script API
- Event Types
- Key code table
- Audio in script
Legal Notice
Getting in touch
Misc