Mirrors/PKHeX
2
0
Fork 0
mirror of https://github.com/kwsch/PKHeX synced 2025-02-17 05:48:44 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update README.md

Browse source
This commit is contained in:
Kaphotics 2016-01-03 15:35:19 -08:00
parent 10aa58078a
commit d0bdbffaf0
1 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -3,15 +3,19 @@ PKHeX
Pokémon X/Y/OR/AS SAV/PKX file editor, programmed in [C#](https://en.wikipedia.org/wiki/C_Sharp_%28programming_language%29).
Supports binary file loading of:
Supports binary file loading of the following files originating from the Nintendo 3DS:
* Decrypted Save files (1MB/Cyber Save 0x65600/0x76000 Bytes)
* Individual entity files (232/260 bytes)
* Wondercard gifts for Event Pokemon and Event based Items.
* Individual entity files (232/260 bytes), saved as .pk6 and .ek6
* Conversion of Event Gift files (.wc6) to .pk6
* Decrypted Battle Videos
* Obsoleted: Unencrypted Network Packets containing entity files.
The following files from previous generations of games are supported:
* Transferring of previous generation entities (.pkm) to .pk6
* Conversion of Event Files (.pgt, .pcd, .pgf) to .pk6
Data is then displayed in a meaningful view, and can be edited and saved back to binary data.
For loaded save files, saving an edited copy is possible and all hashes will be fixed.
Since save data uses an AES MAC that cannot be emulated without the 3DS's keys, a resigning service is required.
Since the Nintendo 3DS savedata containers use an AES MAC that cannot be emulated without the 3DS's keys, a resigning service is required (svdt, save_manager, or SaveDataFiler).
The interface is translatable with resource/external text files so that different languages can be supported.
@ -29,16 +33,12 @@ PKHeX can be compiled with any C# compiler.
### IDE
It is easy with MS Visual Studio and [MonoDevelop](http://www.monodevelop.com/).
You can import the project with the .sln file.
PKHeX can be opened with MS Visual Studio and [MonoDevelop](http://www.monodevelop.com/) by importing the project with the .sln or .csproj file.
### Command line
### Command Line
You can use [xbuild of Mono](http://mono-framework.com/Microsoft.Build): `xbuild PKHeX.sln`.
### GNU/Linux
On Debian, you can install MonoDevelop and [Mono](http://www.mono-project.com/) runtime with `sudo apt-get install monodevelop`.
The project uses System.Deployment, unfortunately - even with version 4.0 - [it is not implemented in Mono](https://stackoverflow.com/questions/9112460/mono-develop-assembly-system-deployment-not-found).
There is the same problem with [System.Data.SqlServerCe (SQL Server Compact Edition)](https://stackoverflow.com/questions/2644464/can-i-use-sql-server-compact-edition-ce-on-mono) (that could be replaced by [SQLite](https://en.wikipedia.org/wiki/SQLite), that is free/libre cross-platform [RDBMS](https://en.wikipedia.org/wiki/Relational_database_management_system) to avoid the problem).
At least in 2015, GNU/Linux is not the main OS of developers of this program, so there are bugs, but some may come from non GNU/Linux specific code of Mono (so developers using *BSD, Windows and OS X should be able to reproduce them).
On Debian, you can install MonoDevelop and [Mono](http://www.mono-project.com/) runtime with `sudo apt-get install monodevelop`. GNU/Linux is not the main Operating System of developers of this program so there may be bugs; some may come from non GNU/Linux specific code of Mono (so developers using *BSD, Windows and OS X should be able to reproduce them).