PCSX2 Documentation: Difference between revisions

From PCSX2 Wiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
This page is an attempt to clearly document the workings of the PCSX2 code, to make life easier for those who wish to join the project. I beg any PCSX2 developers to please populate this guide as much as possible.
This page is an attempt to clearly document the workings of the PCSX2 code, to make life easier for those who wish to join the project. I beg any PCSX2 developers to please populate this guide as much as possible.
==PCSX2 Developer Guide==
*[[Code Formatting Guidelines]]
*[[Commenting Etiquette]]
*[[Contributing To-Do List]]
*[[Git Survival Guide]]
*[[How to Create Useful and Valid Issues]]
*[[Installing on Linux]]
*[[WxWidgets Coding Strategies]]


==PCSX2 Code Documentation==
==PCSX2 Code Documentation==
The PCSX2 project is divided into several parts, referred to hereafter as "modules":


*[[PCSX2 Build Scripts]]: Automates the building and compilation process of pcsx2. Not a module in the usual sense, but included in this list for the sake of organization. Consists of a shell script in the main parent directory, CMakeLists.txt files in the different modules' folders, and CMake configuration files in the [https://github.com/PCSX2/pcsx2/tree/master/cmake pcsx2/cmake] folder.  
*[[PCSX2 Build Scripts]]: Automates the building and compilation process of pcsx2. Not a module in the usual sense, but included in this list for the sake of organization. Consists of a shell script in the main parent directory, CMakeLists.txt files in the different modules' folders, and CMake configuration files in the [https://github.com/PCSX2/pcsx2/tree/master/cmake pcsx2/cmake] folder.  
Line 10: Line 18:


==PCSX2 Developer's Blog Articles==
==PCSX2 Developer's Blog Articles==
===Entry Point===

Revision as of 19:31, 8 January 2015

This page is an attempt to clearly document the workings of the PCSX2 code, to make life easier for those who wish to join the project. I beg any PCSX2 developers to please populate this guide as much as possible.

PCSX2 Developer Guide

PCSX2 Code Documentation

  • PCSX2 Build Scripts: Automates the building and compilation process of pcsx2. Not a module in the usual sense, but included in this list for the sake of organization. Consists of a shell script in the main parent directory, CMakeLists.txt files in the different modules' folders, and CMake configuration files in the pcsx2/cmake folder.
  • PCSX2 GUI: provides the user interface for PCSX2. It is currently written in the wxwidgets framework. Code for the GUI is in the pcsx2/pcsx2/gui folder.
  • PCSX2 Core: emulates the Emotion Engine. Code for the core is in the pcsx2/pcsx2 folder.
  • GSdx Plugin: emulates the PS2 Graphics Synthesizer. Code for GSdx is in the pcsx2/plugins/GSdx folder.

PCSX2 Developer's Blog Articles