Skip to content

Compiler for Nintendo EventFlow flowcharts used in Animal Crossing: New Horizons

License

Notifications You must be signed in to change notification settings

asteriation/acnh-eventflow-compiler

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Compiler for Nintendo EventFlow flowcharts

Tool to compile a readable, code-like format into eventflow flowcharts (bfevfl) for Animal Crossing: New Horizons.

This project is the counterpart of acnh-eventflow-decompiler.

This project compiles all 562/562 of the decompiled flows from ACNH v1.11.0, with 558/562 compiled flows being smaller, and 3/562 being the same size when using --optimize.

Installation

This compiler uses several libraries, which can be installed with python3 -m pip install -r requirements.txt.

Usage

The decompiler may be run through main.py using Python 3.7+.

You will need to supply a functions.csv file containing typing information for EventFlow functions; this can be done for ACNH by downloading the appropriate 'functions.csv' sheet for your game version from this spreadsheet as a CSV file.

You will also need to supply the evfl files to be compiled.

mkdir -p out/

python3 main.py --functions functions.csv \
                -d output_directory \
                file1.evfl file2.evfl ...

This outputs the compiled bfevfls into output_directory.

If compiling only a single file, -o can be used instead of -d to specify the output file name.

There are some flags starting with --f to optimize for output file size (at the expense of a readable decompile), and --optimize enables them all.

License

This software is licensed under the terms of the MIT License.

About

Compiler for Nintendo EventFlow flowcharts used in Animal Crossing: New Horizons

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages