Squib Documentation

Welcome to the official Squib documentation!

Contents:

• Install & Update
  • Pre-requisites
  • Typical Install
  • Updating Squib
  • OS-Specific Quirks
• Learning Squib
  • Hello, World! Dissected
    • Dissection of “Even Bigger…”
  • The Squib Way pt 0: Learning Ruby
    • Not a Programmer?
    • What You DON’T Need To Know about Ruby for Squib
    • What You Need to Know about Ruby for Squib
    • Find a good text editor
    • Command line basics
    • Edit-Run-Check.
    • Plan to Fail
    • Ruby Learning Resources
  • The Squib Way pt 1: Zero to Game
    • Prototyping with Squib
    • Get Installed and Set Up
    • Our Idea: Familiar Fights
    • Running Your Squib Build
    • Data or Layout?
    • Initial Card Layout
    • Multiple Cards
    • To the table!
    • Next up…
  • The Squib Way pt 2: Iconography
    • Art: Graphic Design vs. Illustration
    • Iconography in Popular Games
    • How Squib Supports Iconography
    • Back to the Example: Drones vs. Humans
    • Why Ruby+YAML+Spreadsheets Works
    • Illustration: One per Card
    • Learn by Example
    • Are We Done?
  • The Squib Way pt 3: Workflows
    • Organizing Your Project
    • Rakefile: Your Project’s Butler
    • Ideas to be written up
  • The Squib Way pt 4: Ruby Power!
  • Squib in Action
    • My Projects
    • Open Source Projects using Squib
    • Other Projects Using Squib
    • Want yours here?
  • Squib + Game-Icons.net
    • Install the Gem
    • Find Your Icon
    • Use the SVG File
    • Recolor the SVG file
    • Use the SVG XML Data
    • Path Weirdness
  • Squib + Git
  • Autobuild with Guard
    • Project layout
    • Using Guard + Rake
• Parameters are Optional
• Squib Thinks in Arrays
  • Using range to specify cards
  • Behold! The Power of Ruby Arrays
  • Examples
  • Contribute Recipes!
• Layouts are Squib’s Best Feature
  • Order of Precedence for Options
  • When Layouts Are Similar, Use extends
  • Yes, extends is Multi-Generational
  • Yes, extends has Multiple Inheritance
  • Multiple Layout Files get Merged
  • Squib Comes with Built-In Layouts
    • fantasy.yml
    • economy.yml
    • tuck_box.yml
    • hand.yml
    • party.yml
    • playing_card.yml
  • See Layouts in Action
• Be Data-Driven with XLSX and CSV
  • Squib::DataFrame, or a Hash of Arrays
  • Quantity Explosion
• Unit Conversion
  • Cells
  • Samples
    • _units.rb
    • _cells.rb
• XYWH Shorthands
  • Samples
    • _shorthands.rb
• Specifying Colors & Gradients
  • Colors
    • by hex-string
    • by name
    • by custom name
  • Gradients
  • Samples
    • Sample: colors and color constants
    • Sample: gradients
    • Sample: Switch color based on variable
• The Mighty text Method
  • Fonts
  • Width and Height
  • Autoscaling Font Size
  • Hints
  • Extents
  • Embedding Images
  • Markup
  • Samples
    • Sample: _text.rb
    • Sample: text_options.rb
    • Sample: embed_text.rb
    • Sample: config_text_markup.rb
    • Sample: _autoscale_font.rb
• Always Have Bleed
  • Summary
  • What is a bleed?
  • Usage
  • Example
  • Templates
• Configuration Options
  • Options are available as methods
  • Set options programmatically
  • Making Squib Verbose
• Vector vs. Raster Backends
• Group Your Builds
• Sprue Thy Sheets
  • Using a Sprue
  • Make Your Own Sprue
  • Sprue Format
    • Top-Level parameters
    • cards
    • crop_line
  • List of Built-in Sprues
    • a4_euro_card.yml
    • a4_poker_card_8up.yml
    • a4_usa_card.yml
    • letter_poker_card_9up.yml
    • letter_poker_foldable_8up.yml
    • printplaygames_18up.yml
    • drivethrucards_1up.yml
• Get Help and Give Help
  • Show Your Pride
  • Get Help
  • Help by Troubleshooting
  • Help by Beta Testing
    • Beta: Using Pre-Builds
    • Beta: About versions
    • Beta: About Bundler+RubyGems
  • Make a Sprue!
  • Make a Layout!
  • Help by Fixing Bugs
  • Help by Contributing Code
• CLI Reference
  • squib make_sprue
  • squib new
    • Basic
    • --advanced
• DSL Reference
  • Squib::Deck.new
    • Options
    • Examples
  • background
    • Options
    • Examples
  • build
    • Required Arguments
    • Examples
  • build_groups
    • Arguments
    • Examples
  • circle
    • Options
    • Examples
  • cm
    • Parameters
    • Examples
  • Squib.configure
    • Options
    • Exmaples
  • csv
    • Options
    • Individual Pre-processing
    • Examples
  • curve
    • Options
    • Examples
  • cut_zone
    • Options
    • Examples
  • Squib::DataFrame
    • columns become methods
    • #columns
    • #ncolumns
    • #col?(name)
    • #row(i)
    • #nrows
    • #to_json
    • #to_pretty_json
    • #to_pretty_text
  • disable_build
    • Required Arguments
    • Examples
  • disable_build_globally
    • Required Arguments
    • Examples
  • ellipse
    • Options
    • Examples
  • enable_build
    • Required Arguments
    • Examples
  • disable_build_globally
    • Required Arguments
    • Examples
  • grid
    • Options
    • Examples
  • hand
    • Options
    • Examples
  • hint
    • Options
    • Examples
  • inches
    • Parameters
    • Examples
  • line
    • Options
    • Examples
  • mm
    • Parameters
    • Examples
  • png
    • Options
    • Examples
  • polygon
    • Options
    • Examples
  • print_system_fonts
    • Options
    • Examples
  • rect
    • Options
    • Examples
  • safe_zone
    • Options
    • Examples
  • save
    • Options
    • Examples
  • save_pdf
    • Options
    • Examples
  • save_png
    • Options
    • Drop Shadow
    • Examples
  • save_sheet
    • Options
    • Examples
  • showcase
    • Options
    • Examples
  • star
    • Options
    • Examples
  • svg
    • Options
    • Examples
  • system_fonts
    • Options
    • Examples
  • text
    • Options
    • Markup
    • Embedded Icons
    • Examples
  • triangle
    • Options
    • Examples
  • use_layout
    • Options
    • Examples
  • xlsx
    • Options
    • Individual Pre-processing
    • Examples
  • yaml
    • Options
    • Individual Pre-processing
    • Examples

Indices and tables

• Index
• Search Page