A character visually represented in the character's nameplate. This module provides a data structure and callbacks to retrieve character information. The logic for retrieving character data is split between a base module and a data module.

Configuration

Both modules are configurable using the application's configuration:

config :dev_joy, DevJoy.Character,
  base_module: MyApp.BaseModule,
  data_module: MyApp.DataModule

Base module usage

The base module is responsible for providing the data to visually represent character. The full name and portrait provide the minimum data to visually represent the character.

defmodule MyApp.BaseModule do
  def get_character_fields(:john_doe) do
    [full_name: "John Doe", portrait: "path/to/portrait.jpg"]
  end
end

All fields are optional. If you don't specify a value for a full name, it will be generated automatically by humanising the value of the id field. For example with :john_doe id John Doe would be generated as a full name.

Data module usage

The data module is responsible for providing additional character data. Such data is usually not visible in the game, but can influence it. This is especially useful in combination with condition and additional game state data stored in a database or other type of storage.

defmodule MyApp.DataModule do
  def get_character_data(:john_doe) do
    [level: :senior]
  end
end