All Functions Modules Pages
game

Functions

IMAGE game.geticon0 (STRING path)
 Load the ICON0.png stored in an EBOOT.PBP/ISO/CSO to use it after. More...
 
IMAGE game.getpic0 (STRING path)
 Load the PIC0.png stored in an EBOOT.PBP/ISO/CSO to use it after. More...
 
IMAGE game.getpic1 (STRING path)
 Load the PIC1.png stored in an EBOOT.PBP/ISO/CSO to use it after. More...
 
TABLE game.info (STRING path)
 Get the info stored in the PARAM.SFO file of an EBOOT.PBP/ISO/CSO. More...
 
NIL game.unpack (STRING path, STRING dst)
 Unpack an EBOOT.PBP. More...
 
NIL game.unpack (STRING path, STRING dst, NUMBER all)
 Unpack an EBOOT.PBP. More...
 
NUMBER game.pack (STRING resources, STRING dst)
 Packs the resources from an EBOOT.PBP and creates a new EBOOT.PBP. More...
 
NUMBER game.add (STRING path, STRING resources, NUMBER index)
 Adds or Replaces a resource of the EBOOT.PBP. More...
 
NUMBER game.remove (STRING path, NUMBER index)
 Removes a resource of the EBOOT.PBP. More...
 
NIL game.launch (STRING path)
 Launch an EBOOT.PBP/ISO/CSO (can be a homebrew, a PSX game or a PSN game). More...
 

Detailed Description

EBOOT.PBP/ISO/CSO files functions.

Function Documentation

IMAGE game.geticon0 ( STRING  path)

Load the ICON0.png stored in an EBOOT.PBP/ISO/CSO to use it after.

Parameters
pathPath to the EBOOT.PBP/ISO/CSO.
Returns
An IMAGE object (return nil if the EBOOT.PBP/ISO/CSO doesn't have ICON0.png).
IMAGE game.getpic0 ( STRING  path)

Load the PIC0.png stored in an EBOOT.PBP/ISO/CSO to use it after.

Parameters
pathPath to the EBOOT.PBP/ISO/CSO.
Returns
An IMAGE object (return nil if the EBOOT.PBP/ISO/CSO doesn't have PIC0.png).
IMAGE game.getpic1 ( STRING  path)

Load the PIC1.png stored in an EBOOT.PBP/ISO/CSO to use it after.

Parameters
pathPath to the EBOOT.PBP/ISO/CSO.
Returns
An IMAGE object (return nil if the EBOOT.PBP/ISO/CSO doesn't have PIC1.png).
TABLE game.info ( STRING  path)

Get the info stored in the PARAM.SFO file of an EBOOT.PBP/ISO/CSO.

Parameters
pathPath to the EBOOT.PBP/ISO/CSO.
Returns
A table with these fields:
  • APP_VER
  • BOOTABLE
  • CATEGORY
  • DISC_ID
  • DISC_NUMBER
  • DISC_TOTAL
  • DISC_VERSION
  • GAMEDATA_ID
  • HRKGMP_VER
  • PARENTAL_LEVEL
  • PSP_SYSTEM_VER
  • REGION
  • TITLE
  • USE_USB
Warning
The previous list show the most common fields, however, the returned table couldn't have all the listed fields, or even it could have other non-listed fields, so is very important to make sure any field exists before use it.
NIL game.unpack ( STRING  path,
STRING  dst 
)

Unpack an EBOOT.PBP.

Parameters
pathPath to the EBOOT.PBP.
dstPath where the resources will be unpacked.
Returns
Nothing.
Note
  • This function can use the onPbpUnpack() callback, more info here .
  • The resources to unpack could be any of these: PARAM.SFO, ICON0.PNG, ICON1.PNG o ICON1.PMF, PIC0.PNG, PIC1.PNG, SND0.AT3, DATA.PSP, DATA.PSAR.
NIL game.unpack ( STRING  path,
STRING  dst,
NUMBER  all 
)

Unpack an EBOOT.PBP.

Parameters
pathPath to the EBOOT.PBP.
dstPath where the resources will be unpacked.
all(Optional) Pass 1 to extract DATA.PSAR.
Returns
Nothing.
Note
  • This function can use the onPbpUnpack() callback, more info here .
  • The resources to unpack could be any of these: PARAM.SFO, ICON0.PNG, ICON1.PNG o ICON1.PMF, PIC0.PNG, PIC1.PNG, SND0.AT3, DATA.PSP, DATA.PSAR.
NUMBER game.pack ( STRING  resources,
STRING  dst 
)

Packs the resources from an EBOOT.PBP and creates a new EBOOT.PBP.

Parameters
resourcesPath to the Resources.
dstPath where the EBOOT.PBP will be created.
Returns
Number, If the EBOOT.PBP is created correctly it will return 1, else return 0.
Note
  • This function allows us to use the callback onPbpPack(), more information here .
NUMBER game.add ( STRING  path,
STRING  resources,
NUMBER  index 
)

Adds or Replaces a resource of the EBOOT.PBP.

Parameters
pathPath to the EBOOT.PBP.
resourcesPath to the Resource to add or replace.
indexResource constant. This is the list of the avaible constants:
  • __SFO (1)
  • __ICON0 (2)
  • __ICON1 (3)
  • __PIC0 (4)
  • __PIC1 (5)
  • __AT3 (6)
Returns
Number, If the EBOOT.PBP is created correctly it will return 1, if there is an error It will return 0.
Note
  • This function allows us to use the callback onPbpPack(), more information here .
NUMBER game.remove ( STRING  path,
NUMBER  index 
)

Removes a resource of the EBOOT.PBP.

Parameters
pathPath to the EBOOT.PBP.
indexResource constant. This is the list of the avaible constants:
  • __SFO (1)
  • __ICON0 (2)
  • __ICON1 (3)
  • __PIC0 (4)
  • __PIC1 (5)
  • __AT3 (6)
Returns
Number, If the EBOOT.PBP is created correctly it will return 1, else return 0.
Note
  • This function allows us to use the callback onPbpPack(), more information here .
NIL game.launch ( STRING  path)

Launch an EBOOT.PBP/ISO/CSO (can be a homebrew, a PSX game or a PSN game).

Parameters
pathPath to the EBOOT.PBP/ISO/CSO.
Note
  • If you add the "onelua_rdriver.prx" file inside seplugins, when you close the game or homebrew it will return to OneLua.
Returns
Nothing.