Skip to content
Ketei edited this page Jun 27, 2026 · 12 revisions

Overview

Nexus Forge is a modular toolset designed to create and handle the creation and processing of data (dialogues, characters, items, etc.) through easy-to-use interfaces and remain UI-agnostic in-game by making use of built-in and custom signals.

Dialogues

  • Create dialogues with a graph-based easy-to-use visual interface.
  • Create complex dialogues with a large range of nodes, such as choices, random & conditional paths and complex events that set variables (Blackboard), call methods and emit signals.
  • Create dynamic text by making use of the custom parser. Select random strings out of a group, get a variable and display it as a string or call a method to obtain it. There are many possibilities.
  • Use context-aware strings that changed based on available data.
  • Create localized dialogues and preview it using the built-in previewer or provide your own
  • Set up live-preview of your dialogue for the localization window.

Global Data

  • Manage globally-accessible data via the Blackboard.
  • Structured in a folder-like system.

This module is also used to format strings on other modules.

Characters

  • Create detailed character sheets
  • Character sheets can contain basic data such as a name and gender, or complex data such as a species, stats, skills, traits and custom data.
  • Depending on settings, you'll be able to access your characters directly, no need to register them first in the singleton.

Species

  • Create species and subspecies with unique names, descriptions and custom stats.
  • Create unique species using the hybridization system
  • Using the genetic inheritance system, your species can obtain the stats of their ancestors perfectly or partially.

Stats/Skills/Traits

  • Define basic data for your stats, skills and traits
  • Customise them further by adding custom data to each.

Items

  • Create items and basic and nested item categories.
  • Set basic and custom data to each item. Flags are supported too.
  • Define the value of each item.

Currencies

  • Create custom currencies and assign them each a value to create a multi-currency economy (DnD inspired).
  • Quickly calculate currencies and do operations using provided methods and objects.

Recipes

  • Create crafting recipes for your items. Set custom data of each recipe too.
  • Make the recipes as simple or as complex as needed, each ingredient supporting custom data.

Quests

  • Create complex quests containing stages and objectives.
  • Let the plugin keep track of (Log) which quests have been done and if they were successful.
  • Let the quest manager progress the quest automatically for you.
  • Custom events for when a quest is successful or failed. As well as branching based on the result.

Context-Formatting Strings

  • Context-aware strings that change based on data available to it.

Access and Documentation

All modules can be accessed via the NexusForge autoload singleton (NFPluginGameHandler class).

The plugin is fully documented. Enabling the use of the offline documentation (F1) within the editor to search for technical documentation for almost all custom classes and resources provided.


Reserved Class Names

Nexus Forge registers several custom classes globally. Before importing the plugin, ensure your project does not already use the following class names to avoid conflicts.

Class Name Type Path
ArrayUtils RefCounted res://addons/nexus_forge/classes/utils/array_utils.gd
ArrayUtils RefCounted res://addons/nexus_forge/classes/utils/array_utils.gd
BitFlags Resource res://addons/nexus_forge/resources/bit_flags.gd
BitUtils RefCounted res://addons/nexus_forge/classes/utils/bit_utils.gd
BlackboardData Resource res://addons/nexus_forge/resources/blackboard_storage.gd
Cache RefCounted res://addons/nexus_forge/resources/cache/cache_system.gd
CacheLink RefCounted res://addons/nexus_forge/resources/cache/cache_item.gd
CharacterSheet Resource res://addons/nexus_forge/resources/character_sheet.gd
CurrencyCatalog Resource res://addons/nexus_forge/resources/currency_catalog.gd
CurrencyWallet Resource res://addons/nexus_forge/resources/currency_bag.gd
DialogParser RefCounted res://addons/nexus_forge/resources/parser/discourse_parser_base.gd
DictUtils RefCounted res://addons/nexus_forge/classes/utils/dict_utils.gd
DiscourseAPI RefCounted res://addons/nexus_forge/resources/parser/discourse_api.gd
DiscourseDialog Resource res://addons/nexus_forge/resources/dialog_storage/dialog_storage_base.gd
DiscourseDialogLocale Resource res://addons/nexus_forge/resources/dialog_storage/dialog_locale.gd
DiscourseGraphAnchorPointer DiscourseGraphNode res://addons/nexus_forge/discourse/nodes/jump_to_node.gd
DiscourseGraphNode GraphNode res://addons/nexus_forge/discourse/nodes/base.gd
EditorDialogParser DialogParser res://addons/nexus_forge/resources/parser/discourse_parser_editor.gd
EditorDiscourseDialog DiscourseDialog res://addons/nexus_forge/resources/dialog_storage/dialog_storage_editor.gd
EditorItemRecipeLink RefCounted res://addons/nexus_forge/item_recipe_link.gd
IDTree Tree res://addons/nexus_forge/classes/tree_id_script.gd
ItemCatalog Resource res://addons/nexus_forge/resources/item_catalog.gd
ItemSheet Resource res://addons/nexus_forge/resources/item_sheet.gd
Math RefCounted res://addons/nexus_forge/classes/utils/math.gd
ModDiscourseDialog DiscourseDialog res://addons/nexus_forge/resources/dialog_storage/dialog_storage_mod.gd
NFCatalogEntry RefCounted res://addons/nexus_forge/resources/catalog_entry.gd
NFCatalogEntryStat NFCatalogEntry res://addons/nexus_forge/resources/stat_catalog_entry.gd
NFCharacterManager RefCounted res://addons/nexus_forge/resources/managers/character_manager.gd
NFCurrencyEntry RefCounted res://addons/nexus_forge/resources/currency_entry.gd
NFCurrencyManager RefCounted res://addons/nexus_forge/resources/managers/currency_manager.gd
NFItemManager RefCounted res://addons/nexus_forge/resources/managers/item_manager.gd
NFPluginGameHandler Node res://addons/nexus_forge/classes/autoload/nexus_forge_singleton.gd
NFQuestLog RefCounted res://addons/nexus_forge/resources/quest_logger.gd
NFRecipeManager RefCounted res://addons/nexus_forge/resources/managers/recipe_manager.gd
NFSkillManager RefCounted res://addons/nexus_forge/resources/managers/skill_manager.gd
NFSpeciesManager RefCounted res://addons/nexus_forge/resources/managers/species_manager.gd
NFSpeciesStatCatalog Resource res://addons/nexus_forge/species/species_stat_entry.gd
NFStatManager RefCounted res://addons/nexus_forge/resources/managers/stat_manager.gd
NFTraitManager RefCounted res://addons/nexus_forge/resources/managers/trait_manager.gd
ParsedDialog RefCounted res://addons/nexus_forge/resources/dialog_storage/parsed_dialog.gd
PhraseAPI RefCounted res://addons/nexus_forge/resources/localization/phrase_api.gd
PhraseMap Resource res://addons/nexus_forge/resources/localization/phrase_map.gd
Quest Resource res://addons/nexus_forge/resources/quest_resource.gd
QuestManager RefCounted res://addons/nexus_forge/resources/managers/quest_manager.gd
QuestObjective Resource res://addons/nexus_forge/resources/quest_objective.gd
QuestStage Resource res://addons/nexus_forge/resources/quest_stage.gd
RandomWeightedPool RefCounted res://addons/nexus_forge/classes/utils/random_weight_pool.gd
RangeFloat ValueRange res://addons/nexus_forge/resources/range_float.gd
RangeInt ValueRange res://addons/nexus_forge/resources/range_integer.gd
RangeUtils RefCounted res://addons/nexus_forge/classes/utils/ranges.gd
RecipeCatalog Resource res://addons/nexus_forge/resources/recipe_catalog.gd
RecipeItem Resource res://addons/nexus_forge/resources/recipe_item.gd
RecipeSheet Resource res://addons/nexus_forge/resources/recipe_sheet.gd
ResourceCache Cache res://addons/nexus_forge/resources/cache/resource_cache.gd
SkillCatalog Resource res://addons/nexus_forge/resources/skill_catalog.gd
SkillSet Resource res://addons/nexus_forge/resources/skill_set.gd
SpeciesCatalog Resource res://addons/nexus_forge/resources/species_catalog.gd
SpeciesSheet Resource res://addons/nexus_forge/resources/species.gd
StatBlock Resource res://addons/nexus_forge/resources/stat_block.gd
StatCatalog Resource res://addons/nexus_forge/resources/stat_catalog.gd
StringUtils RefCounted res://addons/nexus_forge/classes/utils/strings.gd
TraitBlock Resource res://addons/nexus_forge/resources/trait_block.gd
TraitCatalog Resource res://addons/nexus_forge/resources/trait_catalog.gd
UUID Resource res://addons/nexus_forge/classes/utils/uuid.gd
ValueRange Resource res://addons/nexus_forge/resources/value_range.gd

Clone this wiki locally