Browse Source

docs: messing around with guides

[skip ci]
dev
Andy Meneely 9 years ago
parent
commit
c454bf43a4
  1. 16
      docs/guides/getting-started/part_2_iconography.rst
  2. 10
      docs/guides/getting-started/part_3_workflows.rst
  3. 18
      docs/guides/getting-started/part_4_leveraging_ruby.rst
  4. 3
      docs/guides/git.rst

16
docs/guides/getting-started/part_2_iconography.rst

@ -59,7 +59,7 @@ Back to the Example: Drones vs. Humans
Ok, let's go back to our running example, project ``arctic-lemming`` from Part 1. We created cards for playtesting, but we never put down the faction for each card. That's a good candidate for an icon. Ok, let's go back to our running example, project ``arctic-lemming`` from Part 1. We created cards for playtesting, but we never put down the faction for each card. That's a good candidate for an icon.
Let's get some stock icons for this exercise. For this example, I went to http://game-icons.net. I set my foreground color to black, and background to white. I then downloaded "auto-repair.svg" and "backup.svg". I'm choosing not to rename the files so that I can find them again on the website if I need to. (If you want to know how to do this process DIRECTLY from Ruby, and not going to the website, check out my *other* Ruby gem called `game_icons <https://github.com/andymeneely/game_icons>`_ - it's tailor-made for Squib!) Let's get some stock icons for this exercise. For this example, I went to http://game-icons.net. I set my foreground color to black, and background to white. I then downloaded "auto-repair.svg" and "backup.svg". I'm choosing not to rename the files so that I can find them again on the website if I need to. (If you want to know how to do this process DIRECTLY from Ruby, and not going to the website, check out my *other* Ruby gem called `game_icons <https://github.com/andymeneely/game_icons>`_ - it's tailor-made for Squib!)
When we were brainstorming our game, we placed one category of icons in a single column ("faction"). Presumably, one would want the faction icon to be in the same place on every card, but a different icon depending on the card's faction. There are a couple of ways of accomplishing this in Squib. First, here some less-than-clean ways of doing it:: When we were brainstorming our game, we placed one category of icons in a single column ("faction"). Presumably, one would want the faction icon to be in the same place on every card, but a different icon depending on the card's faction. There are a couple of ways of accomplishing this in Squib. First, here some less-than-clean ways of doing it::
@ -115,7 +115,7 @@ At this point, we've got a very scalable design for our future iterations. Let's
Why Ruby+YAML+Spreadsheets Works Why Ruby+YAML+Spreadsheets Works
-------------------------------- --------------------------------
In software design, a "good" design is one where the problem is broken down into a set of easier duties that each make sense on their own, where the interaction between duties is easy, and where to place new responsbilities is obvious. In software design, a "good" design is one where the problem is broken down into a set of easier duties that each make sense on their own, where the interaction between duties is easy, and where to place new responsibilities is obvious.
In Squib, we're using automation to assist the prototyping process. This means that we're going to have a bunch of decisions and responsibilities, such as: In Squib, we're using automation to assist the prototyping process. This means that we're going to have a bunch of decisions and responsibilities, such as:
@ -144,9 +144,21 @@ Icons for Some, But Not All, Cards
to be written to be written
Method 1: Ruby Array#map
------------------------
Method 2: Use Layouts
---------------------
Methods 3: Use range
One Column per Icon One Column per Icon
------------------- -------------------
.. note:: .. note::
to be written to be written
Don't Forget Unicode Icons
--------------------------

10
docs/guides/getting-started/part_3_workflows.rst

@ -1,4 +1,12 @@
The Squib Way pt 3: Workflows The Squib Way pt 3: Workflows
=============================== ===============================
To be written. .. warning::
To be written.
* Build groups: color vs. black-and-white
* Splitting out decks into different files
* Setting up rake tasks
* Switch from built-in layouts to your own layout
* Launch what you need with Launchy

18
docs/guides/getting-started/part_4_leveraging_ruby.rst

@ -0,0 +1,18 @@
The Squib Way pt 4: Leveraging Ruby
===================================
.. warning::
To be written.
This part is about cataloging some powerful things you can do if you're willing to write some Ruby.
* Modifying XML at runtime (e.g. convert to black-and-white from color)
* Using Travis to build and then post to something like Dropbox
* Scaling the size of text based on its contents
* Advanced Array techniques: inject, transpose, map, join (use the pre-req example)
* Building newlines yourself (i.e. with your own placeholder like "%n" in Your Last Heist)
* Summarization card backs for Your Last Heist as an example
* "Lacks" string for Your Last Heist
* Rules doc written in Markdown

3
docs/guides/git.rst

@ -1,12 +1,13 @@
Squib + Git Squib + Git
=========== ===========
.. note:: .. warning::
To be written To be written
Ideas: Ideas:
* .gitignore
* Workflow * Workflow
* Tracking binary data (show json method) * Tracking binary data (show json method)
* Snippet about "what's changed" * Snippet about "what's changed"

Loading…
Cancel
Save