README.md

Introduction

Charon is a versatile plugin tailored for Unity, designed to facilitate data-driven game design by allowing both developers and game designers to efficiently manage static game data, like units, items, missions, quests, and other. It provides a user-friendly interface that requires no special skills for game designers, simplifying the process of data manipulation. For programmers, Charon streamlines development workflows by generating c# code to load game data seamlessly into the game.

Installation

Prerequisites

Unity Editor plugin uses dotnet charon tool, which is a .NET Core application built for .NET 8 and it runs wherever Unity Editor can run.

The generated code and data do not require any additional dependencies for your game's runtime.

Installation from OpenUPM (recommended)

1. Install the .NET 8 or later software for your operating system (Windows, MacOS, Linux).
2. Ensure your Unity version is 2021.3 or later.
3. Open the OpenUPM page for the plugin.
4. Click the Manual Installation button in the upper right corner and follow the instructions.

Installation from Unity Asset Store

1. Install the .NET 8 or later software for your operating system (Windows, MacOS, Linux).
2. Ensure your Unity version is 2021.3 or later.
3. Open the Charon plugin in the Unity Asset Store.
4. Click Add To My Assets.
5. Open the Unity Package Manager by navigating to Window → Package Manager.
6. Wait for the package manager to populate the list.
7. Select My Assets from the dropdown in the top left corner.
8. Select Charon from the list and click Download. If it’s already downloaded, you will see an Import option.

How to Use

• Working with the Plugin

Documentation

Charon Documentation • Unity Plugin Documentation

Examples

• Example Project
• Editor Extensions
  • CharonCli -> Bulk Create Documents
  • CharonCli -> Bulk Delete Documents
  • CharonCli -> Find Document
  • CharonCli -> Update Document
  • CharonCli -> Create Document
  • CharonCli -> Delete Document
  • CharonCli -> Delete Document By Id
  • CharonCli -> Export Documents
  • CharonCli -> List All Documents
  • CharonCli -> List Documents With Criteria
  • CharonCli -> Validating Game Data File
  • I18N -> List Translation Languages
  • I18N -> Export Localizable Data
  • I18N -> Add Translation Language
  • I18N -> Import Localizable Data
  • T4 -> Preprocess Template
  • T4 -> Run Text Template
  • T4 -> Run C# Code Template

Change Log

Change Log

Collaboration

Discord • Plugin Issues • [email protected]

License

MIT