Difference between revisions of "CLEO"

From GTAMods Wiki
Jump to navigation Jump to search
m
Line 1: Line 1:
{{tool-stub}}
+
__notoc__
 
{{ToolBox
 
{{ToolBox
 
| name    = CLEO
 
| name    = CLEO
| version = {{Icon|SA}}&nbsp;{{Hint|4.3.16|Released on 19 March, 2014}}<br>{{Icon|VC}}&nbsp;{{Hint|1.1.1.6|Released on 01 July, 2010}}<br>{{Icon|3}}&nbsp;{{Hint|1.0.1.6|Released on 03 October, 2010}}
+
| version = {{Icon|SA}}&nbsp;{{Hint|4.3.16|Released on 19 March, 2014}}<br>{{Icon|VC}}&nbsp;{{Hint|1.1.1.7|Released on 03 May, 2014}}<br>{{Icon|3}}&nbsp;{{Hint|1.0.1.7|Released on 02 May, 2014}}
 
| author  = {{Ui|Seemann}}, Alien, {{Ui|Deji}}
 
| author  = {{Ui|Seemann}}, Alien, {{Ui|Deji}}
 
| game    = [[GTA 3]], [[GTA VC]], [[GTA SA]]
 
| game    = [[GTA 3]], [[GTA VC]], [[GTA SA]]
 
| genre  = [[mission scripting]]
 
| genre  = [[mission scripting]]
 
| site    = http://cleo.li
 
| site    = http://cleo.li
 +
| image  = [[File:Cleo-logo.png|250px|CLEO 4 logo]]
 
}}
 
}}
  
'''CLEO Library''' or shortly '''CLEO''' is a tool that extends coding possibilities in GTA 3 series games by adding a lot of new opcodes and allowing to run the scripts without modifying the [[main.scm]]. Originally made for [[San Andreas]] it was ported for [[GTA 3]] and [[Vice City]]. CLEO was created and originally developed by {{U|Seemann}}. CLEO 4 was initially developed by Alien, now it's continued by Deji.
+
'''CLEO Library''' or shortly '''CLEO''' is a tool that extends coding possibilities in GTA 3 series games by adding a lot of new opcodes and allowing to run the scripts without modifying the [[main.scm]]. CLEO was created and originally developed by {{U|Seemann}}. CLEO 4 was initially developed by Alien, now it's continued by Deji.
  
 
== Features ==
 
== Features ==
 
=== Extra opcodes ===
 
=== Extra opcodes ===
CLEO adds a lot of [[:Category:CLEO Opcodes|useful opcodes]] making possible file management, [[Memory Addresses (SA)|game memory]] handling, calling [[Function Memory Addresses (SA)|exe functions]], playing audio files and much more. New opcodes were added in the fourth version to work with audio streams, to format strings, to display custom texts on screen without using external text files (.fxt, .gxt).
+
CLEO adds a lot of [[:Category:CLEO Opcodes|useful opcodes]] making possible file management, [[Memory Addresses (SA)|game memory]] handling, calling [[Function Memory Addresses (SA)|exe functions]], playing audio files and much more. New opcodes were added in the fourth version to work with audio streams, to format strings, to display custom texts on screen without using external text files ([[.fxt]], [[.gxt]]).
  
 
=== Plugins ===
 
=== Plugins ===
Line 28: Line 29:
 
The main feature of CLEO is that it allows to run custom scripts (commonly a single file with the extension <code>.cs</code>) without starting a new game. All you need is to get a script, place it in the CLEO folder and run the game (new or saved). This feature is recognized as one of the most important achievement in GTA SA modding.
 
The main feature of CLEO is that it allows to run custom scripts (commonly a single file with the extension <code>.cs</code>) without starting a new game. All you need is to get a script, place it in the CLEO folder and run the game (new or saved). This feature is recognized as one of the most important achievement in GTA SA modding.
  
== Game Versions Compatibility ==
+
== Games support ==
 +
Initially CLEO was designed and made for [[San Andreas]]. Huge success of it and popularity of previous games inspired Alien to port the library for [[GTA 3]] and [[Vice City]] when he developed CLEO 4.
  
CLEO only works with SA v1.0 and v1.01.
+
CLEO can not work with SA v2.00 and higher. One should use [[San_Andreas_v2.0_Modding#Method_1:_Downgrader|a downgrade patch]].
  
CLEO doesn't work with v2.00 and higher. To get it working you need a downgrade patch (.exe of version 1.0 preferably).
+
== Known issues ==
 
+
* Using mp3 related opcodes in CLEO 3 could cause occasional crashes of the game. CLEO 4 is more stable on this matter
It appears that CLEO doesn't work with certain versions of GTA San Andreas. It crashes the game at startup. To solve this problem, [http://sannybuilder.com/forums/viewtopic.php?id=109 visit this topic] and scroll down for the compact exe archive and password.
+
* Some CLEO features don't work in multiplayer mods such as [[SA:MP]] due to their anti-cheating measures
 
+
* Complex scripts developed for CLEO 3 (most notably those ones made by Japanese modder Ryosuke) may not work with CLEO 4. A special compatibility mode was introduced in CLEO 4.3 to solve this problem
== Known bugs ==
 
All versions before CLEO 4 had a bug with MP3s. Using MP3s could cause occasional crashes of the game while using CLEO 3.
 
  
 
== Major projects using CLEO ==
 
== Major projects using CLEO ==
Line 44: Line 44:
  
 
== CLEO Android ==
 
== CLEO Android ==
CLEO Android is an official fork of the CLEO Library made by {{U|Alexander Blade}} for the Android platform.  
+
CLEO Android is an official fork of the CLEO Library made by {{U|Alexander Blade}} for the Android platform.
 +
 
{{Incomplete}}
 
{{Incomplete}}
  

Revision as of 12:20, 2 January 2015

CLEO
CLEO 4 logo
Current version:San Andreas 4.3.16
Vice City 1.1.1.7
GTA III 1.0.1.7 (!)
Developed by:User.pngSeemann, Alien, User.pngDeji
Supported games:GTA 3, GTA VC, GTA SA
Type:mission scripting
Website:http://cleo.li

CLEO Library or shortly CLEO is a tool that extends coding possibilities in GTA 3 series games by adding a lot of new opcodes and allowing to run the scripts without modifying the main.scm. CLEO was created and originally developed by Seemann. CLEO 4 was initially developed by Alien, now it's continued by Deji.

Features

Extra opcodes

CLEO adds a lot of useful opcodes making possible file management, game memory handling, calling exe functions, playing audio files and much more. New opcodes were added in the fourth version to work with audio streams, to format strings, to display custom texts on screen without using external text files (.fxt, .gxt).

Plugins

This section is incomplete. You can help by fixing and expanding it.

Custom scripts

The main feature of CLEO is that it allows to run custom scripts (commonly a single file with the extension .cs) without starting a new game. All you need is to get a script, place it in the CLEO folder and run the game (new or saved). This feature is recognized as one of the most important achievement in GTA SA modding.

Games support

Initially CLEO was designed and made for San Andreas. Huge success of it and popularity of previous games inspired Alien to port the library for GTA 3 and Vice City when he developed CLEO 4.

CLEO can not work with SA v2.00 and higher. One should use a downgrade patch.

Known issues

  • Using mp3 related opcodes in CLEO 3 could cause occasional crashes of the game. CLEO 4 is more stable on this matter
  • Some CLEO features don't work in multiplayer mods such as SA:MP due to their anti-cheating measures
  • Complex scripts developed for CLEO 3 (most notably those ones made by Japanese modder Ryosuke) may not work with CLEO 4. A special compatibility mode was introduced in CLEO 4.3 to solve this problem

Major projects using CLEO

CLEO Android

CLEO Android is an official fork of the CLEO Library made by Alexander Blade for the Android platform.

This section is incomplete. You can help by fixing and expanding it.

External links