Module: Card::Mod

Defined in:
lib/card/mod.rb,
lib/card/mod/dirs.rb,
lib/card/mod/loader.rb,
lib/card/mod/load_strategy.rb,
lib/card/mod/module_template.rb,
lib/card/mod/loader/set_loader.rb,
lib/card/mod/load_strategy/eval.rb,
lib/card/mod/load_strategy/tmp_files.rb,
lib/card/mod/loader/set_pattern_loader.rb,
lib/card/mod/load_strategy/set_tmp_files.rb,
lib/card/mod/load_strategy/pattern_tmp_files.rb,
lib/card/mod/load_strategy/set_binding_magic.rb

Overview

A Card Mod (short for "module" or "modification") is a discrete piece of Decko functionality. Mods are how the Decko community develops and shares code. If you want to customize a deck in a way that can't be done on the site itself, try a mod.

The simplest way to add a mod is in the mod directory of your deck, eg:

DECKNAME/mod/MODNAME

In most mods, the focal point is the set modules.

Set Modules

Set modules define methods for a given set of cards and their format objects. They are defined in a mod's set directory. For example, suppose you've created a mod that called biz, your deck has Company cards, and you want to extend the behavior of those cards.

You can add a set module like so:

  card generate set biz type company

This will create the following two files:

  mod/biz/set/type/company.rb
  mod/biz/spec/set/type/company.rb

If you would like to break this code into smaller files, you can extend this pattern into another directory, eg:

  mod/biz/set/type/company/foo.rb
  mod/biz/set/type/company/bar.rb

The general pattern can be expressed as follows:

  DECKNAME/mod/MODNAME/set/SET_PATTERN/ANCHOR[/FREENAME].rb

Learn more:

  • Card introduces card objects
  • Set provides an overview of how set modules work
  • Format explains the basics of the view API
  • Set::Event explains the basics of the event API

Other Directories

Other ways your mod can extend Decko functionality include:

  • set_pattern for additional set patterns, or types of sets.
  • format for creating new formats
  • chunk provides tools for finding new patterns in card content
  • layouts can contain hardcoded layouts (layouts are more typically stored in content)
  • lib for ruby libraries
  • file for any other supporting files

Defined Under Namespace

Classes: BindingMagic, Dirs, LoadStrategy, Loader, ModuleTemplate

Class Method Summary collapse

Class Method Details

.dirs ⇒ Object

Returns an array of Rails::Path objects.

Returns:

  • an array of Rails::Path objects



59
60
61
 
# File 'lib/card/mod.rb', line 59

def dirs
  @dirs ||= Dirs.new(Card.paths["mod"].existent)
end

.load ⇒ Object 



54
55
56
 
# File 'lib/card/mod.rb', line 54

def load
  Loader.load_mods
end