Contents Menu Expand Light mode Dark mode Auto light/dark mode
NPC 2.0.2 documentation
NPC 2.0.2 documentation
  • Installing NPC
  • Campaigns
  • Character Files
  • NPC Cookbook
    • See Campaign Info
    • Create a Campaign
    • Open a Campaign
    • Check All Characters for Errors
    • Make a Listing of All Characters
    • Create a New Character
    • See Character Tag Stats
    • Reorganize Characters
    • Describe What’s Available
    • Open the Latest Planning Files
    • Create and Open the Next Planning Files
    • Open Settings Files

Customization

  • Core Configuration
  • Customizing Campaigns
  • Game System Anatomy
  • Changing Tags
  • Character Listings
  • GUI Settings

Reference

  • Settings Keys
  • Default Tags
    • @age
    • @appearance
    • @dead
    • @delist
    • @employer
    • @faketype
    • @foreign
    • @gender
    • @group
    • @hide
    • @lineage
    • @location
    • @name
    • @nolint
    • @org
    • @portrait
    • @pronouns
    • @race
    • @realname
    • @sticky
    • @title
    • @type
  • Deprecated Tags
    • @hidegroup
    • @hideranks
    • @keep
    • @skip
  • Reserved Tag Names
  • Game Systems
    • Dungeons & Dragons 3.5e
      • Caster
      • Martial
      • Supporting
    • Dungeons & Dragons 5e
      • Caster
      • Martial
      • Supporting
    • Fate Core
      • Main
      • Nameless
      • Supporting
    • Eclipse Phase: Transhumanity’s Fate
      • Main
      • Nameless
      • Supporting
    • Fate: Venture City
      • Main
      • Nameless
      • Supporting
    • Generic
      • Person
    • World of Darkness: Mind’s Eye Theatre
      • Geist
      • Ghoul
      • Mage
      • Mortal
      • Spirit
      • Vampire
      • Werewolf
    • New World of Darkness
      • Changeling
      • Fetch
      • Geist
      • Ghost
      • Ghoul
      • Goblin
      • Hunter
      • Mage
      • Mortal
      • Promethean
      • Sin-Eater
      • Spirit
      • Vampire
      • Werewolf
    • Pathfinder 1e
      • Caster
      • Martial
      • Supporting
    • World of Darkness
      • Geist
      • Ghoul
      • Mage
      • Mortal
      • Spirit
      • Vampire
      • Werewolf

NPC CLI

  • CLI Basics
  • CLI Quickstart
  • Commands
    • describe system
    • describe systems
    • describe tag
    • describe tags
    • describe type
    • describe types
    • info
    • init
    • latest
    • lint
    • list
    • new
    • reorg
    • report values
    • session
    • settings

NPC GUI

  • GUI Basics
  • GUI Quickstart
  • GUI Settings

NPC API

  • npc package
    • npc.campaign package
      • npc.campaign.reorganizers package
        • npc.campaign.reorganizers.base_reorganizer module
        • npc.campaign.reorganizers.character_reorganizer module
        • npc.campaign.reorganizers.relocation_class module
      • npc.campaign.subpath_components package
        • npc.campaign.subpath_components.base_component module
        • npc.campaign.subpath_components.conditional_value_component module
        • npc.campaign.subpath_components.first_value_component module
        • npc.campaign.subpath_components.match_value_component module
        • npc.campaign.subpath_components.static_value_component module
      • npc.campaign.campaign_class module
      • npc.campaign.character_collection module
      • npc.campaign.ops module
      • npc.campaign.pathfinder_class module
      • npc.campaign.stats_cache module
    • npc.characters package
      • npc.characters.writer package
        • npc.characters.writer.character_writer module
        • npc.characters.writer.con_tag_class module
        • npc.characters.writer.helpers module
        • npc.characters.writer.metatag_class module
      • npc.characters.character_class module
      • npc.characters.character_factory module
      • npc.characters.character_reader module
      • npc.characters.character_tagger module
      • npc.characters.tag_class module
      • npc.characters.taggable_interface module
    • npc.db package
      • npc.db.query_builders package
        • npc.db.query_builders.character_lister_query_builder module
      • npc.db.character_repository module
      • npc.db.custom_functions module
      • npc.db.database module
      • npc.db.tag_repository module
    • npc.linters package
      • npc.linters.character_linter module
      • npc.linters.tag_bucket module
    • npc.listers package
      • npc.listers.character_lister module
      • npc.listers.undefined_view module
    • npc.settings package
      • npc.settings.migrations package
        • npc.settings.migrations.migration_1to2 module
        • npc.settings.migrations.migration_message module
        • npc.settings.migrations.settings_migration module
        • npc.settings.migrations.settings_migrator_class module
      • npc.settings.systems package
        • npc.settings.systems.system_class module
      • npc.settings.tags package
        • npc.settings.tags.deprecated_tag_spec_class module
        • npc.settings.tags.make_deprecated_tag_specs module
        • npc.settings.tags.make_metatag_specs module
        • npc.settings.tags.make_tags module
        • npc.settings.tags.metatag_spec_class module
        • npc.settings.tags.subtag_spec_class module
        • npc.settings.tags.tag_spec_class module
      • npc.settings.types package
        • npc.settings.types.type_spec_class module
      • npc.settings.helpers module
      • npc.settings.planning_filename module
      • npc.settings.settings_class module
      • npc.settings.settings_writer module
      • npc.settings.tag_definer_interface module
    • npc.templates package
      • npc.templates.fallback_loader module
      • npc.templates.filters module
    • npc.util package
      • npc.util.data_store module
      • npc.util.env module
      • npc.util.errors module
      • npc.util.functions module
      • npc.util.legacy module
      • npc.util.persistent_cache module
      • npc.util.singleton module
      • npc.util.win_sanitize module
    • npc.validation package
      • npc.validation.errors package
        • npc.validation.errors.character_errors module
        • npc.validation.errors.settings_errors module
        • npc.validation.errors.tag_errors module
        • npc.validation.errors.validation_error module
      • npc.validation.character_validator module
      • npc.validation.settings_validator module
      • npc.validation.tag_validator module
    • npc.views package
      • npc.views.character_view module
      • npc.views.group_view module
      • npc.views.tag_view module
      • npc.views.tag_view_collection module
  • npc_cli package
    • npc_cli.commands package
      • npc_cli.commands.campaign_group module
      • npc_cli.commands.character_group module
      • npc_cli.commands.describe_group module
      • npc_cli.commands.main_group module
      • npc_cli.commands.reports_group module
    • npc_cli.errors module
    • npc_cli.helpers module
    • npc_cli.presenters module
  • npc_gui package
    • npc_gui.models package
      • npc_gui.models.abstract_tree package
        • npc_gui.models.abstract_tree.tree_item module
        • npc_gui.models.abstract_tree.tree_model module
      • npc_gui.models.tag_tree package
        • npc_gui.models.tag_tree.tag_tree_header_item module
        • npc_gui.models.tag_tree.tag_tree_item module
        • npc_gui.models.tag_tree.tag_tree_model module
      • npc_gui.models.character_types_model module
      • npc_gui.models.characters_table_model module
      • npc_gui.models.system_list_model module
      • npc_gui.models.tag_name_items_model module
    • npc_gui.util package
      • npc_gui.util.recent_campaigns module
    • npc_gui.widgets package
      • npc_gui.widgets.action_button module
      • npc_gui.widgets.debounce_line_edit module
      • npc_gui.widgets.loading_bar module
      • npc_gui.widgets.resource_table module
      • npc_gui.widgets.size_policies module
      • npc_gui.widgets.tag_edit module
      • npc_gui.widgets.tag_tree_view module
    • npc_gui.windows package
      • npc_gui.windows.main_window module
      • npc_gui.windows.new_campaign_dialog module
      • npc_gui.windows.new_character_dialog module
      • npc_gui.windows.no_campaign_dialog module
      • npc_gui.windows.post_migration_dialog module
      • npc_gui.windows.settings_migration_prompt module
      • npc_gui.windows.settings_outdated_dialog module
    • npc_gui.application module
    • npc_gui.helpers module
    • npc_gui.resources module
    • npc_gui.runner module
Back to top
Edit this page

npc.util package#

Submodules#

  • npc.util.data_store module
  • npc.util.env module
  • npc.util.errors module
  • npc.util.functions module
  • npc.util.legacy module
  • npc.util.persistent_cache module
  • npc.util.singleton module
  • npc.util.win_sanitize module
Next
npc.util.data_store module
Previous
npc.templates.filters module
Copyright © 2024, Paige Andrews
Made with Sphinx and @pradyunsg's Furo
On this page
  • npc.util package
    • Submodules