CastFORM is an easy-to-use Pokémon TCG Deck Registration Sheet generator.
CastFORM offers an elegant graphical interface for filling in Pokémon deck lists for tournaments, and creates beautiful PDFs from user input. This reduces the likelihood of human errors associated with filling out of forms by hand, and also integrates well with existing players' workflows, given the popularity of deck strings (of various formats) in the Pokémon TCG community.
This project is based on Brandon Nguyen's CLI Python script that served a similar purpose. CastFORM was spearheaded in response to the high demand for a user-friendly program in his local TCG community, most of whom were not comfortable with CLI tools.
Note: Only 64-bit Windows 11 machines are officially supported.
- Download
castform.zip
from the releases page- Note: actual file name may vary
- Unzip it into your desired install location
- Run
CastFORM.exe
from that location
- Download
CastFORM_x64.exe
from the releases page - Run it as administrator to install CastFORM to
C:\Program Files\CastFORM
- Run
CastFORM.exe
fromC:\Program Files\CastFORM\CastFORM.exe
, and/or create a shortcut for it
- A video of the installation and usage steps: https://youtu.be/a4peYpnhHg0
CastFORM is built with Flutter 3.7.8 for 64-bit Windows 11, and targets Google's Dart style guide.
For testing, we aim to provide complete coverage for API behaviour internally by release.
- Install Flutter and add it to PATH
- Clone the repository
- Open the repository in IntelliJ
- You may use your IDE of choice, but we prefer IntelliJ here at BAA Studios
- Make sure you install the Dart and Flutter Plugin for IntelliJ
- Make sure
Windows (desktop)
is selected in the list of devices - Hit the
Run
button at the top right of the window
API docs for the business logic are included as static HTML files in the repository.
After cloning the repository, navigate to the respective package to open them:
packages/deck_string_parser/doc/api/index.html
packages/pokemon_pdf_builder/doc/api/index.html
- Run
flutter build windows
- Navigate to the output folder
/build/windows/runner/Release
- Add the following
dlls
(which can be found in a Visual Studio 2022 installation folder, e.g.C:\Program Files\Microsoft Visual Studio\2022\Community\VC\Redist\MSVC\14.32.31326\x64\Microsoft.VC143.CRT
)- msvcp140.dll
- vcruntime140.dll
- vcruntime140_1.dll
- Package the contents of this folder as a ZIP file
- Users can unzip to their desired location and run
CastFORM.exe
from there
- Users can unzip to their desired location and run
Note: This assumes you've already run through steps 1-4 of the build instructions
First time bundling:
- Add a batch script
setup.bat
(refer to/sample_setup.bat
for template) - Run
iexpress.exe
as administrator - Select
Create new Self Extraction Directive file
, and hitNext
- Select
Extract files and run an installation command
, and hitNext
- Input a title (e.g.
CastFORM Installer
), and hitNext
- Select
No prompt
, and hitNext
- Select
Do not display a license
, and hitNext
- Use the
Add
button to add all the files in the output folder from above, and hitNext
- The file picker dialog box allows
CTRL + A
to select all files - The file picker dialog box ignores folders, and does not add them recursively
- You may use
CTRL + A
on the output folder and repeat for all nested folders to quickly add everything
- The file picker dialog box allows
- In the
Install Program
field, click on it and manually replace withcmd /c setup.bat
, and hitNext
- You are able to type in this drop down box
- The
cmd /c
part is REQUIRED - IExpress simply bundles/extracts as well as wrap around a batch script, so all installation logic should be written in
setup.bat
- Select
Default
, and hitNext
- Input a message if you like, and hit
Next
- Click
Browse
and select an output folder for the resulting installer EXE, and give it a name - Check
Store files using Long File Name inside Package
, and hitNext
- Select
No restart
, and hitNext
- Select
Save Self Extraction Directive (SED) file
, and useBrowse
to choose a save location, then hitNext
- The SED file contains all the configuration you've done up to this point
- Importing this file will allow you to reuse the same configuration for future bundling attempts
- On the
Create package
page, hitNext
to start the bundling process, and thenFinish
once it's done
For subsequent bundling:
- Run
iexpress.exe
as administrator - Select
Open existing Self Extraction Directive file
, and select the SED file withBrowse
- Select
Create Package
- On the
Create package
page, hitNext
to start the bundling process, and thenFinish
once it's done
CastFORM is an open-source program for a generating a niche type of PDF documents. CastFORM is not affiliated with Nintendo, The Pokémon Company, or any Pokémon-related organisations fan-driven or otherwise. CastFORM is non-monetised, and provided as is. Every reasonable effort has been taken to ensure correctness and reliability of CastFORM. We will not be liable for any special, direct, indirect, or consequential damages or any damages whatsoever resulting from loss of use, data or profits, whether in an action if contract, negligence or other tortious action, arising out of or in connection with the use of CastFORM (in part or in whole).