-
Notifications
You must be signed in to change notification settings - Fork 9
Plugins
AGS supports user-written plugins in order to provide functionality to your game that AGS itself does not support.
The plugin developer's guide is available from the Resources section of the AGS website.
Windows plugins come as DLL files with the names AGS*.DLL
, for example
agscircle.dll
might be a plugin providing a DrawCircle script function.
How to use a plugin
So, you've downloaded a plugin for AGS. What do you do with it? Well, firstly read any readme file that the plugin author has included. But to get any plugin to work you must do the following:
1. Place a copy of the plugin files in the AGSEditor.exe
directory - not your
game folder.
Ex: C:\Program Files\Adventure Game Studio 3.5.0\
2. Start the AGS Editor up, and load your game. Go to the Plugins node in the main tree. Open it up, and you should see all available plugins listed. To use one in your game, right-click it and choose "Use plugin". The plugin developer should provide instructions on what to do next. Save your game to make sure that AGS remembers that you want to use the plugin.
For other platforms, check Engine Plugins and other platforms below.
NOTE: If you hit a "there was an error loading this plugin" message, there is a chance the problem is with the file Security Zone Identifier, check the Troubleshooting Windows Zone Identifier section. If this doesn't solve your problem, please post in the respective plugin page on the Modules & Plugins board in the forums.
While Windows plugins are named ags*.dll
, other platforms that the AGS Editor supports will use the libags*.so
convention (ex: libagsdrawcircle.so
). Once you have your plugins ported, here are the places to put them.
Below directories are mentioned related to the folder containing AGS Editor (AGSEditor.exe
)
- Windows x86 plugins are placed in the same dir as
AGSEditor.exe
- Linux plugins can be built for x64 (amd64) and x86 architectures, place them in the corresponding
Linux/lib64
andLinux/lib32
directories. - Android plugins should be placed in
Android\plugins
, under a directory for each architecture (ex:Android\plugins\arm64-v8a\libagsdrawcircle.so
) - Web port doesn't support plugins currently
Non Windows platforms may support a known set of plugins as stubs, meaning they won't error for the lack of the plugin alone, but you should detect this if you are not adding the plugin and handle accordingly.
If you want to create your own plugin to extend the functionality of either the AGS Editor or what's possible with the AGS Engine, read on the respective links below.
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