ApfelTeeSaft/Itemzflow
1
0
Fork 0
mirror of https://github.com/ApfelTeeSaft/Itemzflow.git synced 2026-08-26 19:23:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revert README.md

Browse Source
This commit is contained in:
LightningMods
2024-01-26 14:45:59 -05:00
committed by GitHub
parent 36ca31d21b
commit d291781bea
1 changed files with 88 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+88 -79
View File
@@ -5,6 +5,9 @@
## Third-Party Libraries
- [fuse-nfs](https://github.com/sahlberg/fuse-nfs)
- [libNFS](https://github.com/orbisdev/orbisdev-liborbisNfs)
- [libfuse](https://github.com/libfuse/libfuse)
- [FTPS4](https://github.com/xerpi/FTPS4)
- [dr_mp3](https://github.com/mackron/dr_libs/blob/master/dr_mp3.h)
- [liborbisAudio](https://github.com/orbisdev/orbisdev-liborbisAudio)
@@ -20,7 +23,7 @@
- [log.c](https://github.com/rxi/log.c)
- [Game Dumper](https://github.com/Al-Azif/dumper-testing)
- [libjbc](https://github.com/sleirsgoevy/ps4-libjbc)
- [yaml-cpp](https://github.com/jbeder/yaml-cpp)
- [pugixml](https://github.com/zeux/pugixml)
- [taglib](https://github.com/taglib/taglib)
- Libz
@@ -33,29 +36,28 @@ the ini file is either loaded by the app dir or from USB0 when the app is booted
#### Settings Layout
| INI Key | Description |
|---------------------|-------------------------------------------------------------|
| `Dumper_option` | 0 = ALL 1 = BASE Game only 2 = Patch only |
| `Sort_By` | -1 is NA 0 = Alpha order by TID 1 = Alpha order by App Name |
| `Sort_Cat` | Sort category |
| `cover_message` | Shows cover message on app startup |
| `MP3_Path` | FS Path to a folder of MP3s or a single MP3 to play on loop |
| `Dumper_Path` | Dump path |
| `TTF_Font` | TTF Font the store will try to use (embedded font on fail) |
| `Show_Buttons` | Shows IF buttons on the screen |
| `Enable_Theme` | ONLY Active if you have a theme enabled |
| `Image_path` | background PNG image |
| `Reflections` | Enables cover reflections in IF |
| `Home_Redirection` | Enables the Home Menu Redirect |
| `Daemon_on_start` | Disables the Daemon from auto connecting with the app |
| `Image_path` | Background Image |
| `Show_install_prog` | Enables the Store PKG/APP install Progress |
| `Fuse_IP` | PC NFS Share in format `nfs://IP/share_name` |
| INI Key | Description |
| ------------- | ------------- |
| Dumper_option | 0 = ALL 1 = BASE Game only 2 = Patch only |
| Sort_By | -1 is NA 0 = Alpha order by TID 1 = Alpha order by App Name |
| Sort_Cat | Sort category |
| cover_message | Shows cover message on app startup |
| MP3_Path | FS Path to a folder of MP3s or a single MP3 to play on loop |
| Dumper_Path | Dump path |
| TTF_Font | TTF Font the store will try to use (embedded font on fail) |
| Show_Buttons | Shows IF buttons on the screen |
| Enable_Theme | ONLY Active if you have a theme enabled |
| Image_path | background PNG image |
| Reflections | Enables cover reflections in IF |
| Home_Redirection | Enables the Home Menu Redirect |
| Daemon_on_start | Disables the Daemon from auto connecting with the app |
| Image_path | Background Image |
| Show_install_prog | Enables the Store PKG/APP install Progress |
#### setting.ini example
#### setting.ini example
```
```ini
[Settings]
Dumper_option=0
Sort_By=-1
@@ -71,25 +73,32 @@ Reflections=1
Home_Redirection=1
Daemon_on_start=0
Show_install_prog=1
Fuse_IP=nfs://192.1.2.3/nfs_share
```
## NFS Share format
the NFS formatted string can be entered in the app using the in-app keyboard or set in the settings.ini file
```
nfs://PC_IP/share_name
```
or if your share name is /
```
PC_IP
```
## Itemzflow Log
- If the app crashes or mentions "a FATAL Signal" send this log to us via the discord below or via GH Issues
`/user/app/ITEM00001/logs/itemzflow_app.log`
## Daemon
The itemz daemon is installed when you open the app for the first time at `/system/vsh/app/ITEM00002`
it gets Updated ONLY by the Itemzflwo
it gets updated ONLY by Itemzflow
The daemon settings file is ONLY for internal use by the Store devs
however it also has a ini at `/system/vsh/app/ITEM00002/daemon.ini` with the following ini values
```
[Daemon]
version=0x1001// Daemon version for Store, Official version is always > 0x1000
```
The daemon folder is ONLY for internal use by the Itemzflow devs
it is hash checked by the loader to ensure the daemon is always up to date with the PKG
## Dumper details
@@ -106,46 +115,45 @@ version=0x1001// Daemon version for Store, Official version is always > 0x1000
## Themes
- You can download custom themes released in the [Itemzflow Themes Repo](https://github.com/LightningMods/xxxxxxxx)
- You can download custom themes released in the [Itemzflow Themes Repo](https://github.com/LightningMods/itemzflow-themes)
- You can also make your own custom themes by following these instructions.
#### IMPORTENT the Theme files HAVE to have the exact filename as listed below
#### IMPORTANT the Theme files must HAVE the exact filename as listed below
| Filename | Description |
| ------------- | ------------- |
| btn_o.png | O Button (67x68) |
| btn_x.png | X Button (67x68) |
| btn_tri.png | Triangle Button (67x68) |
| btn_sq.png | square Button (67x68) |
| btn_r1.png | R1 Button (309x152) |
| btn_l1.png | L1 Button (120x59) |
| btn_l2.png | L2 Button (120x105) |
| btn_options.png | Options Button (145x84) |
| btn_up.png | D-Pad Up Button (32x32) |
| btn_down.png | D-Pad Down Button (32x32) |
| btn_left.png | D-Pad Left Button (32x32) |
| btn_right.png | D-Pad Right Button (32x32) |
| font.ttf | Theme Font |
| background.png | Background Image |
| shader.bin | PS4 GLES Compiled Shader |
| theme.ini | Theme Info |
| Filename | Description |
|-------------------|----------------------------|
| `btn_o.png` | O Button (67x68) |
| `btn_x.png` | X Button (67x68) |
| `btn_tri.png` | Triangle Button (67x68) |
| `btn_sq.png` | square Button (67x68) |
| `btn_r1.png` | R1 Button (309x152) |
| `btn_l1.png` | L1 Button (120x59) |
| `btn_l2.png` | L2 Button (120x105) |
| `btn_options.png` | Options Button (145x84) |
| `btn_up.png` | D-Pad Up Button (32x32) |
| `btn_down.png` | D-Pad Down Button (32x32) |
| `btn_left.png` | D-Pad Left Button (32x32) |
| `btn_right.png` | D-Pad Right Button (32x32) |
| `font.ttf` | Theme Font |
| `background.png` | Background Image |
| `shader.bin` | PS4 GLES Compiled Shader |
| `theme.ini` | Theme Info |
#### Theme INI Config
| INI Key | Description |
|---------|--------------------------------------------------|
| Name | Theme Name |
| Author | Who Made it |
| Date | Date it was made on |
| Version | Theme Version Number |
| Image | 1 if your Theme has a background image, 0 if not |
| Font | 1 = Theme has font.ttf 0 = It doesnt |
| Shader | 1 = Has Shader bin 0 = It doesnt |
| INI Key | Description |
| ------------- | ------------- |
| Name | Theme Name |
| Author | Who Made it |
| Date | Date it was made on |
| Version | Theme Version Number |
| Image | 1 if your Theme has a background image, 0 if not |
| Font | 1 = Theme has font.ttf 0 = It doesnt |
| Shader | 1 = Has Shader bin 0 = It doesnt |
#### Example Theme config
#### Example Theme config
```
```ini
[THEME]
Name=Example Theme
Author=Example Author
@@ -159,24 +167,22 @@ Shader=0
## App logs and their paths
| Service | PS4 Path |
| ------------- | ------------- |
| Itemzflow main app | /user/app/ITEM00001/logs/itemzflow_app.log |
| Dumper | /user/app/ITEM00001/logs/if_dumper.log |
| Itemz Loader | /user/app/ITEM00001/logs/loader.log |
| Itemz Daemon | /data/itemzflow_daemon/daemon.log |
| libfuse | /data/itemzflow_daemon/libfuse.log |
| Service | PS4 Path |
|--------------------|----------------------------------------------|
| Itemzflow main app | `/user/app/ITEM00001/logs/itemzflow_app.log` |
| Dumper | `/user/app/ITEM00001/logs/if_dumper.log` |
| Itemz Loader | `/user/app/ITEM00001/logs/loader.log` |
| Itemz Daemon | `/data/itemzflow_daemon/daemon.log` |
| libfuse | `/data/itemzflow_daemon/libfuse.log` |
#### On USB (only on failure or crash)
| Service | USB Path |
| ------------- | ------------- |
| Itemzflow main app | /mnt/usb<USB_NUMBER>/itemzflow/crash.log |
| Dumper | /mnt/usb<USB_NUMBER>/itemzflow/dumper.log |
| Itemz Loader | /usb0/itemzflow/loader.log |
| Itemz Daemon | /mnt/usb0/itemzflow/daemon.log |
| Service | USB Path |
|--------------------|---------------------------------------------|
| Itemzflow main app | `/mnt/usb<USB_NUMBER>/itemzflow/crash.log` |
| Dumper | `/mnt/usb<USB_NUMBER>/itemzflow/dumper.log` |
| Itemz Loader | `/mnt/usb<USB_NUMBER>/itemzflow/loader.log` |
| Itemz Daemon | `/mnt/usb<USB_NUMBER>/itemzflow/daemon.log` |
## Official Discord server
@@ -213,12 +219,13 @@ Examples:
{ "type": "bytes", "addr": "0x00402d90", "value": "31c0c3" }
```
## Donations
We accept the following methods
- [Ko-fi](https://ko-fi.com/lightningmods)
- BTC: 3MEuZAaA7gfKxh9ai4UwYgHZr5DVWfR6Lw
- BTC: bc1qgclk220glhffjkgraju7d8xjlf7teks3cnwuu9
if you donate and dont want to the message anymore created this folder after donating ``
@@ -233,8 +240,10 @@ if you donate and dont want to the message anymore created this folder after don
- [Masterzorag](https://twitter.com/masterzorag)
- [Psxdev/BigBoss](https://twitter.com/psxdev)
- [Specter](https://twitter.com/SpecterDev)
- [SocraticBliss](https://twitter.com/SocraticBliss)
- [Sleirsgoevy](https://github.com/sleirsgoevy/)
- [AlAzif](https://github.com/al-azif)
- BigBoss
- [bucanero](https://github.com/bucanero) (Game Saves)
- [illusion](https://github.com/illusion0001) (Game Patches/Trainers)
- [Pharaoh2k](https://github.com/Pharaoh2k) (Apps/Games/DLCs Databases Recovery)