StrataGen/help.html at master · mzsilak/StrataGen · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
    <meta name="description" content="">
    <meta name="author" content="">

    <link href="https://fonts.googleapis.com/css2?family=PT+Serif&family=Teko:wght@600&display=swap" rel="stylesheet">

    <!-- Bootstrap CSS -->
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">

    <link rel="stylesheet" href="./css/stratagen.css">

    <title>StrataGen</title>

    <script src="https://kit.fontawesome.com/324895d590.js" crossorigin="anonymous"></script>
</head>

<body>
    <nav class="navbar navbar-expand-md navbar-light bg-light justify-content-between">
        <a href="index.html"><span class="navbar-brand">StrataGen</span></a>
        <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#collapsibleNavbarHelp"
            aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
            <span class="navbar-toggler-icon"></span>
        </button>
        <div class="collapse navbar-collapse" id="collapsibleNavbarHelp">
            <ul class="navbar-nav ml-auto">
                <li class="nav-item active">
                    <a class="nav-link" href="help.html">Help</a>
                </li>
                <li class="nav-item">
                    <a class="nav-link" href="about.html">About</a>
                </li>
            </ul>
        </div>
    </nav>

    <div class="container">
        <div class="col-md-12">
            <h2>Overview</h2>
            <p>
                StrataGen provides a tool for creating reasonably nice look data cards for Warhammer 40k.  The cards may be saved
                image files and printed however you see fit.
            </p>
            <h2>Single Card</h2>
            <p>
                StrataGen allows the creation of a single data card by simply filling in the Card Details form and pressing the
                Create button.
            </p>
            <h2>Batch Mode</h2>
            <p>
                StrataGen can also create a set of cards from a specially formatted text file.   This text file contains a list of
                tab (*.tsv) or comma (*.csv) separated fields describing the cards to be created.  StrataGen expects each line in
                file to begin with a field describing the card type to create.   The card type field must be one of the following:
                <ul>
                    <li>STRATAGEM</li>
                    <li>PSYCHIC POWER</li>
                    <li>PRAYER</li>
                    <li>TACTICAL OBJECT</li>
                </ul>
                The fields following the card type are dependent on the type of card specified as shown below:
                <table class="table table-bordered">
                    <thead>
                        <tr>
                            <th scope="col">Card Type</th>
                            <th scope="col">Card Style</th>
                            <th scope="col">Field 2</th>
                            <th scope="col">Field 3</th>
                            <th scope="col">Field 4</th>
                            <th scope="col">Field 5</th>
                            <th scope="col">Field 6</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr>
                            <td>STRATAGEM</td>
                            <td>CLASSIC or 9TH</td>
                            <td>Command points (number)</td>
                            <td>Stratagem name</td>
                            <td>Card header</td>
                            <td>Stratagem fluff description</td>
                            <td>Stratagem rule text</td>
                        </tr>
                        <tr>
                            <td>PSYCHIC POWER</td>
                            <td>CLASSIC or 9TH</td>
                            <td>Warp charge (number)</td>
                            <td>Power name</td>
                            <td>Card header</td>
                            <td>Power fluff description</td>
                            <td>Power rule text</td>
                        </tr>
                        <tr>
                            <td>TACTICAL OBJECTIVE</td>
                            <td>CLASSIC or 9TH</td>
                            <td>Id number (number)</td>
                            <td>Objective name</td>
                            <td>Card header</td>
                            <td>Objective fluff description</td>
                            <td>Objective rule text</td>
                        </tr>
                        <tr>
                            <td>PRAYER</td>
                            <td>CLASSIC or 9TH</td>
                            <td>Prayer name</td>
                            <td>Card header</td>
                            <td>Prayer fluff description</td>
                            <td>Prayer rule text</td>
                            <td>--Empty--</td>
                        </tr>
                    </tbody>
                </table>
                It is recommended to use tab-separated fields to permit the fluff and rule text to contain commas.
            </p>
            <h4>Example Input For Batch Mode</h4>
            <p>
                <pre><code>
STRATAGEM,CLASSIC,2,Insane Bravery,Stratagem,This unit is not impressed.,Automatically pass morale for a single unit.
PSYCHIC POWER,9TH,7,Magic Missile,Psychic Power,Bolts of energy erupt from...,Magic Missile has a warp charge of 7. The nearest unit takes D3 wounds.
PRAYER,CLASSIC,Mantra of Fail,Litanies of Fun,The Chaplain focuses his mind and fails.,If this litany is inspiring nothing happens.
                </code></pre>
            </p>
        </div>
        <div class="col-md-12">
            <h2>Usage</h2>
            <h3>Create Single Card</h3>
            <p>
                Select the card type and fill in the form as desired.   The fluff text is optional.   The Preview image
                updates as the form is filled in.   Press the Create button save the card as a png file.
            </p>
        </div>
        <div class="col-md-12">
            <h3>Batch Create</h3>
            <p>
                Use the file selector control to load a data card input file.   Use the Previous and Next Card buttons to
                view each of the cards loaded.  Cards must be saved as image files one a time using the Create button.
            </p>
        </div>
        <div class="col-md-12">
            <h3>Saving and Loading Current Card</h3>
            <p>
                The currently displayed card may be saved in the browser and restored for later.  Press the Save
                button to save the current card and the Load button to restore the card later on.
            </p>
        </div>
        <div class="col-md-12">
            <h2>Bugs</h2>
            <p>
                Bugs, suggestions and enhancements can all be posted on the
                <a href="https://github.com/rweyrauch/StrataGen/issues">StrataGen GitHub</a> website.
            </p>
        </div>
    </div>

    <script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
    <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>

</body>

</html>