Protocol for Instrumentation of Emulators
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Gauvain Roussel-Tarbouriech 477e714d4b
formatting, the return
1 year ago
utils more doc 1 year ago
.clang-format formatting, the return 1 year ago
.gitignore documentation and small redesign of the api 1 year ago
Doxyfile make doxygen document all fields 1 year ago
Makefile more template love and beginning to work on batch mode 1 year ago
README.md more doc 1 year ago
client.cpp formatting changes 1 year ago
default.nix more doc 1 year ago
ideas.md better formatting 1 year ago
pcsx2_ipc.h formatting, the return 1 year ago
pcsx2_ipc.patch update patchset 1 year ago
windows-qt.pro fix windows qt pro 1 year ago

README.md

PCSX2 IPC Client Example

You'll find here the reference implementation of PCSX2 IPC Socket client-side C++ API.

Here is a list of files included in this repository:

  • utils/pnach_to_ipc.py: Converts pnach scripts to IPC cpp files automatically.
  • .clang-format: A syntax formatting definition for this project files.
  • .gitignore: A file to avoid commiting unnecessary files.
  • Doxyfile: Doxygen configuration to automatically generate our documentation.
  • Makefile: The file that is used on unix-like system to define how to build the program.
  • README.md: Take a wild guess.
  • client.cpp: An example client file using PCSX2 IPC C++ Reference API.
  • ideas.md: Ideas for future incremental improvements to the protocol.
  • pcsx2_ipc.h: The reference implementation of PCSX2 IPC C++ API.
  • pcsx2_ipc.patch: The patchset containing this feature. Will be removed when merged into master, you can track the status of this PR here.
  • windows_qt.pro: A Qt build definition file. Useful if you want to compile this example on Windows.
  • default.nix: A file to setup the environment necessary to compile, run scripts and generate documentation on NixOS. Just run nix-shell.

A small client example is provided along with the API. It can be compiled on Linux and MacOs by using make and on Windows by loading "windows-qt.pro" with Qt Creator.

On Doxygen you can find the documentation of the API [here](@ref PCSX2Ipc).

Have fun!
-Gauvain "GovanifY" Roussel-Tarbouriech, 2020