mirror of https://github.com/encounter/dtk-template.git synced 2025-08-30 23:50:16 +00:00

Add support for generating clangd compile_commands.json config (#38 )

* Implement support for generating clangd `compile_commands.json` config

* Add example .clangd file

* Tidy .gitignore and add entries for clangd and other things

* couple things i forgot to remove

* Change indent level to 2

* Centralize file type checking logic

* Refactor flag replacments to fix `-lang=` flags not being handled

* Move language flag fallback addition to `generate_build_ninja`

* Remove file type flags from .clangd example

* Remove clangd compiler defines option
Projects which need it can define things themselves in .clangd

* Move global clangd flags to tools/project.py & update vscode config

---------

Co-authored-by: Luke Street <luke@street.dev>

2024-10-12 16:50:12 -06:00

4.1 KiB

Raw Blame History

Some Game

A work-in-progress decompilation of Some Game.

This repository does not contain any game assets or assembly whatsoever. An existing copy of the game is required.

Supported versions:

GAMEID: Rev 0 (USA)

Dependencies

Windows

On Windows, it's highly recommended to use native tooling. WSL or msys2 are not required.
When running under WSL, objdiff is unable to get filesystem notifications for automatic rebuilds.

Install Python and add it to %PATH%.
- Also available from the Windows Store.
Download ninja and add it to %PATH%.
- Quick install via pip: pip install ninja

macOS

Install ninja:
```
brew install ninja
```

Install wine-crossover:

brew install --cask --no-quarantine gcenx/wine/wine-crossover

After OS upgrades, if macOS complains about Wine Crossover.app being unverified, you can unquarantine it using:

sudo xattr -rd com.apple.quarantine '/Applications/Wine Crossover.app'

Linux

Install ninja.
For non-x86(_64) platforms: Install wine from your package manager.
- For x86(_64), wibo, a minimal 32-bit Windows binary wrapper, will be automatically downloaded and used.

Building

Clone the repository:

git clone https://github.com/my/repo.git

Using Dolphin Emulator, extract your game to orig/GAMEID.
- To save space, the only necessary files are the following. Any others can be deleted.
  - sys/main.dol
  - files/rels/*.rel
Configure:
```
python configure.py
```
To use a version other than GAMEID (USA), specify it with --version.
Build:
```
ninja
```

Diffing

Once the initial build succeeds, an objdiff.json should exist in the project root.

Download the latest release from encounter/objdiff. Under project settings, set Project directory. The configuration should be loaded automatically.

Select an object from the left sidebar to begin diffing. Changes to the project will rebuild automatically: changes to source files, headers, configure.py, splits.txt or symbols.txt.

4.1 KiB Raw Blame History