diff --git a/README.MD b/README.MD index 80fe86a5..3fb2d588 100644 --- a/README.MD +++ b/README.MD @@ -1,84 +1,83 @@ -

SabreTools

+# ![](images\sabretools-rect.png) -

Introduction

+## Introduction -This project started as a desktop port of some core features of Wizard of DATz Redux, but it has since grown into a fully-featured DAT management tool. Below is a brief description of the features available in the suite. For more information about each feature, see the help text in each of the programs. For more information about the parent project, see here. +The SabreTools project started as a desktop port of some core features of Wizard of DATz Redux, but it has since grown into a fully-featured DAT management tool. Below is a brief description of the features available in the suite. For more information about each feature, see the help text in each of the programs. For more information about the parent project, see [here](https://github.com/SabreTools/wizzardRedux). - +> "tbh... i have no real idea what sabretools is xD. my best guess some prehistoric sort of swiss army knife" - **Executer** -

Features

+## Features -For the most complete set of information, see the README.1ST file. Currently, the SabreTools suite consists of the following programs: +For the most complete set of information, see the [README.1ST](https://raw.githubusercontent.com/SabreTools/SabreTools/master/SabreTools.Helper/README.1ST) file. Currently, the SabreTools suite consists of the following programs: + +### SabreTools / SabreTools.Library + +As the core of the SabreTools suite, C# library provides nearly all of the functionality, while the main executable acts as a reference implementation. Below is a list of features included in the library and exposed though the executable: + +* **Dir2DAT / DATFromDir** - Create a DAT from a file, folder, or mix of both + * Archives and files can be filtered selectively + * Archives can be treated like files, that is, it will get an external hash only + * Multiple input archive formats are supported: 7zip, GZip, RAR, TAR, and ZIP/ZIP64 + * Multiple hashing algorithms available, up to SHA-512 + * Created DATs can be output in multiple formats at once, including ClrMamePro, Logiqx XML, and RomCenter + * All DAT fields can be set for the output + * Files with copier headers can be checked for additional hashes +* **DAT Conversion** - Convert DATs between numerous formats, including standards such as ClrMamePro, Logiqx XML, and RomCenter + * Converted DATs can be output in multiple formats at once + * Filtering can be done on all DATs based on criteria such as item type, sizes, hashes, and names + * Input DATs can optionally be merged and diffed with each other + * All DAT fields can be updated during the conversion +* **DAT Splitting** - Split DATs based on multiple different criteria + * Split by user-defined extensions into two DATs + * Split by best-available hash, e.g. SHA-1 + * Split a SuperDAT on the lowest available directory level + * Split by DAT item types +* **DAT Statistics** - Get statistics on a DAT or folder of DATs + * Includes items such as rom and game counts + * Includes the total uncompressed size of all items + * Optionally includes statistics on individual DATs in a folder + * Reports can be output in standard text, CSV, and/or HTML formats +* **Extract and Restore Copier Headers** - Extract and store or restore from DB copier headers + * Supports copier headers from the following systems: + * Atari 7800 + * Atari Lynx + * Commodore 64 PSID music + * NEC PC-Engine / TurboGrafx 16 + * Nintendo Famicom Disk System + * Nintendo Entertainment System / Famicom + * Super Nintendo Entertainment System / Super Famicom + * Super Nintendo Entertainment System / Super Famicom SPC music + * Stores the header information linked to unheadered hash +* **Rebuild From DAT** - Act as a simple rebuilder for files + * Two options for rebuild origin: standard folder and Romba depot + * Multiple output formats: unarchived, TAR, TorrentZip, 7zip, XZ, TorrentGZ + * Can rebuild from multiple DATs at the same time + * Cross-check with multiple hashing algorithms, up to SHA-512 + * Can output a fixdat based on the rebuilt files +* **Verify From DAT** - Act as a simple verifier for files + * Two options for verification target: standard folder and Romba depot + * Exact verification and hash-only verification both available + * Can verify from multiple DATs at the same time + * Cross-check with mutliple hashing algorithms, up to SHA-512 -SabreTools -

-The main tool of the SabreTools suite. Performs the majority of the core features of the parent project, including the following (sorted by the original standalone executable, if any): -

This tool has a comprehensive list of command line parameters that can be used to do the above and much more. -

Power User Tools

+### RombaSharp -This section is for tools that have been requested for a highly specific purpose and are not generally going to be used by regular users. All of them have a possibility of being included in the main DATabase program eventually. +An in-progress tool that will try to act as a C# port of the Go-based [Romba](https://github.com/uwedeportivo/romba/) program. All features that are not already a part of SabreTools will be attempted to be added to this program. It is NOT ready for use yet. For any inquiries into the full features of this tool, please contact the project. - +## Licensing -RombaSharp -

-An in-progress tool that will try to act as a C# port of the Go-based Romba program. All features that are not already a part of SabreTools will be attempted to be added to this program. It is NOT ready for use yet. +The preceding programs use, in part or in whole, code, libraries, and/or applications from the [7-zip project](http://www.7-zip.org). 7-zip is licensed under the GNU LGPL. + +The preceding programs use, in part or in whole, code, libraries, and/or applications from [DotNetSharp](https://dotnetzip.codeplex.com). DotNetSharp is licensed under the Microsoft Public License of October 2006. -

Licensing

-

-The preceeding programs use, in part or in whole, code, libraries, and/or applications from the 7-zip project. 7-zip is licenced under the GNU LGPL.
-The preceeding programs use, in part or in whole, code, libraries, and/or applications from DotNetSharp. DotNetSharp is licensed under the Microsoft Public License of October 2006. All other external code is marked as such within the source and correctly attributed to the site and/or person(s) that originally wrote the code. + All code written by project members is licensed under GPL v3. See LICENSE for more details. -

Contributions

+## Contributions Any feature suggestions or code contributions are accepted. Please take the time to look over the existing code to see proper coding and documentation patterns. + +Contributors are attributed in the code and in the README. \ No newline at end of file diff --git a/RombaSharp/RombaSharp.csproj b/RombaSharp/RombaSharp.csproj index 3fb8245c..a89d7284 100644 --- a/RombaSharp/RombaSharp.csproj +++ b/RombaSharp/RombaSharp.csproj @@ -109,9 +109,9 @@ - + {225a1afd-0890-44e8-b779-7502665c23a5} - SabreTools.Helper + SabreTools.Library diff --git a/SabreTools.Helper/SabreTools.Helper.csproj b/SabreTools.Helper/SabreTools.Library.csproj similarity index 100% rename from SabreTools.Helper/SabreTools.Helper.csproj rename to SabreTools.Helper/SabreTools.Library.csproj diff --git a/SabreTools.sln b/SabreTools.sln index dbe43e60..5468597e 100644 --- a/SabreTools.sln +++ b/SabreTools.sln @@ -1,9 +1,9 @@  Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 14 -VisualStudioVersion = 14.0.23107.0 +# Visual Studio 15 +VisualStudioVersion = 15.0.26228.10 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SabreTools.Helper", "SabreTools.Helper\SabreTools.Helper.csproj", "{225A1AFD-0890-44E8-B779-7502665C23A5}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SabreTools.Library", "SabreTools.Helper\SabreTools.Library.csproj", "{225A1AFD-0890-44E8-B779-7502665C23A5}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "SabreTools", "SabreTools\SabreTools.csproj", "{3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}" EndProject @@ -19,43 +19,43 @@ Global Release|x64 = Release|x64 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Debug|Any CPU.Build.0 = Debug|Any CPU - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Debug|x64.ActiveCfg = Debug|x64 - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Debug|x64.Build.0 = Debug|x64 - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Mono|Any CPU.ActiveCfg = Mono|Any CPU - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Mono|x64.ActiveCfg = Mono|x64 - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|Any CPU.ActiveCfg = Release|Any CPU - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|Any CPU.Build.0 = Release|Any CPU - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|Any CPU.Deploy.0 = Release|Any CPU - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|x64.ActiveCfg = Release|x64 - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|x64.Build.0 = Release|x64 - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Mono|Any CPU.Build.0 = Mono|Any CPU - {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Mono|x64.Build.0 = Mono|x64 {225A1AFD-0890-44E8-B779-7502665C23A5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {225A1AFD-0890-44E8-B779-7502665C23A5}.Debug|Any CPU.Build.0 = Debug|Any CPU {225A1AFD-0890-44E8-B779-7502665C23A5}.Debug|x64.ActiveCfg = Debug|x64 {225A1AFD-0890-44E8-B779-7502665C23A5}.Debug|x64.Build.0 = Debug|x64 {225A1AFD-0890-44E8-B779-7502665C23A5}.Mono|Any CPU.ActiveCfg = Mono|Any CPU + {225A1AFD-0890-44E8-B779-7502665C23A5}.Mono|Any CPU.Build.0 = Mono|Any CPU {225A1AFD-0890-44E8-B779-7502665C23A5}.Mono|x64.ActiveCfg = Mono|x64 + {225A1AFD-0890-44E8-B779-7502665C23A5}.Mono|x64.Build.0 = Mono|x64 {225A1AFD-0890-44E8-B779-7502665C23A5}.Release|Any CPU.ActiveCfg = Release|Any CPU {225A1AFD-0890-44E8-B779-7502665C23A5}.Release|Any CPU.Build.0 = Release|Any CPU {225A1AFD-0890-44E8-B779-7502665C23A5}.Release|x64.ActiveCfg = Release|x64 {225A1AFD-0890-44E8-B779-7502665C23A5}.Release|x64.Build.0 = Release|x64 - {225A1AFD-0890-44E8-B779-7502665C23A5}.Mono|Any CPU.Build.0 = Mono|Any CPU - {225A1AFD-0890-44E8-B779-7502665C23A5}.Mono|x64.Build.0 = Mono|x64 + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Debug|Any CPU.Build.0 = Debug|Any CPU + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Debug|x64.ActiveCfg = Debug|x64 + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Debug|x64.Build.0 = Debug|x64 + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Mono|Any CPU.ActiveCfg = Mono|Any CPU + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Mono|Any CPU.Build.0 = Mono|Any CPU + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Mono|x64.ActiveCfg = Mono|x64 + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Mono|x64.Build.0 = Mono|x64 + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|Any CPU.ActiveCfg = Release|Any CPU + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|Any CPU.Build.0 = Release|Any CPU + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|Any CPU.Deploy.0 = Release|Any CPU + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|x64.ActiveCfg = Release|x64 + {3B615702-1866-4D7B-8AF1-7B43FD0CC1D0}.Release|x64.Build.0 = Release|x64 {4728D479-8CFB-43E9-8C63-4774C6D73200}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {4728D479-8CFB-43E9-8C63-4774C6D73200}.Debug|Any CPU.Build.0 = Debug|Any CPU {4728D479-8CFB-43E9-8C63-4774C6D73200}.Debug|x64.ActiveCfg = Debug|x64 {4728D479-8CFB-43E9-8C63-4774C6D73200}.Debug|x64.Build.0 = Debug|x64 {4728D479-8CFB-43E9-8C63-4774C6D73200}.Mono|Any CPU.ActiveCfg = Mono|Any CPU + {4728D479-8CFB-43E9-8C63-4774C6D73200}.Mono|Any CPU.Build.0 = Mono|Any CPU {4728D479-8CFB-43E9-8C63-4774C6D73200}.Mono|x64.ActiveCfg = Mono|x64 + {4728D479-8CFB-43E9-8C63-4774C6D73200}.Mono|x64.Build.0 = Mono|x64 {4728D479-8CFB-43E9-8C63-4774C6D73200}.Release|Any CPU.ActiveCfg = Release|Any CPU {4728D479-8CFB-43E9-8C63-4774C6D73200}.Release|Any CPU.Build.0 = Release|Any CPU {4728D479-8CFB-43E9-8C63-4774C6D73200}.Release|x64.ActiveCfg = Release|x64 {4728D479-8CFB-43E9-8C63-4774C6D73200}.Release|x64.Build.0 = Release|x64 - {4728D479-8CFB-43E9-8C63-4774C6D73200}.Mono|Any CPU.Build.0 = Mono|Any CPU - {4728D479-8CFB-43E9-8C63-4774C6D73200}.Mono|x64.Build.0 = Mono|x64 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/SabreTools/SabreTools.csproj b/SabreTools/SabreTools.csproj index 9f6d7f0f..5afea323 100644 --- a/SabreTools/SabreTools.csproj +++ b/SabreTools/SabreTools.csproj @@ -130,9 +130,9 @@ - + {225a1afd-0890-44e8-b779-7502665c23a5} - SabreTools.Helper + SabreTools.Library diff --git a/images/sabretools-rect.png b/images/sabretools-rect.png new file mode 100644 index 00000000..c9eac79c Binary files /dev/null and b/images/sabretools-rect.png differ diff --git a/images/sabretools-square.png b/images/sabretools-square.png new file mode 100644 index 00000000..be50bea2 Binary files /dev/null and b/images/sabretools-square.png differ