View Source ExTTRPGDev.Globals (ExTTRPGDev v0.4.0)

Module which defines globals like project paths

Summary

Functions

The regex pattern for identifying json files

The name for license files

The path to where custom rule system configs are stored

The path to where the project lives on your machine

The path to where system configs are stored

Functions

json_file_pattern()

The regex pattern for identifying json files

Examples

iex> ExTTRPGDev.Globals.json_file_name() ~r/.+.json$/

license_file_name()

The name for license files

Examples

iex> ExTTRPGDev.Globals.license_file_name() "license.md"

local_system_configs_path()

The path to where custom rule system configs are stored

Examples

iex> ExTTRPGDev.Globals.local_system_configs_path()
"/full/path/to/project/ex_ttrpg_dev/local_system_configs"

project_root()

The path to where the project lives on your machine

Examples

iex> ExTTRPGDev.Globals.project_root()
"/full/path/to/project/ex_ttrpg_dev"

system_configs_path()

The path to where system configs are stored

Examples

iex> ExTTRPGDev.Globals.system_configs_path()
"/full/path/to/project/ex_ttrpg_dev/system_configs"