OpenAdhoc
OpenAdhoc copied to clipboard
Nenkai
Open-source re-implementation of Gran Turismo Scripts
OpenAdhoc
OpenAdhoc is an open-source re-implementation of Gran Turismo Scripts based on the proprietary Adhoc scripting language to allow logic-based modding as seen on the GT6 Spec II Mod and GT4 Randomizer/Spec II.
This repository contains compilable game scripts re-created from originally compiled scripts. The goal is to allow source-code level editing for GT4, GT5, GT6 (and potentially others). Scripts operate nearly as the whole of game logic, while the executable mostly serves as the engine and exposes libraries to the script interface.
- Unaltered code is located on the
masterbranch - Code for the GT6 Spec II Mod is located on the
gt6-spec-iibranch.
Games & Progress
GT6 Completion Progress
Most of the main projects are completed (gtmode, race, main, etc) and most of the game logic can already be altered.
Table (26 of 49 projects are completed and can be compiled. Version 1.22)
| Name | Completed | Purpose |
|---|---|---|
| main | ✔️ | Initial Bootstrap & Utils before boot |
| arcade | ✔️ | Arcade Mode |
| boot | ✔️ | Boot Process handling (Game Start to main project i.e gtmode or dev_runviewer |
| config | ✔️ | Game Save Nodes Creation |
| community | ✔️ | Community/Online Features Menu (Clubs, TimeLine, Bbs, etc) |
| cursor | ✔️ | Cursor handling & Top Menu |
| datalogger | ❌ | Car Data Logger Menu |
| dev_design_work | ✔️ | UI Showcasing (1.00) |
| dev_runviewer | ✔️ | Developer Tools |
| dev_sound | ✔️ | Sound Engineering Develop Tools |
| dev_test_sequence | ❌ | Unknown Dev Tools |
| develop | ✔️ | Cheat/QA Menu for gtmode |
| dialog | ❌ | UI Components for Dialogs |
| event_setting | ❌ | Settings Menu for Editing Lobby Options |
| garage | ✔️ | Garage Manager |
| gps_replay | ❌ | GPS Replay |
| gtmode | ✔️ | GT Mode. Everything before loading into an event/race. |
| gtauto | ✔️ | GT Auto |
| gttv | ❌ | Stub Leftover from GT5 |
| leavedemo | ✔️ | Idle demonstration project |
| manual | ✔️ | Manual Menu & Credits |
| multimonitor | ✔️ | Multimonitor Handler Project |
| option | ✔️ | Game Settings Menu |
| photo | ✔️ | Photo Mode Handler |
| play_movie | ✔️ | Intro Movie Player Project |
| race | ✔️ | Main Race Project & Base |
| race_arcade_style | ❌ | Sierra Time Rally game mode plugin |
| race_course_edit | ❌ | Custom Track Test & Uploader game mode plugin |
| race_drag | ❌ | Left-over Drag game mode plugin |
| race_drift | ❌ | Drift game mode plugin |
| race_freerun | ✔️ | Free-Run game mode plugin |
| race_license | ✔️ | License game mode plugin |
| race_mission | ✔️ | Mission game mode plugin |
| race_online_drift | ❌ | Seasonal Drift Event game mode plugin |
| race_online_event | ❌ | Online Quickmatch Event game mode plugin |
| race_online_room | ✔️ | Online Lobby game mode plugin |
| race_online_single | ❌ | Seasonal Event game mode plugin |
| race_online_timeattack | ❌ | Seasonal Time Trial game mode plugin |
| race_single | ❌ | Event game mode plugin |
| race_split | ❌ | Split-Screen game mode plugin |
| race_tutorial | ❌ | Tutorial game mode plugin |
| race_timeattack | ✔️ | Time Trial game mode plugin |
| ranking | ❌ | Rankings/Leaderboard Handler Project |
| setting | ❌ | Car Parameters/Tuning Menu |
| ui_kit | ✔️ | Generic UI Components Project |
| ui_kit_sub | ❌ | Unknown |
| vision_gt | ❌ | Vision GT Menu |
GT5 Completion Progress
Table (Version 2.11)
| Name | Completed | Purpose |
|---|---|---|
| main | ✔️ | Initial Bootstrap & Utils before boot |
| arcade | ✔️ | Arcade Mode |
| academy | ❌ | N/A |
| boot | ✔️ | Boot Project (logic is in bootstrap scripts) |
| concept | ❌ | N/A |
| config | ❌ | N/A |
| cursor | ❌ | N/A |
| demo_movie | ❌ | N/A |
| dialog | ❌ | N/A |
| gps_replay | ❌ | N/A |
| gtauto | ❌ | N/A |
| gtmode | ❌ | N/A |
| gttop | ✔️ | Main Menu |
| gttv | ❌ | N/A |
| gttv2 | ❌ | N/A |
| leavedemo | ❌ | N/A |
| manual | ❌ | N/A |
| multimonitor | ❌ | N/A |
| museum | ❌ | N/A |
| news | ❌ | N/A |
| online | ❌ | N/A |
| online_bspec | ❌ | N/A |
| option | ❌ | N/A |
| photo | ❌ | N/A |
| play_movie | ❌ | N/A |
| race | ❌ | N/A |
| race_* | ❌ | N/A |
| ranking | ❌ | N/A |
| rcvtst | ❌ | N/A |
| setting | ❌ | N/A |
| ui_kit | ❌ | N/A |
| user_profile | ❌ | N/A |
| user_profile_driver | ❌ | N/A |
GT4(O) Completion Progress
- boot (Completed)
- cursor (Completed)
- gtmode (Completed)
- option (Completed)
TT/GT Sport
Nothing at the moment.
GT7
Out of scope. GT7 uses swift compiled to adhoc bytecode.
⚙️ Compilation
The Adhoc toolchain is required to compile game scripts. It is also recommended to install the VS Code Extension. Binaries/Artifacts can be acquired from the Actions tab.
⚠️ It is also recommended to add the path to the toolchain (i.e adhoc.exe) to your PATH.
Compilation process
-
adhoc build -i <.ad source file or .yaml project file>
or
- "Run Build Task (CTRL+SHIFT+B)" with the VS Code Adhoc Extension on any source file or project file.
🔧Contributing & Notes
The Adhoc toolchain allows dissasembling scripts into an assembly-like text form. Most scripts contain symbols which are mandatory and thus allows reconstructing code back into source. Sometimes syntax had to be made up for certain specific features, the documentation is the code.
Things that are okay to discard
- Following line numbers - While the custom toolchain does not currently support defines/macros, it is something that was used therefore can leave holes into the code, same goes for missing comments. It is therefore prefered not to follow line numbers for better readability.
- Logic order - It is common that scripts were written using such pattern:
nil != myObjector"Dog" == myString. For readability, literals should always be on the right-hand side such asmyObject != nil.
Things that should be preserved, or recommended to have
- All code of any kind should be present in the scripts.
- Comments are not needed but appreciated.
Glossary
- adc - Adhoc Compiled Script
- Adhoc - Proprietary scripting language for Gran Turismo. Can also refer to bytecode when compiled from pure Adhoc or Swift (GT7). Not to be confused with PSP Ad hoc
- Branch - Build type of the game. For GT6 it normally is
gt6, but it can also berunviewer. - GPB - An image/resource container for all the assets a project or root uses.
- MWidget - UI Layout definition for a root.
- MProject - UI Layout definition for a project, generally many MWidgets combined into one MProject.
- MPackage - A compressed container for splitted
adcandmproject/mwidgetfiles. - Project - A group of menus.
- Root - A single menu.
- Runviewer - Name of the debug menu.
- TinyWeb - Web Server that GT6 and beyond can host which can be used to host pages for external access, or for executing Web Modules.
- Web Module - An adhoc script which returns a web response.
📖 History
- August 2020 - Initial breakthrough in Adhoc, dissasembler built based on reverse-engineering
- September 2020 - Master Mod release for GT5 with hex-edited script code edits
- July 2021 - GT6 Spec II Mod release for GT6
- December 2021 - Breakthrough. GT Sport Closed Beta build dump, contained a few scripts in source and compiled formats which allowed to figure most of the syntax to be similar to Javascript and Python. Stack understanding later came thanks to a random thought by ddm999 and the first custom "hello world" script compilation within the GT6 Web Server successfully ran to completion.
- January 2022 - First fully recompiled project (
boot). - February 2022 <-> December 2022 - Dozens of projects successfully recreated.
- December 2022 - Source release.
Licensing
This project uses the GNU GENERAL PUBLIC LICENSE.
This project is not affiliated with "Polyphony Digital Inc." , "Gran Turismo", "GT", or any other projects by the aforementioned entities.
Nenkai