CLEO Library

Report a Bug

Discord GitHub

Latest news and updates:

Tags:

CLEO 5

Welcome to the world of CLEO - your gateway to endless excitement in the Grand Theft Auto universe! Dive into the action-packed realm of Rockstar Games' iconic series and supercharge your gameplay with thousands of incredible mods. Whether you're prowling the streets of GTA III, soaking up the neon glow of Vice City, or navigating the sprawling landscapes of San Andreas, CLEO has something special for every gamer. Join the adventure and transform your GTA experience today!

Learn More

GTA III

Download v2.1.1

Vice City

Download v2.1.1

San Andreas (PC)

Download v5.0 (RC6) NEW

San Andreas (iOS)

Go to Website

CLEO Redux

Go to Website

View All Downloads

What's New in CLEO 5

Enhanced Runtime for Better Scripts

Introducing CLEO Modules for reusing and sharing the code
- CLEO Modules is a brand new feature for having modular code that can be updated independently from the main script. Read through the Modules RFC to find out more information.
Improved SCM Functions with new return commands and completely isolated scope
- A new CLEO_RETURN_WITH command allows you to exit a function and set the condition result at the same time, without resorting to hacks like using IS_AUSTRALIAN_GAME command
- The behavior of the native RETURN command has been changed to support SCM Functions. RETURN allows to exit any SCM function. It never changes the output variables in the corresponding CLEO_CALL should have they been provided
- GOSUB stack in SCM Functions has been isolated from the script scope. Functions can call GOSUB subroutines up to 8 levels deep
- SCM Functions may return strings
- Zero argument count in both CLEO_CALL and CLEO_RETURN is now optional. cleo_call @LABEL args 0 can be written as cleo_call @LABEL. cleo_return 0 can be written as cleo_return
Support for string pointers in all native commands All opcodes that expect a string literal or string variable can now work with integer pointers. For example, consider a code:
print_help 0x8599C0 // prints content of a GXT key GA_21
PRINT_HELP is a native command that previously only worked with direct string input. Now it can read a string from the provided address. Note that the address should point to a null-terminated string in memory.
Script commands can use virtual path prefixes to reference files in common folders, such as game directory, CLEO directory, User files directory, etc.
When passing a filepath to a CLEO command, use the following prefixes to represent a specific directory:
- root:\ for game root directory
- userfiles:\ for game save files directory
- .\ for this script file directory
- cleo:\ for CLEO directory
- modules:\ for CLEO\cleo_modules directory
All standard CLEO plugins support virtual paths. Third-party plugins can be updated to use new SDK's method CLEO_ResolvePath to support virtual paths.
Detailed error messages and improved error handling, minimizing game crashes CLEO validates input arguments and stops the script execution when the game crash is inevitable, e.g. if a null pointer is given. You should see an error message with the information on the failed script and where in the code the error occurred. It also uses information from Sanny Builder Library to provide more context on the error.
If the validation is too strict, try changing the script extension from .cs to .cs4 to disable some of the checks.

Audio Enhancements

New commands for better control over audio streams
Implemented Doppler effect for 3D audio streams, ensuring realism for fast-moving sound sources
CLEO's audio streams now obey game volume and speed settings, offering better synchronization of audio and gameplay By default audio streams use SFX volume. You can make audio stream use Radio volume instead or use its own volume altogether.

New Debug Utilities

Brand new commands for debugging, tracing, and logging to file, enhancing your debugging capabilities
Breakpoints to pause script execution at specific points and resume it at will
Optional support for Rockstar's original debugging opcodes
CLEO5's Debug plugin restores the following commands:
To activate them, set LegacyDebugOpcodes to 1 in SA.DebugUtils.ini .

New and Updated Plugins

New commands in FileSystemOperations plugin
New Memory Operation plugin
New Math plugin (former IntOperations)
New Text plugin
Plugins and their config files moved to cleo_plugins folder to declutter the main CLEO folder
Dozens of new methods and helper functions in the SDK

See All Changes

FAQ

Is CLEO 5 compatible with existing scripts?

Short answer: it depends. For the majority of scripts there should be no issues with the new version. However, CLEO 5 implements some extra safety measures to prevent game crashes, and some scripts may now fail due to the mistakes in the code. CLEO 5 provides a compatibility layer for older scripts. If you experience any issues on the newer version, try changing the script extension from .cs to .cs4

My script crashes with CLEO 5, but works with CLEO 4. What should I do?

If you experience any issues on the newer version, try changing the script extension from .cs to .cs4. If it does not help, open a new ticket on GitHub, or contact us on Discord.

What's the difference between .CS and .CS4 extension?

.CS4 enables a so-called compatibility mode in CLEO5. It affects how CLEO5 executes this script. In CS4 mode, CLEO5 tries to mimic the behavior of CLEO4 where possible, even in cases where it's known to cause issues in game. For the complete list of changes made in CS4 mode, refer to this document.

How do I install CLEO?

Installing CLEO is easy! Depending on your game version it can be distributed as an auto-installer or archive. Simply run the installer and follow the steps, or unpack the archive to the game directory. Done!

How can I develop my own opcodes?

Use CLEO SDK and check the code of plugins shipped with CLEO.