Skip to content

Commit 67f2ff2

Browse files
authored
better README
1 parent 4b77523 commit 67f2ff2

1 file changed

Lines changed: 16 additions & 8 deletions

File tree

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
# acftool
22
ACF unpacking and building tool. Based on [a fork of acfdump](https://github.com/SombrAbsol/acfdump), an ACF unpacking tool originally created by Barubary in Java and ported here to C.
33

4-
Please note that the ACF building process is currently insufficient. File extraction works fine on original and reconstructed ACF files, but reconstructed files do not match their originals.
5-
6-
## Description
7-
ACF files are used in *Pokémon Ranger: Guardian Signs* data. This tool allows you to extract and decompress the files they contain, as well as rebuild ACF files and create your own. You can [download the latest release](https://github.com/SombrAbsol/acftool/releases/latest) or [build the program from source](#building).
4+
ACF files are used in *Pokémon Ranger: Guardian Signs* data. This tool allows you to extract and decompress the files they contain, as well as rebuild ACF files and create your own. You can [download the latest nightly](#download) or [build the program from source](#building).
85

96
For more information on the ACF format, see [the documentation](/doc/acf.md).
107

11-
## Building
12-
Dependencies: `gcc`, `make` (optional)
13-
1. Clone this repository by running `git clone https://github.com/SombrAbsol/acftool`, or [download the ZIP archive](https://github.com/SombrAbsol/acftool/archive/refs/heads/main.zip) and extract it
14-
2. Go to the repository directory and build the project. You can either run `gcc -O3 -Wall -Wextra -Werror -o acfdump` or `make` if you have it installed
8+
Please note that the ACF building process is currently insufficient. File extraction works fine on original and reconstructed ACF files, but reconstructed files do not match their originals.
9+
10+
## Download
11+
| | Linux | Windows |
12+
| ------- | ----- | ------- |
13+
| Release | | |
14+
| Nightly | [Download](https://nightly.link/SombrAbsol/acftool/workflows/c-cpp/main/acftool-linux.zip) | [Download](https://nightly.link/SombrAbsol/acftool/workflows/c-cpp/main/acftool-windows.zip) |
1515

1616
## Usage
1717
### Dumping the ROM
@@ -42,6 +42,14 @@ To build an ACF file, run `acftool -b <folder>`. Please note that the target fol
4242
0004.CANR 1
4343
```
4444

45+
## Building
46+
Dependencies: `gcc`, `make` (optional)
47+
1. Clone this repository by running `git clone https://github.com/SombrAbsol/acftool`, or [download the ZIP archive](https://github.com/SombrAbsol/acftool/archive/refs/heads/main.zip) and extract it
48+
2. Go to the repository directory and build the project. You can either run `gcc -O3 -Wall -Wextra -Werror -o acfdump` or `make` if you have it installed
49+
4550
## Credits
4651
* Tool by [SombrAbsol](https://github.com/SombrAbsol)
4752
* acfdump and ACF documentation by [Barubary](https://github.com/Barubary) (the original acfdump is available on [his website](http://www.propl.nl/javaprogs/acfdump.jar))
53+
54+
## License
55+
acftool is free software. You can redistribute it and/or modify it under the [terms of the Expat License](/LICENSE) as published by the Massachusetts Institute of Technology.

0 commit comments

Comments
 (0)