Difference between revisions of "Opcodes Restoration Project"
(mention that SB already has these opcodes) |
|||
(4 intermediate revisions by one other user not shown) | |||
Line 2: | Line 2: | ||
== Files == | == Files == | ||
− | *[ | + | *[http://spaceeinstein.altervista.org/III.Opcodes.cleo III.Opcodes.cleo]: The plugin for GTA III. Place in III\CLEO\CLEO_PLUGINS. |
− | *[ | + | *[http://spaceeinstein.altervista.org/VC.Opcodes.cleo VC.Opcodes.cleo]: The plugin for Vice City. Place in VC\CLEO\CLEO_PLUGINS. |
− | |||
*[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/test_scripts/III.OpcodesTest.cs III.OpcodesTest.cs]: The test script for the plugin for GTA III. Place in III\CLEO. | *[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/test_scripts/III.OpcodesTest.cs III.OpcodesTest.cs]: The test script for the plugin for GTA III. Place in III\CLEO. | ||
*[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/test_scripts/III.OpcodesTest.txt III.OpcodesTest.txt]: The source code for the test script for GTA III. | *[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/test_scripts/III.OpcodesTest.txt III.OpcodesTest.txt]: The source code for the test script for GTA III. | ||
*[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/test_scripts/VC.OpcodesTest.cs VC.OpcodesTest.cs]: The test script for the plugin for Vice City. Place in VC\CLEO. | *[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/test_scripts/VC.OpcodesTest.cs VC.OpcodesTest.cs]: The test script for the plugin for Vice City. Place in VC\CLEO. | ||
*[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/test_scripts/VC.OpcodesTest.txt VC.OpcodesTest.txt]: The source code for the test script for Vice City. | *[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/test_scripts/VC.OpcodesTest.txt VC.OpcodesTest.txt]: The source code for the test script for Vice City. | ||
− | *[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/scm.txt scm.txt]: Let [[Sanny Builder]] recognize the new opcodes. Add onto [[Sanny Builder/SCM.INI|SCM.INI]] in SB\data\gta3 and [[Sanny Builder/VCSCM.INI|VCSCM.INI]] in SB\data\vc. | + | *[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/scm.txt scm.txt]: Let [[Sanny Builder]] recognize the new opcodes. Add onto [[Sanny Builder/SCM.INI|SCM.INI]] in SB\data\gta3 and [[Sanny Builder/VCSCM.INI|VCSCM.INI]] in SB\data\vc{{note|*}}. |
*[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/opcodes.txt opcodes.txt]: For reference. Add onto opcodes.txt in SB\data\gta3 and SB\data\vc. | *[https://raw.githubusercontent.com/cleolibrary/opcodes-restoration-project/master/opcodes.txt opcodes.txt]: For reference. Add onto opcodes.txt in SB\data\gta3 and SB\data\vc. | ||
+ | |||
+ | {{ref|*}} As of v3.7 Sanny Builder ships these opcodes as the [https://docs.sannybuilder.com/edit-modes/extension Restoration extension] in the Vice City mode. | ||
== Building == | == Building == | ||
Line 16: | Line 17: | ||
<pre>git clone --recursive https://github.com/cleolibrary/opcodes-restoration-project</pre> | <pre>git clone --recursive https://github.com/cleolibrary/opcodes-restoration-project</pre> | ||
− | Run <code>premake5.bat</code> to generate project files for Microsoft Visual Studio 2015. If you use a different version of Visual Studio, open the file with a text editor and change vs2015 to your preferred version. A folder named <code>build</code> is created with the generated project files. Open <code>build\opcodes-restoration-project.sln</code> | + | Run <code>premake5.bat</code> to generate project files for Microsoft Visual Studio 2015. If you use a different version of Visual Studio, open the file with a text editor and change vs2015 to your preferred version. A folder named <code>build</code> is created with the generated project files. Open <code>build\opcodes-restoration-project.sln</code>, change the active solution configuration to <code>Release</code>, then build <code>III.Opcodes</code> or <code>VC.Opcodes</code>. The plugin will be located in <code>bin\CLEO\CLEO_PLUGINS</code>. |
== Restored opcodes == | == Restored opcodes == | ||
Line 25: | Line 26: | ||
|- | |- | ||
|[[0116]] ||IS_<wbr>PLAYER_<wbr>STILL_<wbr>ALIVE || | |[[0116]] ||IS_<wbr>PLAYER_<wbr>STILL_<wbr>ALIVE || | ||
+ | |- | ||
+ | |01E6 ||PRINT_<wbr>WITH_<wbr>NUMBER_<wbr>SOON || | ||
|- | |- | ||
|[[02BD]] ||SET_<wbr>FBI_<wbr>REQUIRED || | |[[02BD]] ||SET_<wbr>FBI_<wbr>REQUIRED || | ||
|- | |- | ||
|[[02BE]] ||SET_<wbr>ARMY_<wbr>REQUIRED || | |[[02BE]] ||SET_<wbr>ARMY_<wbr>REQUIRED || | ||
+ | |- | ||
+ | |0301 ||PRINT_<wbr>WITH_<wbr>3_<wbr>NUMBERS_<wbr>SOON || | ||
+ | |- | ||
+ | |0304 ||PRINT_<wbr>WITH_<wbr>4_<wbr>NUMBERS_<wbr>SOON || | ||
+ | |- | ||
+ | |0307 ||PRINT_<wbr>WITH_<wbr>5_<wbr>NUMBERS_<wbr>SOON || | ||
+ | |- | ||
+ | |030A ||PRINT_<wbr>WITH_<wbr>6_<wbr>NUMBERS_<wbr>SOON || | ||
+ | |- | ||
+ | |0385 ||PRINT_<wbr>STRING_<wbr>IN_<wbr>STRING_<wbr>SOON || | ||
+ | |- | ||
+ | |048F ||REMOVE_<wbr>ALL_<wbr>CHAR_<wbr>WEAPONS || | ||
|- | |- | ||
|[[050F]] ||GET_<wbr>MAX_<wbr>WANTED_<wbr>LEVEL || | |[[050F]] ||GET_<wbr>MAX_<wbr>WANTED_<wbr>LEVEL || | ||
Line 40: | Line 55: | ||
=== Vice City === | === Vice City === | ||
− | This is a list of over | + | This is a list of over 170 opcodes that have been restored in Vice City. The "non-plugin alternative" column offers an equivalent or closely similar behavior of the opcode independent of the plugin. |
{|class="wikitable center-col-3 mw-collapsible mw-collapsed sortable" | {|class="wikitable center-col-3 mw-collapsible mw-collapsed sortable" | ||
!Opcode ||Command name ||Non-plugin<br>alternative ||Notes | !Opcode ||Command name ||Non-plugin<br>alternative ||Notes | ||
Line 47: | Line 62: | ||
|- | |- | ||
|[[00AC]] ||IS_<wbr>CAR_<wbr>STILL_<wbr>ALIVE ||✓ ||Exactly the same as [[0119|8119]] | |[[00AC]] ||IS_<wbr>CAR_<wbr>STILL_<wbr>ALIVE ||✓ ||Exactly the same as [[0119|8119]] | ||
+ | |- | ||
+ | |00BD ||PRINT_<wbr>SOON || || | ||
|- | |- | ||
|[[00C5]] ||RETURN_<wbr>TRUE ||✓ ||Same as [[0485]] for most versions | |[[00C5]] ||RETURN_<wbr>TRUE ||✓ ||Same as [[0485]] for most versions | ||
Line 85: | Line 102: | ||
|- | |- | ||
|[[01C6]] ||DONT_<wbr>REMOVE_<wbr>CAR ||✓ ||CLEO [[01C6#For Vice City|code snippet]] alternative | |[[01C6]] ||DONT_<wbr>REMOVE_<wbr>CAR ||✓ ||CLEO [[01C6#For Vice City|code snippet]] alternative | ||
+ | |- | ||
+ | |01E6 ||PRINT_<wbr>WITH_<wbr>NUMBER_<wbr>SOON || || | ||
|- | |- | ||
|[[01EE]] ||ACTIVATE_<wbr>CRANE || || | |[[01EE]] ||ACTIVATE_<wbr>CRANE || || | ||
Line 187: | Line 206: | ||
|- | |- | ||
|02FC ||PRINT_<wbr>WITH_<wbr>2_<wbr>NUMBERS || || | |02FC ||PRINT_<wbr>WITH_<wbr>2_<wbr>NUMBERS || || | ||
+ | |- | ||
+ | |02FE ||PRINT_<wbr>WITH_<wbr>2_<wbr>NUMBERS_<wbr>SOON || || | ||
|- | |- | ||
|0300 ||PRINT_<wbr>WITH_<wbr>3_<wbr>NUMBERS_<wbr>NOW || || | |0300 ||PRINT_<wbr>WITH_<wbr>3_<wbr>NUMBERS_<wbr>NOW || || | ||
+ | |- | ||
+ | |0301 ||PRINT_<wbr>WITH_<wbr>3_<wbr>NUMBERS_<wbr>SOON || || | ||
|- | |- | ||
|0303 ||PRINT_<wbr>WITH_<wbr>4_<wbr>NUMBERS_<wbr>NOW || || | |0303 ||PRINT_<wbr>WITH_<wbr>4_<wbr>NUMBERS_<wbr>NOW || || | ||
+ | |- | ||
+ | |0304 ||PRINT_<wbr>WITH_<wbr>4_<wbr>NUMBERS_<wbr>SOON || || | ||
|- | |- | ||
|0305 ||PRINT_<wbr>WITH_<wbr>5_<wbr>NUMBERS || || | |0305 ||PRINT_<wbr>WITH_<wbr>5_<wbr>NUMBERS || || | ||
|- | |- | ||
|0306 ||PRINT_<wbr>WITH_<wbr>5_<wbr>NUMBERS_<wbr>NOW || || | |0306 ||PRINT_<wbr>WITH_<wbr>5_<wbr>NUMBERS_<wbr>NOW || || | ||
+ | |- | ||
+ | |0307 ||PRINT_<wbr>WITH_<wbr>5_<wbr>NUMBERS_<wbr>SOON || || | ||
|- | |- | ||
|0309 ||PRINT_<wbr>WITH_<wbr>6_<wbr>NUMBERS_<wbr>NOW || || | |0309 ||PRINT_<wbr>WITH_<wbr>6_<wbr>NUMBERS_<wbr>NOW || || | ||
+ | |- | ||
+ | |030A ||PRINT_<wbr>WITH_<wbr>6_<wbr>NUMBERS_<wbr>SOON || || | ||
|- | |- | ||
|[[031B]] ||IS_<wbr>FIRST_<wbr>CAR_<wbr>COLOUR ||✓ ||CLEO [[031B#For Vice City|code snippet]] alternative | |[[031B]] ||IS_<wbr>FIRST_<wbr>CAR_<wbr>COLOUR ||✓ ||CLEO [[031B#For Vice City|code snippet]] alternative | ||
Line 229: | Line 258: | ||
|- | |- | ||
|[[0371]] ||PRINT_<wbr>WITH_<wbr>6_<wbr>NUMBERS_<wbr>BIG || || | |[[0371]] ||PRINT_<wbr>WITH_<wbr>6_<wbr>NUMBERS_<wbr>BIG || || | ||
+ | |- | ||
+ | |0375 ||PRINT_<wbr>STRING_<wbr>IN_<wbr>STRING || || | ||
|- | |- | ||
|[[0378]] ||SET_<wbr>2_<wbr>REPEATED_<wbr>PHONE_<wbr>MESSAGES || || | |[[0378]] ||SET_<wbr>2_<wbr>REPEATED_<wbr>PHONE_<wbr>MESSAGES || || | ||
Line 243: | Line 274: | ||
|- | |- | ||
|[[037F]] ||GIVE_<wbr>PLAYER_<wbr>DETONATOR || || | |[[037F]] ||GIVE_<wbr>PLAYER_<wbr>DETONATOR || || | ||
+ | |- | ||
+ | |0385 ||PRINT_<wbr>STRING_<wbr>IN_<wbr>STRING_<wbr>SOON || || | ||
|- | |- | ||
|0386 ||SET_<wbr>5_<wbr>REPEATED_<wbr>PHONE_<wbr>MESSAGES || || | |0386 ||SET_<wbr>5_<wbr>REPEATED_<wbr>PHONE_<wbr>MESSAGES || || | ||
Line 335: | Line 368: | ||
|- | |- | ||
|04D4 ||GET_<wbr>NTH_<wbr>CLOSEST_<wbr>CHAR_<wbr>NODE || || | |04D4 ||GET_<wbr>NTH_<wbr>CLOSEST_<wbr>CHAR_<wbr>NODE || || | ||
+ | |- | ||
+ | |04DC ||HAS_<wbr>PHOTOGRAPH_<wbr>BEEN_<wbr>TAKEN || || | ||
|- | |- | ||
|0505 ||GET_<wbr>NEAREST_<wbr>TYRE_<wbr>TO_<wbr>POINT || || | |0505 ||GET_<wbr>NEAREST_<wbr>TYRE_<wbr>TO_<wbr>POINT || || | ||
Line 361: | Line 396: | ||
|- | |- | ||
|0547 ||IS_<wbr>CHAR_<wbr>TOUCHING_<wbr>VEHICLE || || | |0547 ||IS_<wbr>CHAR_<wbr>TOUCHING_<wbr>VEHICLE || || | ||
+ | |- | ||
+ | |0555 ||REMOVE_<wbr>WEAPON_<wbr>FROM_<wbr>CHAR || || | ||
+ | |- | ||
+ | |056E ||DOES_<wbr>VEHICLE_<wbr>EXIST || || | ||
|- | |- | ||
|[[056F]] ||ADD_<wbr>SHORT_<wbr>RANGE_<wbr>BLIP_<wbr>FOR_<wbr>CONTACT_<wbr>POINT || || | |[[056F]] ||ADD_<wbr>SHORT_<wbr>RANGE_<wbr>BLIP_<wbr>FOR_<wbr>CONTACT_<wbr>POINT || || |
Latest revision as of 13:55, 15 August 2021
The Opcodes Restoration Project is a plugin for CLEO v2.0.0.5 and above for GTA III and Vice City that aims to restore functionality to many unsupported opcodes. Only US v1.0 has been thoroughly tested for both games. US v1.1 and Steam versions of Vice City are supported but they have not been tested.
Files
- III.Opcodes.cleo: The plugin for GTA III. Place in III\CLEO\CLEO_PLUGINS.
- VC.Opcodes.cleo: The plugin for Vice City. Place in VC\CLEO\CLEO_PLUGINS.
- III.OpcodesTest.cs: The test script for the plugin for GTA III. Place in III\CLEO.
- III.OpcodesTest.txt: The source code for the test script for GTA III.
- VC.OpcodesTest.cs: The test script for the plugin for Vice City. Place in VC\CLEO.
- VC.OpcodesTest.txt: The source code for the test script for Vice City.
- scm.txt: Let Sanny Builder recognize the new opcodes. Add onto SCM.INI in SB\data\gta3 and VCSCM.INI in SB\data\vc^.
- opcodes.txt: For reference. Add onto opcodes.txt in SB\data\gta3 and SB\data\vc.
[*] As of v3.7 Sanny Builder ships these opcodes as the Restoration extension in the Vice City mode.
Building
You can rebuild the plugin for yourself if you want to. Use git (e.g. through Git Shell) to clone the repository and the submodules.
git clone --recursive https://github.com/cleolibrary/opcodes-restoration-project
Run premake5.bat
to generate project files for Microsoft Visual Studio 2015. If you use a different version of Visual Studio, open the file with a text editor and change vs2015 to your preferred version. A folder named build
is created with the generated project files. Open build\opcodes-restoration-project.sln
, change the active solution configuration to Release
, then build III.Opcodes
or VC.Opcodes
. The plugin will be located in bin\CLEO\CLEO_PLUGINS
.
Restored opcodes
GTA III
This is a list of opcodes that have been restored and extended in GTA III.
Opcode | Command name | Notes |
---|---|---|
0116 | IS_ |
|
01E6 | PRINT_ |
|
02BD | SET_ |
|
02BE | SET_ |
|
0301 | PRINT_ |
|
0304 | PRINT_ |
|
0307 | PRINT_ |
|
030A | PRINT_ |
|
0385 | PRINT_ |
|
048F | REMOVE_ |
|
050F | GET_ |
|
0511 | PRINT_ |
|
0546 | IS_ |
|
0547 | IS_ |
Vice City
This is a list of over 170 opcodes that have been restored in Vice City. The "non-plugin alternative" column offers an equivalent or closely similar behavior of the opcode independent of the plugin.
Opcode | Command name | Non-plugin alternative |
Notes |
---|---|---|---|
00A2 | IS_ |
✓ | Exactly the same as 8118 |
00AC | IS_ |
✓ | Exactly the same as 8119 |
00BD | PRINT_ |
||
00C5 | RETURN_ |
✓ | Same as 0485 for most versions |
00C6 | RETURN_ |
✓ | Same as 059A for most versions |
00E2 | GET_ |
✓ | CLEO code snippet alternative |
0113 | ADD_ |
✓ | Similar to 0114 with player character |
0116 | IS_ |
||
0130 | HAS_ |
✓ | CLEO code snippet alternative |
0135 | CHANGE_ |
✓ | Exactly the same as 020A |
0136 | SHAKE_ |
✓ | CLEO code snippet alternative |
013B | IS_ |
||
013C | IS_ |
||
0155 | SET_ |
||
0156 | SET_ |
||
015E | IS_ |
✓ | CLEO code snippet alternative |
0163 | ADD_ |
||
016F | DRAW_ |
||
0178 | IS_ |
||
0179 | IS_ |
||
017B | SET_ |
✓ | CLEO code snippet alternative |
01C6 | DONT_ |
✓ | CLEO code snippet alternative |
01E6 | PRINT_ |
||
01EE | ACTIVATE_ |
||
01EF | DEACTIVATE_ |
||
0218 | PRINT_ |
||
021D | SET_ |
✓ | CLEO code snippet alternative |
021F | SET_ |
✓ | CLEO code snippet alternative |
0220 | IS_ |
✓ | CLEO code snippet alternative |
0228 | IS_ |
✓ | CLEO code snippet alternative |
023A | IS_ |
||
023B | IS_ |
||
023E | FLASH_ |
||
023F | FLASH_ |
||
0240 | FLASH_ |
||
0242 | ARM_ |
✓ | CLEO code snippet alternative |
024B | SET_ |
||
024C | SET_ |
||
024D | HAS_ |
||
0250 | DRAW_ |
||
0251 | STORE_ |
||
0252 | RESTORE_ |
||
0255 | RESTART_ |
||
0295 | IS_ |
||
0299 | ACTIVATE_ |
✓ | CLEO code snippet alternative |
029A | SWITCH_ |
||
029C | IS_ |
||
02A0 | IS_ |
||
02A1 | MESSAGE_ |
||
02A2 | ADD_ |
||
02A4 | ADD_ |
||
02A5 | ADD_ |
||
02A6 | ADD_ |
||
02B9 | DEACTIVATE_ |
✓ | CLEO code snippet alternative |
02BC | SET_ |
||
02BD | SET_ |
||
02BE | SET_ |
||
02C3 | START_ |
Model and coordinates can be modified through a file named pacman.dat
| |
02C5 | GET_ |
||
02C6 | CLEAR_ |
||
02C7 | START_ |
Model can be modified through a file named pacman.dat
| |
02C8 | GET_ |
||
02C9 | CLEAR_ |
||
02CD | GOSUB_ |
||
02D2 | SET_ |
||
02D6 | IS_ |
||
02D9 | CLEAR_ |
||
02DA | ADD_ |
||
02EE | IS_ |
||
02EF | DESTROY_ |
||
02F0 | DROP_ |
✓ | Similar to 0213 with model barrel1 type 9
|
02F1 | DROP_ |
✓ | Similar to 0213 with model barrel2 type 11
|
02FB | ACTIVATE_ |
||
02FC | PRINT_ |
||
02FE | PRINT_ |
||
0300 | PRINT_ |
||
0301 | PRINT_ |
||
0303 | PRINT_ |
||
0304 | PRINT_ |
||
0305 | PRINT_ |
||
0306 | PRINT_ |
||
0307 | PRINT_ |
||
0309 | PRINT_ |
||
030A | PRINT_ |
||
031B | IS_ |
✓ | CLEO code snippet alternative |
031C | IS_ |
✓ | CLEO code snippet alternative |
032D | SET_ |
Has the same bug as GTA III | |
0338 | SET_ |
||
0344 | SET_ |
||
0346 | SET_ |
||
0349 | SET_ |
||
0351 | IS_ |
||
0356 | IS_ |
||
0357 | IS_ |
||
0367 | START_ |
✓ | CLEO code snippet alternative |
0368 | ACTIVATE_ |
||
036E | PRINT_ |
||
036F | PRINT_ |
||
0370 | PRINT_ |
||
0371 | PRINT_ |
||
0375 | PRINT_ |
||
0378 | SET_ |
||
0379 | SET_ |
||
037A | SET_ |
||
037B | SET_ |
||
037C | SET_ |
||
037D | SET_ |
||
037F | GIVE_ |
||
0385 | PRINT_ |
||
0386 | SET_ |
||
0387 | SET_ |
||
0388 | SET_ |
||
0389 | SET_ |
||
0393 | SET_ |
✓ | CLEO code snippet alternative |
03A0 | IS_ |
||
03A5 | CHANGE_ |
Opcode is implemented but garage type 7 is buggy in Vice City | |
03C2 | IS_ |
||
03C6 | IS_ |
Checks the current level number instead, essentially the same behavior | |
03C9 | IS_ |
✓ | CLEO code snippet alternative |
03DB | ADD_ |
||
03DD | ADD_ |
||
03E9 | IS_ |
||
03EC | HAS_ |
||
03FB | SET_ |
||
03FC | SET_ |
||
0410 | SET_ |
||
0413 | SET_ |
✓ | CLEO code snippet alternative |
0415 | IS_ |
✓ | CLEO code snippet alternative |
041A | GET_ |
||
041B | REGISTER_ |
||
041C | SET_ |
||
041F | OVERRIDE_ |
||
0420 | OVERRIDE_ |
||
0421 | FORCE_ |
||
0422 | DOES_ |
Has the same bug as GTA III | |
042A | IS_ |
||
0432 | GET_ |
||
0438 | SET_ |
||
0444 | SET_ |
||
0447 | IS_ |
||
044E | SET_ |
||
044F | MAKE_ |
||
0452 | ENABLE_ |
||
047B | LOCATE_ |
Has the same bug as GTA III | |
047C | LOCATE_ |
Has the same bug as GTA III | |
047D | GET_ |
||
0491 | HAS_ |
✓ | CLEO code snippet alternative |
04A0 | GET_ |
✓ | CLEO code snippet alternative |
04A7 | IS_ |
||
04A9 | IS_ |
||
04AB | IS_ |
||
04C8 | IS_ |
||
04CC | ADD_ |
||
04CD | ADD_ |
||
04D4 | GET_ |
||
04DC | HAS_ |
||
0505 | GET_ |
||
050F | GET_ |
✓ | CLEO code snippet alternative |
0511 | PRINT_ |
||
0513 | PRINT_ |
||
051F | DISPLAY_ |
||
052A | ADD_ |
||
052D | GET_ |
||
0530 | ADD_ |
||
0532 | ADD_ |
Displays as a value "out of 0" in the stats menu | |
0535 | ADD_ |
||
0537 | SET_ |
||
0538 | ADD_ |
||
0547 | IS_ |
||
0555 | REMOVE_ |
||
056E | DOES_ |
||
056F | ADD_ |
||
0577 | SET_ |
||
059D | SHUFFLE_ |
||
059E | FETCH_ |