Generate a basic Squib project layout.
While Squib is just a Ruby library that can be used in all kinds of ways, there a bunch of tried-and-true techniques on how to use it. To make this process easier, we provide some built-in project starter kits.
The default run will generate a “basic” layout:
$ squib new arctic-lemming
This kit includes the following:
deck.rbis your main source code file
config.ymlis the default config file for all runs of Squib
layout.ymlis a basic layout file
Rakefilehas a basic
raketask (if you’re familiar with that - it’s not necessary).
- Git files, such as
gitkeep.txt. These are helpful because every coding project should use version control.
- Markdown files, e.g.
ABOUT.md, to write notes in and organize your ideas.
You can see the basic files here on GitHub
If you run with the
--advanced flag, you get a lot more stuff:
$ squib new --advanced arctic-lemming
In particular, the
--advanced run will all run through Ruby’s
rake command. You will no longer be able to run your ruby scripts directly with
ruby deck.rb, instead you’ll need to do
rake. See The Squib Way pt 3: Workflows for a walkthrough.
Addtionally, everything else is broken out into directories.
- We assume you will have a LOT of images, so there’s a separate image directory configured
- A default Excel sheet is included, in its own data
Rakefileis much more advanced, taking advantage of build groups and various other things
- Assume one layout file per deck
- Separate the game documents (e.g.
RULES.md) from the project documents (e.g.
- We also include a
Guardfileso you can auto-build your code as you are writing it.
- We include a version file so you can track the version of your code and print that on all of your cards. It’s a good idea to have this in its own file.
- The default
deck.rbdemonstrates some more advanced features of Squib
You can see the advanced project kit files here on GitHub