Add advanced techniques documentation on PRX Module by xeonliu · Pull Request #104 · pspdev/pspdev.github.io

xeonliu · 2026-05-04T04:27:29Z

Draft for #103

Maybe examples should be more concrete. Wonder if implementation details should be included here.

…der for contributing and downloads pages

sharkwouter

Cool! Thanks @xeonliu, this is really useful. I'll go through it fully later. What I can say now is that I feel like we can still improve the navigation on the site here. Maybe the "Advanced Techniques" page that links to "Creating PRX Modules" page, like we do with the installation instructions. There it links to platform specific pages that are not shown in the side bar. What do you think?

xeonliu · 2026-05-04T12:51:39Z

Cool! Thanks @xeonliu, this is really useful. I'll go through it fully later. What I can say now is that I feel like we can still improve the navigation on the site here. Maybe the "Advanced Techniques" page that links to "Creating PRX Modules" page, like we do with the installation instructions. There it links to platform specific pages that are not shown in the side bar. What do you think?

It makes sense to me. However I am not sure if Advanced Technique is an appropriate title since I think Debugging is also somewhat an advanced technique 😂

Co-authored-by: Copilot <copilot@github.com>

sharkwouter

Hey @xeonliu thanks for updating the layout and for the work on this PR! I made some comments as someone who doesn't work with modules much and doesn't understand them very well. I hope that helps. I think it is great to have this info and the advance techniques page would enable us to document more things that in the past wouldn't really fit on the website :)

sharkwouter · 2026-05-05T08:13:26Z

+
+To load a PRX module, the main module needs to know which functions it can call within that module. This is done by creating a stub library, a static library containing the signatures of the functions in the PRX module. The main module links against this stub library and calls the functions in the PRX module just like regular functions.
+
+The stub library only contains the Module Name, the NID (Native ID?) of the function and a stub implementation of the function.   


NID stands for name identifier it seems: https://psp-re.github.io/blog/nid-cracking/

"which I believe stands for Name Identifier"

Maybe I should just explain what it is rather than its real name

sharkwouter · 2026-05-05T08:16:35Z

+
+> Guidelines
+> 1. `syslib` is an essential keyword that must be included in the export table. 
+> 2. It is generally not recommended to export global variables. (TODO: Reference needed)


I think you can remove the TODO here. This makes sense to me without additional context, as the user cannot know what modifies the exported global variable or what effect modifying it will have on the program.

I believe this restriction is documented in a document which I read before. I couldn't remember where.

sharkwouter · 2026-05-05T08:18:50Z

+PSP_EXPORT_END
+
+# Export our function
+PSP_EXPORT_START(MyLib, 0, 0x0001)


Maybe it would be good to specify where MyLib comes from.

sharkwouter · 2026-05-05T08:19:34Z

+PSP_BEGIN_EXPORTS
+
+# These four lines are mandatory (although you can add other functions like module_stop)
+# syslib is a psynonym for the single mandatory export.


I think it is less confusing without this second line.

sharkwouter · 2026-05-05T08:20:06Z

+# Define the exports for the prx
+PSP_BEGIN_EXPORTS
+
+# These four lines are mandatory (although you can add other functions like module_stop)


I think it would be good to explicitly explain how to export a function below this code example as well.

sharkwouter · 2026-05-05T08:21:45Z

+### Compile the PRX Module
+{: .fs-4 .fw-700 }
+
+If you are using Makefiles, you can add the following lines to your Makefile to compile the PRX module:


Is it possible to also add instructions for CMake? We have an example here: https://psp-re.github.io/blog/nid-cracking/

Since we mostly use CMake in our examples on the website.

Pretty sure yes. CMake can do that.

I choose Makefile because most existing projects still use them.

I think I will provide 2 versions if possible.

sharkwouter · 2026-05-05T08:24:26Z

+### Generate the Stub Library
+{: .fs-4 .fw-700 }
+
+To generate the stub library, first run the following command in the terminal:


I think it might be good to specify in this section how this relates to the Makefile/CMake and building more.

sharkwouter · 2026-05-05T08:29:00Z

Do we want to cover the coding limitations for prx modules as well? From what I understand using libraries in a module is difficult.

There seems to be many restrictions. I haven't figured out the exact restrictions yet, only some suggestions.

It would be better if others in the channel can help verify them

But as for my observation, most problem comes from using standard C lib or libstdc++

Use only PSPSDK functions and writing the code in C without crt0 can avoid most problems.

Okay, I would still merge this if this is not yet included here now. It can be added later. Maybe having one sentence about the limitation would be good for now. I'll leave it up to you.

sharkwouter · 2026-05-05T11:03:57Z

+
+Instead of writing a standard `main` function, you write a `module_start` function (called when the module is loaded) and a `module_stop` function (called when unloaded). These functions should return 0 on success and a negative value on failure.
+
+> Make sure to use at least on function form other modules (for example, `pspDebugScreenPrintf`), otherwise `psp-fixup-imports` will complain `Error, no .lib.stub section found`.


Suggested change

> Make sure to use at least on function form other modules (for example, `pspDebugScreenPrintf`), otherwise `psp-fixup-imports` will complain `Error, no .lib.stub section found`.

> Make sure to use at least one function form other modules (for example, `pspDebugScreenPrintf`), otherwise `psp-fixup-imports` will complain `Error, no .lib.stub section found`.

Add advanced techniques documentation on PRX Module and adjust nav_or…

5573bd6

…der for contributing and downloads pages

xeonliu marked this pull request as draft May 4, 2026 04:28

xeonliu marked this pull request as ready for review May 4, 2026 04:28

sharkwouter reviewed May 4, 2026

View reviewed changes

xeonliu and others added 3 commits May 5, 2026 12:01

Fix Grammer

74d88db

Co-authored-by: Copilot <copilot@github.com>

Update Navigation

1b44b98

Add Restrictions on C stdlib and C++

a8932ac

sharkwouter requested changes May 5, 2026

View reviewed changes

sharkwouter mentioned this pull request May 5, 2026

Examples on psp-cfw-sdk #105

Open

xeonliu added 3 commits May 5, 2026 17:48

Provide Example on Module Side

46c2330

Fix typo

bda133f

Update Intro on Advanced Topics

889e703

sharkwouter reviewed May 5, 2026

View reviewed changes

xeonliu added 2 commits May 6, 2026 12:48

Fix Typo and update Functions that are recommended to use

e14bd0c

Remove unused link

67b61c2


		To load a PRX module, the main module needs to know which functions it can call within that module. This is done by creating a stub library, a static library containing the signatures of the functions in the PRX module. The main module links against this stub library and calls the functions in the PRX module just like regular functions.

		The stub library only contains the Module Name, the NID (Native ID?) of the function and a stub implementation of the function.


		Instead of writing a standard `main` function, you write a `module_start` function (called when the module is loaded) and a `module_stop` function (called when unloaded). These functions should return 0 on success and a negative value on failure.

		> Make sure to use at least on function form other modules (for example, `pspDebugScreenPrintf`), otherwise `psp-fixup-imports` will complain `Error, no .lib.stub section found`.

	> Make sure to use at least on function form other modules (for example, `pspDebugScreenPrintf`), otherwise `psp-fixup-imports` will complain `Error, no .lib.stub section found`.
	> Make sure to use at least one function form other modules (for example, `pspDebugScreenPrintf`), otherwise `psp-fixup-imports` will complain `Error, no .lib.stub section found`.

Conversation

xeonliu commented May 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sharkwouter left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xeonliu commented May 4, 2026

Uh oh!

sharkwouter left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xeonliu May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xeonliu May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

xeonliu commented May 4, 2026 •

edited

Loading

sharkwouter left a comment •

edited

Loading

xeonliu May 5, 2026 •

edited

Loading

xeonliu May 5, 2026 •

edited

Loading