Charon

Unreal Engine Quick Start

  • Unreal Engine Plugin Overview
  • Getting Started
  • Core Concepts
  • Working with the Plugin
  • Advanced Features
  • How to Create Game Data File

Unity Quick Start

  • Unity Plugin Overview
  • Getting Started
  • Core Concepts
  • Working with the Plugin
  • Advanced Features
  • CharonCli Overview
  • Migration from Legacy Version (Before 2025.1.*)
  • Migrating to Web Application

Standalone Quick Start

  • Standalone & CLI Overview
  • Prerequisites
  • Installation and Updates
  • Creating and Editing Game Data

Web / Cloud Edition

  • Web Application Overview
  • CLI Access to charon.live
  • Migrating to Web Application
  • Roles and Permissions
  • REST API
  • Workspaces, Projects, and Branches

Server Edition

  • Server Edition

Data Modeling

  • Basic Navigation and User Interface Overview
  • Creating Document Type (Schema)
  • Filling Documents
  • Implementing Inheritance
  • Schema
  • Schema Types
  • Display Text Template
  • Specification
  • Schema Property
  • Id Property
  • Shared Property
  • Data Types
  • Composite Types

Source Code Generation

  • Generating Source Code
  • Working with Source Code (C# 7.3)
  • Working with Source Code (C# 4.0)
  • Working with Source Code (Type Script)
  • Working with Source Code (Haxe)

Data Workflows

  • Publishing Game Data
  • Importing and Exporting Data
  • Document Merge Logic
  • Internationalization (i18n)
  • Validation
  • Backup and Restore
  • Patch and Diff Workflow
  • CI/CD Integration

Integration & Automation

  • Command Line Interface (CLI)
  • Game Data Structure
  • Formula Expression AST
  • REST API

Extending Charon

  • UI Extensions
  • Implementing CharonPropertyEditorElement
  • Purpose of ValueControl
  • See also
  • Creating a Custom Editor with React
  • Creating a Custom Editor with Angular

Configuration & Troubleshooting

  • Working with Logs
  • Resetting UI Preferences

CLI Command Reference

  • Apply Patch (Merge)
  • Create Backup
  • Create Document
  • Create Patch (Diff)
  • Delete Document
  • Export Data
  • Find Document
  • Add Translation Languages
  • Export Translated Data
  • Importing Translated Data
  • List Translation Languages
  • Import Data
  • List Documents
  • Restore from Backup
  • Update Document
  • Validate Game Data
  • Generate C# Source Code
  • Generate Haxe Source Code
  • Export Code Generation Templates (Obsolete)
  • Generate Text from Templates (Obsolete)
  • Generate TypeScript Source Code
  • Generate Unreal Engine C++ Source Code
  • Initialize Game Data
  • URL input/output parameters
  • Start in Standalone Mode
  • Universal parameters
  • Environment variables
  • Get Charon Version

Reference

  • Frequently Asked Questions (FAQ)
  • Glossary
Charon
  • Search

© Copyright 2025, GameDevWare.

Built with Sphinx using a theme provided by Read the Docs.