Basilisk Logo
BasiliskDocs

Configuration

Configure Basilisk to match your project's needs.

Basilisk Definition Configuration

Basilisk Definitions are configured using the Basilisk Definition Language (BDL). Key configuration aspects include:

  • Entities: Define the main data structures with their variables
  • Variables: Configure data types, optional fields, defaults, and references
  • Indexes: Define how to look up entities in datasets
  • Data Bundles: Group entities into deployable units

See the Creating Content guide for detailed BDL syntax.

Environment Configuration

Environments can be configured with various safety features:

Forced Diff Review

When enabled, users must review the differences between the current and new data build before publishing. This prevents accidental deployments and helps catch issues early.

Environment-Level Safety Checks

Additional validation rules can be configured at the environment level to ensure data integrity before deployment.

Basilisk Definition Assignment

Each environment can be assigned a specific Basilisk Definition. When building data for that environment, the assigned definition is used by default.

Data Source Configuration

Data Sources (Google Spreadsheets) need to be configured to match your Basilisk Definition structure:

  • Column names should match variable names from your definition
  • Data types in the spreadsheet should be compatible with the defined variable types
  • Primary keys must be unique and match the definition's primary key specification
  • References should point to valid entities in the referenced dataset

The Web Console provides validation feedback when adding or updating data sources.

Data Build Configuration

When creating a Data Build, you can configure:

Build ID

A unique identifier for the build. Can follow a naming convention if configured, or be manually specified.

Description

A human-readable description of what the build contains or represents. Useful for tracking changes and understanding build history.

Log Level

Optional configuration for the verbosity of build execution logs. Useful for debugging build issues.

Naming Conventions

Basilisk follows specific naming conventions for consistency:

Entity, Subentity & Enum Names

Use PascalCase (e.g., Character, WeaponType)

Variable Names

Use camelCase (e.g., characterId, maxHealth)

Enum Values

Use UPPER_SNAKE_CASE (e.g., LEGENDARY, COMMON)

Data Bundle Names

Use PascalCase, typically matching the entity name (e.g., Characters)