English|中文

VTF is a CTF competition platform built with Vlang. Compared to other platforms, VTF has the following features:

• Compiled with Clang for higher runtime efficiency.
• Uses built-in Veb framework without needing to learn other web frameworks.
• Vlang's cross-compilation capabilities enable easy cross-platform deployment.
• Supports split-screen operations for normal use on minimal screens.
• Developed with a minimalist philosophy for quick deployment.
• Maintained by Sakana Team with high anime energy.

We provide both source code and precompiled binaries for use.

./main -h
VTF v2.6.1-stable, CTF competition platform based on the V programming language.
Basic usages:
 运行程序:      main [Options]
 运行程序(设置线程数):  main [walkers] [Options]
Options:
 -h, -help                              显示编码的基本信息并退出.
 -v, --version                          显示版本号并退出.
 -n, --nohup                            守护进程并将日志输出到nohup.out文件(目前只支持在linux设置).
 -p, --port [int]                       设置端口号.
 -d, --database [string]                设置使用的数据库名.

We provide stable releases for quick deployment. You can directly download precompiled binaries using:

wget https://github.com/sakana-ctf/VTF/releases/tag/[version]/vtf-[edition]
unzip vtf-[edition]-[system].zip
cd vtf-[edition]-[system]
./main

For detailed versions, visit our https://github.com/sakana-ctf/VTF/releases. The file structure is:

vtf
├── static
│   ├── css
│   ├── image
│   ├── html
│   └── js
├── main
└── data
    ├── README.md
    └── data.db

Where main is the executable program that, when used, creates a database file. For example, it defaults to creating data.db as the database file stored in the data folder. The database file stores all data for the current competition. There is no need to install anything; simply running ./main will give you the VTF environment.

Note: The nohup ./main & syntax is deprecated. Use ./main -n or ./main --nohup instead.

sqlite3

See detailed instructions in https://gitee.com/sakana_ctf/vdoc. The Sakana Team provides comprehensive guides from basic deployment to usage - welcome to star!

Configure SQLite before use:

Archlinux Users

sudo pacman -S sqlite

Debian-based Users

sudo apt install sqlite3 libsqlite3-dev

Fedora Users

sudo dnf -y install sqlite-devel

Windows Users

• Download SQLite zip from https://sqlite.org/download.html.
• Create sqlite folder in v/thirdparty.
• Extract zip to this folder.

Git users:

git clone https://github.com/sakana_ctf/vtf.git
cd vtf

Non-git users can download from https://github.com/sakana-ctf/VTF.

Compile templates first for easier HTML modification:

v templates_split/build.v

Compile and run:

./templates_split/build ; v main.v ; ./main

This compiles templates_split to templates, then the main program, and finally runs it.

Note: The nohup ./main & syntax is deprecated. Use ./main -n or ./main --nohup instead.

VTF is a large project. Contributions are welcome! We provide learning materials:

VTF is based on Vlang. Learn through sakana_ctf/vdoc

VTF follows wiki standards. Please familiarize yourself with the wiki before contributing.

Follow this guide: How to Contribute to Open Source Projects on GitHub. Features to implement/maintain are listed in the Support Matrix. You can also ask questions in issues.

VTF uses the VY Universal License. Simplified explanation below. For full details, see LICENSE:

The VY License allows free modification and commercial use with attribution to VYCMa (using VYCMa.png logo or stating "Source from VYCMa").

Regarding redistribution: Modified code can be closed-source. Each modified file must include copyright notice. Public displays require author attribution (personal logo if specified, otherwise VYCMa.png or "Source from VYCMa").