To use CBINS, first start by creating a new folder for your project then place a copy of
cbins.exe into it. Open that directory in a terminal by right-clicking then selecting
Open in Terminal. This will allow you to enter the commands seen in the section below.
To start a new project, use the
cbins new command like below:
cbins new name-of-project
This'll create an empty project with a default setup that's ready to be worked on in an editor such as VSCode. Just open the folder with a
-pk3 suffix that's created.
Once you've done your edits, you can use the
cbins build command to create a PK3 like below:
cbins build
Once it's done building, you'll see it in the
dist directory of your project structure!
You can additionally pass a
-o parameter for CBINS to use
pngout.exe to optimize the PNG files in your project. This may take a moment depending on the size of your project, so it is
not default behavior.
Note that you'll have to install
pngout.exe and place it into your project structure before that parameter will function fully. See the FAQ for more details there.
If you already have a PK3 that you wish to convert into a CBINS project, you can use a command that looks like below:
cbins new -pk3 "C:\Users\User\Desktop\Mega Man 8-Bit Deathmatch\wads\8bdm_jampacktwo-v2a.pk3" jampack-two
You can obtain the file path seen in this command by right-clicking a PK3 file then selecting
Copy as path.