This project is read-only.
Compiling your first package

Requirements: ArphoonCompilationUtility.exe also called ACU

To see an example about compiling new packages, check Create a simple package from ACU shell.

NOTE: The compiler is a complete stand alone executable that doesnt need the core library and only depends on .NET framework 2.0

To create a new package, first create a new directory anywhere you can access easily by command line (cmd.exe), and then put there all the files you want to pack into an Arphoon.

You can store any file and folder structure inside the package, even empty files

NOTE: Support for unicode charset on the file names is not stable. Please keep them within the ASCII table

Once you placed all the files to pack inside the newly created directory, launch a new command line (cmd.exe) by clicking on windows Start Menu, and selecting Run or press Windows+R.

Navigate withing the command line to the folder where "ArphoonCompilationUtility.exe" is located. Remember that this tool is included on every recommended version on the Downloads section, and also can be compiled from source code. This tool is also called ACU.exe

Full information about this tool can be found at the "Arphoon Compilation Utility (ACU)" page.

Run the tool by writting ArphoonCompilationUtility.exe /root=myDirectory where "myDirectory" is a full or relative path to the directory you created earlier, and where the files to be packed are stored.

Example
ArphoonCompilationUtility.exe /root="C:\Users\Razorback\Desktop\MyNewPackage"
  • You can also write a relative path instead. For example, if the compiler is stored inside "C:\Users\Razorback\Desktop\Arphoon\ArphoonCompilationUtility.exe" you can use ArphoonCompilationUtility.exe /root="..\MyNewPackage".
  • If the compiler is in the same directory as the files you want to pack, you can skip entirely the /root argument, but there is a chance that the compiler executable itself also ends packed inside the resulting package.
  • Another choice for launching the compilation shell, is by creating a shortcut to it and set "Working path" to the directory where the files you want to pack are stored.

This way, the compiler will start and set the working directory to the new folder you created and will drop you yo the Compilation Shell.

To successfully create a package you will need to:
  • Specify all files you want to pack
  • Set a compiler protocol (See: Protocols)
  • Set output filename
  • Simulate compilation
  • Perform real compilation

In order to include an specific file into the compilation process, use the command include or inc followed by the filename you want to add.

Example:
include myfile.txt
inc myfile.txt

At any time, you can see wich files where added to the compilation process, as well as the Output filename and the selected protocol, by using the command status or sta.

To add all files from the working directory to the compilation process, use the following commands:
includepattern *, or ipa *.
The recursive variant of includepattern is includepatternrecursive or ipr.
Example:
ipr *

Once all the desired files where added to the filelist, proceed to select the package protocol to be used.
Protocols are different formats of Arphoon Packages, wich differs one from another by the way how files are stored inside the package. The latest package protocol at 12/02/2014 is version 1.0.1.0_D. See more information about protocols at the Protocols page.

To select a protocol, use the command protocol or prt followed by the protocol version desired.
Example
protocol 1.0.1.0_D
prt 1.0.1.0_D

To specify an output filename, use the command output or out followed by the filename of the resulting package you want to create. The compiler supports relative paths as well, but its recommended to use Full paths to avoid mistakes while creating the output package.
Example
output C:\Users\Razorback\Desktop\myPackage.arphoon
out C:\Users\Razorback\Desktop\myPackage.arphoon
output ..\myPackage.arphoon

Finally, to compile successfully a package, you need to perform a Simulation first, in order to check if every file is readable and there is enough space on disk, by using the simulate or sim command.

NOTE: You cannot compile a package without performing a simulation first

If the simulation succeeds. You can use the command compile to create the package.

List of commands to use (in sequence)
ipr *
prt 1.0.1.0_D
out C:\Users\Razorback\Desktop\myPackage.arphoon
simulate
compile

Once you compile the package, you can mount it from any .NET application by using the provided core library.

To mount the package, first create a new solution on Visual Studio,

Last edited Feb 26, 2014 at 7:15 AM by kderazorback, version 4