Difference between revisions of "CLEO"

From GTAMods Wiki
Jump to navigation Jump to search
m
m (cleo 2.0.0.6 for 3 and vc and 2.1.2 for ios sa)
 
(34 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{tool-stub}}
+
{{This|For a tutorial on how to develop scripts for CLEO, see [[CLEO/Tutorial]].}}
 
{{ToolBox
 
{{ToolBox
 
| name    = CLEO
 
| name    = CLEO
| version = {{Icon|SA}}&nbsp;{{Hint|4.1.1.30f|Released on 28 March, 2010}}<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.4.0|Released on October 24, 2020}}<br>{{Icon|SA}} (iOS)&nbsp;{{Hint|2.1.2|Released on October 2, 2021}}<br>{{Icon|VC}}&nbsp;{{Hint|2.0.0.6|Released on November 5, 2021}}<br>{{Icon|3}}&nbsp;{{Hint|2.0.0.6|Released on November 5, 2021}}
| author  = [[User:Seemann|Seemann]], Alien
+
| author  = {{Ui|Seemann}}, Alien, {{Ui|Deji}}, <br>{{Ui|DK22Pac}}, {{Ui|ThirteenAG}}
 
| game    = [[GTA 3]], [[GTA VC]], [[GTA SA]]
 
| game    = [[GTA 3]], [[GTA VC]], [[GTA SA]]
 
| genre  = [[mission scripting]]
 
| genre  = [[mission scripting]]
| site    = http://cleo.sannybuilder.com
+
| site    = http://cleo.li
 +
| image  = [[File:Cleo-logo.png|250px|CLEO 4 logo]]
 
}}
 
}}
  
'''CLEO Code 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}}, now it's continued by Alien.
+
'''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 had been developed by Alien and 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 20: Line 21:
 
* [[HUME]]
 
* [[HUME]]
 
* MP3 Player
 
* MP3 Player
* Quick Opcode by Alexander Blade
+
* Quick Opcode by {{U|Alexander Blade}}
 +
* [http://www.gtaforums.com/index.php?showtopic=518780 NewOpcodes] by {{U|DK22Pac}}
 +
* [http://www.gtaforums.com/index.php?showtopic=499167 ClipboardControl] by {{U|Deji}}
 +
* [https://github.com/JuniorDjjr/CLEOPlus CLEO+] by {{U|Junior_Djjr}}
 
{{Incomplete}}
 
{{Incomplete}}
  
 
=== Custom scripts ===
 
=== Custom scripts ===
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 running 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 achievements in GTA SA modding.
  
== Game Versions Compatibility ==
+
== Known issues ==
 +
* CLEO can not work with SA v1.01 and higher. One should use [[San_Andreas_v2.0_Modding#Method_1:_Downgrader|a downgrade patch]].
 +
* 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 Ryosuke839) may not work with CLEO 4. A special compatibility mode was introduced in CLEO 4.3 to solve this problem
  
CLEO only works with SA v1.0 and v1.01.
+
== Major projects using CLEO ==
 +
* [[Design Your Own Mission]]
 +
* [[Gostown Paradise]]
  
CLEO doesn't work with v2.00 and higher. To get it working you need a downgrade patch (.exe of version 1.0 preferably).
+
== CLEO for GTA III and Vice City ==
 +
Initially, CLEO was designed and made for San Andreas. The huge success of it and popularity of previous games inspired Alien to port the library for [[GTA 3]] and [[Vice City]], without some features, such as custom saves storing CLEO variables and scripts state.
 +
After Alien's retirement, the development slowed down until {{U|Silent}} issued a version with some fixes. Soon after that DK22Pac announced the next version of CLEO for GTA III and Vice City, written from scratch. It was never released, but  ThirteenAG helped to finish his work and the second version is now available for download.
  
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.
+
== CLEO Android ==
 +
CLEO Android is an official fork of the CLEO Library made by {{U|Alexander Blade}} for the Android platform.
 +
 +
{{Incomplete}}
  
== Known bugs ==
+
== CLEO iOS ==
All versions before CLEO 4 had a bug with MP3s. Using MP3s could cause occasional crashes of the game while using CLEO 3.
+
CLEO iOS is an official version of the CLEO Library written by {{U|Squ1dd13}} for the iOS platform. It was originally known as CSiOS (<b>C</b>LEO <b>S</b>cripts on <b>iOS</b>) until it officially became a part of the CLEO project. It is designed to work with with CLEO Android scripts and resources, although unlike the Android version, it only supports San Andreas.
  
== Major projects using CLEO ==
+
Due to the way the iOS game is built (with symbols stripped), CLEO iOS cannot perform symbol lookups and thus cannot run complex scripts which rely on interacting with C++ functions and variables by name, so scripting capabilities are significantly reduced.
* [[Design Your Own Mission]]
 
* [[Gostown Paradise]]
 
  
 
== External links ==
 
== External links ==
* [http://cleo.sannybuilder.com CLEO Library website]
+
* [http://cleo.li Official website]
 +
* {{Github|cleolibrary|Source code}}
 +
* [http://cleo.li/android CLEO Android]
 +
* {{Github|Squ1dd13/CLEO-iOS|CLEO iOS}}
 
* {{GTAF|268976|Initial CLEO topic}}
 
* {{GTAF|268976|Initial CLEO topic}}
 
* {{GTAF|271646|CLEO 2 topic}}
 
* {{GTAF|271646|CLEO 2 topic}}
 
* {{GTAF|317904|CLEO 3 MODS}} &ndash; topic by {{U|ZAZ}}
 
* {{GTAF|317904|CLEO 3 MODS}} &ndash; topic by {{U|ZAZ}}
 
* {{GTAF|403594|CLEO Script Tutorial}} &ndash; topic by {{U|ZAZ}}
 
* {{GTAF|403594|CLEO Script Tutorial}} &ndash; topic by {{U|ZAZ}}
 +
* {{GTAF|445719|First note about CLEO for GTA III/VC}}
 
* {{Icon|Net}} [http://www.gtagarage.com/mods/browse.php?C=14&State=0&Type=0&Game=5&Order=LastUpdate&Dir=DESC&st=0 CLEO Scripts @ GTAGarage]
 
* {{Icon|Net}} [http://www.gtagarage.com/mods/browse.php?C=14&State=0&Type=0&Game=5&Order=LastUpdate&Dir=DESC&st=0 CLEO Scripts @ GTAGarage]
* [http://gtag.gtagaming.com/forums/index.php?showtopic=238 CLEO 4 - Great New Functions] - a short review of new opcodes by {{U|Deji}}
+
* [http://gtagmodding.com/forums/index.php?showtopic=238 CLEO 4 - Great New Functions] - a short review of new opcodes by {{U|Deji}}
  
{{SA-navi}}
+
{{N|SA|VC|3}}
[[Category:GTA 3]][[Category:GTA VC]][[Category:Mission Scripting]]
+
[[Category:Mission Scripting]]

Latest revision as of 14:27, 12 July 2022

For a tutorial on how to develop scripts for CLEO, see CLEO/Tutorial.
CLEO
CLEO 4 logo
Current version:San Andreas 4.4.0
San Andreas (iOS) 2.1.2
Vice City 2.0.0.6
GTA III 2.0.0.6 (!)
Developed by:User.pngSeemann, Alien, User.pngDeji,
User.pngDK22Pac, User.pngThirteenAG
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 had been developed by Alien and 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 running 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 achievements in GTA SA modding.

Known issues

  • CLEO can not work with SA v1.01 and higher. One should use a downgrade patch.
  • 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 Ryosuke839) 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 for GTA III and Vice City

Initially, CLEO was designed and made for San Andreas. The huge success of it and popularity of previous games inspired Alien to port the library for GTA 3 and Vice City, without some features, such as custom saves storing CLEO variables and scripts state. After Alien's retirement, the development slowed down until Silent issued a version with some fixes. Soon after that DK22Pac announced the next version of CLEO for GTA III and Vice City, written from scratch. It was never released, but ThirteenAG helped to finish his work and the second version is now available for download.

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.

CLEO iOS

CLEO iOS is an official version of the CLEO Library written by Squ1dd13 for the iOS platform. It was originally known as CSiOS (CLEO Scripts on iOS) until it officially became a part of the CLEO project. It is designed to work with with CLEO Android scripts and resources, although unlike the Android version, it only supports San Andreas.

Due to the way the iOS game is built (with symbols stripped), CLEO iOS cannot perform symbol lookups and thus cannot run complex scripts which rely on interacting with C++ functions and variables by name, so scripting capabilities are significantly reduced.

External links