diff --git a/Console/README.md b/Console/README.md new file mode 100644 index 00000000..9570838b --- /dev/null +++ b/Console/README.md @@ -0,0 +1,7 @@ +GameRes.Console +=============== + +Console utility that extracts files from game archives. Used as a testing +playground for GameRes library. + +No longer developed. diff --git a/GameRes/README.md b/GameRes/README.md new file mode 100644 index 00000000..b5e8a8c6 --- /dev/null +++ b/GameRes/README.md @@ -0,0 +1,7 @@ +GameRes Library +=============== + +Library of the base classes that deal with game resources, such as archives, +images and audio files. All derived file formats are expected to register +themselves by the means of [MEF](https://msdn.microsoft.com/en-us/library/dd460648.aspx) within +repository class FormatCatalog. diff --git a/Image.Convert/README.md b/Image.Convert/README.md new file mode 100644 index 00000000..1dd03190 --- /dev/null +++ b/Image.Convert/README.md @@ -0,0 +1,7 @@ +Image.Convert +============= + +Console utility that converts images between various formats. Used as a +testing playground for GameRes library. + +No longer developed. diff --git a/README.md b/README.md index d0042520..f76cc35e 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,25 @@ Requires .NET Framework v4.5 or newer (https://www.microsoft.com/net) [Download latest release](https://github.com/morkt/GARbro/releases) +Operation +--------- + +Browse through the file system to a file of interest. If you think it's an +archive, try to 'enter' inside by pressing 'Enter' on it. If GARbro +recognizes format its contents will be displayed just like regular file +system. Some archives are encrypted, so you will be asked for credentials or +a supposed game title. If game is not listed among available options then +most likely archive could not be opened by current GARbro version. + +Files could be extracted from archives by pressing 'F4', with all images and +audio converted to common formats in the process, of course if game format +itself is recognized. + +When displaying file system contents GARbro assigns types to files based on +their names extension (so it's not always correct). If types are misapplied, +it could be changed by selecting files and assigning type manually via context +menu 'Assign file type'. + GUI Hotkeys -----------