Virtual-World-RE/NeoGF
4
0
Fork 0
mirror of https://github.com/Virtual-World-RE/NeoGF.git synced 2024-12-25 18:51:35 +01:00
Code Issues Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
tmpz23 2022-02-28 10:03:43 +01:00 committed by GitHub
parent ffe64dfd18
commit 4c9c2b1d55
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -1,5 +1,5 @@
# NeoGF
NeoGF is a library of tools for Gotcha Force.
NeoGF is a library of tools for GameCube and Gotcha Force.
> This project is still under "heavy" development. It not yet 100% ready to use.
>
@ -13,24 +13,25 @@ If you want more infos about the game, go read our [Gotcha Force Wiki](http://re
Python3 script for unpack/pack GCM/iso files. This tool can rebuild FileStringTable (FST) of GCM and patch boot.bin with a new apploader.img, boot.dol, add/remove/edit of folder and files of the game.
### User manual
Unpack GCM/iso file **game.iso** in folder **unpack_iso**: (If the destination folder is not specified, it will use the game_code-DVD_number as folder.)
Unpack GCM/iso file **source_gcm.iso** in the default new folder _game_code-DVD_number_. If optional_dest_folder is specified we unpack in _optional_dest_folder_.
```
gcmtool.py --unpack game.iso unpack_iso
gcmtool.py --unpack source_gcm.iso optional_dest_folder
```
Pack folder in GCM/iso:
```
gcmtool.py --pack unpack_iso game.iso
```
Rebuild FST and patch boot.bin for a new apploader, dol, and add/remove/edit of folders and files:
```
gcmtool.py --rebuild-fst unpack_iso
```
Print stats about the GCM/iso file or the unpacked GCM/iso folder. Get full memory mapping, sys and empty spaces informations:
```
gcmtool.py --stats path
```
Japanese charset is not handled for now except if you have installed Japanese local. The original GCM/iso and repack GCM/iso are different most of the time. This is because GCM DVD contains "empty spaces" with data unused (old datas or random datas I don't know). So this datas are useless and loss during unpack.
Pack **source_folder** in the default new GCM/iso file _source_folder.iso_. If optional_dest_file.iso is specified we pack in _optional_dest_file.iso_. If one of the files or system files contains length change we have to use --rebuild-fst command before packing.
```
gcmtool.py --pack source_folder optional_dest_file.iso
```
Rebuild the FST file system of an unpacked GCM/iso and patch boot.bin for a new apploader, dol, and add/remove/edit of folders and files.
```
gcmtool.py --rebuild-fst source_folder
```
Print stats about the GCM/iso file or the unpacked GCM/iso folder. This stats contains informations about full memory mapping sorted by offset (files and system files), get empty spaces informations using optional align -a (default=4).
```
gcmtool.py --stats path -a 4
```
Japanese charset is not handled for now except if you have installed Japanese local. The original GCM/iso and repack GCM/iso are different most of the time. This is because GCM DVD contains "empty spaces" with data unused (old datas or random datas I don't know). So this datas are useless and loss during unpack. The sorting of files during FST rebuild is deferent from the original and this is full compatible with the GameCube dol API.
### Extracted file tree
root folder contains all files of the unpacked GCM/iso
@ -63,9 +64,9 @@ Rebuild the AFS file system of an unpacked AFS using afs_rebuild.conf and afs_re
```
afstool.py --rebuild source_folder
```
Print stats about the AFS file or the unpacked AFS folder. This stats contains informations about FD, offsets ranges and files (and sys files) addresses space, and duplicated filenames grouped by filenames.
Print stats about the AFS file or the unpacked AFS folder. Get full informations about header, TOC, FD, full memory mapping sorted by offsets (files and sys files), addresses space informations, and duplicated filenames grouped by filenames.
```
afstool.py --stats source
afstool.py --stats path
```
### Extracted file tree