-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocs.html
389 lines (325 loc) · 14.3 KB
/
docs.html
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
<!--
Documentation page
Anthony Wilson
-->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Docs</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="color-scheme" content="light dark">
<link rel="stylesheet" type="text/css" href="./global-styles.css">
<link rel="stylesheet" type="text/css" href="./input-styles.css">
<link rel="stylesheet" type="text/css" href="./specific-styles.css">
<meta name="author" content="Anthony Wilson">
<meta name="description" content="Documentation for Nomic Season 4">
<link rel="icon" type="image/png" href="./Resources/Favicon128x128.png" sizes="128x128">
<meta property="og:title" content="Nomic Season 4">
<meta property="og:type" content="website">
<meta property="og:url" content="https://AnthonyW2.github.io/Nomic/docs.html">
<meta property="og:image" content="./Resources/OGImage.png">
<meta property="og:image:type" content="image/png">
<meta property="og:image:width" content="256">
<meta property="og:image:height" content="256">
<meta property="og:description" content="Documentation for Nomic Season 4">
</head>
<body onload="StartJS()">
<!-- Navigation Bar -->
<div id="nav-bar">
<a id="nav-link-site-logo" class="nav-link" href="./">BS Nomic</a>
<a id="nav-link-rules" class="nav-link" href="./Rules">Rules</a>
<a id="nav-link-players" class="nav-link" href="./Players">Players</a>
<a id="nav-link-docs" class="nav-link" href="./docs.html">
<span id="nav-link-docs-text-1">Documentation</span>
<span id="nav-link-docs-text-2">Docs</span>
</a>
<a id="nav-link-propositions" class="nav-link" href="./Propositions">
<span id="nav-link-propositions-text-1">Propositions</span>
<span id="nav-link-propositions-text-2">Props</span>
</a>
<!--a id="nav-link-world" class="nav-link" href="./World">World</a-->
<input type="text" id="nav-search" placeholder="Search" title="Search for something" onfocus="openSearchMenu()" onfocusout="closeSearchMenu()" onkeyup="updateSearch()">
<div id="search-menu" hidden></div>
<button id="nav-menu-btn" title="Open/Close the overflow menu" onclick="toggleOverflowMenu()" menuopen="false">
<div id="nav-menu-btn-icon">
<div id="nav-menu-btn-icon-bar-1" class="nav-menu-btn-icon-bar"></div>
<div id="nav-menu-btn-icon-bar-2" class="nav-menu-btn-icon-bar"></div>
<div id="nav-menu-btn-icon-bar-3" class="nav-menu-btn-icon-bar"></div>
</div>
</button>
</div>
<!-- Overflow Menu -->
<div id="overflow-menu" hidden>
<div id="settings-color-theme-title" class="overflow-menu-subtitle">Colour Theme:</div>
<select id="settings-color-theme-select" onchange="updateColorTheme()"></select>
<div id="settings-font-theme-title" class="overflow-menu-subtitle">Font Theme:</div>
<select id="settings-font-theme-select" onchange="updateFontTheme()">
<option value="0">Default</option>
<option value="1">Serif</option>
<option value="2">Sans-Serif</option>
<option value="3">Comic Sans</option>
</select>
<!--<a id="settings-link-leave-feedback" class="settings-menu-subtitle inherit-color" href="">Leave Feedback</a>-->
<!--<a id="settings-link-docs" class="settings-menu-subtitle inherit-color" href="">Documentation</a>-->
<!--<a id="settings-link-about" class="settings-menu-subtitle inherit-color" href="">About</a>-->
</div>
<div id="dimmer" onclick="toggleOverflowMenu()" hidden></div>
<!-- Page Content -->
<div class="page-content-container">
<h1>Documentation</h1>
<!--span>Nomic Automation System</span-->
<h3>Table of Contents</h3>
<ul>
<li><a href="#website">Website</a></li>
<li><a href="#nomic-bot">Nomic Bot</a></li>
<li><a href="#propositions">Propositions</a></li>
</ul>
<!--<h2 id="NAS">Nomic Automation System (NAS)</h2>-->
<br>
<h2 id="website">Website</h2>
<p>
This website serves two main purposes:
<ul>
<li>To be a repository of all information related to this season of BS Nomic.</li>
<li>To interact with the automation system (Nomic Bot).</li>
</ul>
</p>
<br>
<h2 id="nomic-bot">Nomic Bot</h2>
<p>
The Nomic Bot Discord bot is used to manage the NAS (Nomic Automation System) from the Nomic Discord server, or through Discord direct messages.
</p>
<h3 id="nomic-bot-commands">Commands</h3>
<p>
Nomic Bot commands can be executed through global/guild-specific slash commands, or by prepending the command prefix <code>$</code> to the command with space-delimited arguments.
</p>
<ul id="nomic-bot-command-list">
<li>
<code id="nomic-bot-commands-help">help</code><br>
Send a list of commands that Nomic Bot supports.<br>
<br>
</li>
<li>
<code id="nomic-bot-commands-ping">ping</code><br>
Test to see if Nomic Bot is online and get latency in ms.<br>
<br>
</li>
<li>
<code id="nomic-bot-commands-players">players</code><br>
Get a list of players.<br>
<br>
</li>
<li>
<code id="nomic-bot-commands-votes">votes [message ID]</code><br>
Get the votes on a proposition.<br>
To get the ID of a message, ensure "Developer Mode" is on in Discord's Advanced Settings, right-click the message, and select "Copy ID".<br>
<br>
</li>
<li>
<code id="nomic-bot-commands-rand">rand [lower bound] [upper bound]</code><br>
Generate a random integer between the lower and upper bounds (inclusive).<br>
If no bounds are given, this command returns a random number between 0 (inclusive) and 1 (exclusive).<br>
<br>
</li>
<li>
<code id="nomic-bot-commands-roll">roll [XdY]</code><br>
Roll X dice of size Y.<br>
<br>
</li>
<li>
<code id="nomic-bot-commands-listrand">listrand [list]</code><br>
Randomise a given space-/comma-separated list.<br>
<br>
</li>
<li>
<code id="nomic-bot-commands-randplayer">randplayer</code><br>
Return a random player.<br>
<br>
</li>
<li>
<code id="nomic-bot-commands-randplayerlist">randplayerlist</code><br>
Return the list of players in a random order.<br>
<br>
</li>
</ul>
<br>
<h2 id="propositions">Propositions</h2>
<p>
All in-game propositions should be made in the <a href="https://discord.com/channels/701269326518419547/1045491241728618496">#propositions channel</a> on the Nomic Discord guild.
</p>
<h3 id="proposition-syntax">Syntax</h3>
When making a proposition it is always best to use a syntax the same as, or similar to, that of the other players.<br>
This is partially for clarity and human-readability, though also because the automation system will attempt to automatically parse your propositions, and if they use invalid syntax that will cause issues.<br>
If you don't like the syntax that other players are using, you can modify it (within reason) to suit your needs, but if you do ensure that you remain consistent.<br>
<br>
With that said, it is preferable that you use recent propositions as a reference on how to format your proposition. If you need any more clarity, see below:<br>
<br>
The following is the <b>official template</b> you should use to format your propositions:
<br>
<div id="proposition-syntax-template" class="syntax-example-box">
**[Modification Type]**<br>
> [Title/ID]<br>
[Content]<br>
<br>
**[Modification Type]**<br>
> [Title/ID]<br>
[Content]<br>
<br>
[Repeat as necessary]
</div>
<br><br>
[Modification Type] = The type of modification being made to the ruleset.<br>
Options include:
<ul>
<li>
<details>
<summary>Addition</summary>
<div class="detail-content">
Add a new rule to the ruleset.<br>
This requires a title and content.<br>
<br>
The recommended structure is:<br>
<div class="syntax-example-box">
**Addition**<br>
> [Title]<br>
[Content]<br>
</div>
</div>
<br>
</details>
</li>
<li>
<details>
<summary>Content Edit</summary>
<div class="detail-content">
Replace the content of a rule.<br>
This requires an ID or a title, and the complete new rule content.<br>
<br>
The recommended structure is:<br>
<div class="syntax-example-box">
**Content Edit**<br>
> [ID or Title]<br>
[New Content]<br>
</div>
</div>
<br>
</details>
</li>
<li>
<details>
<summary>Title Edit</summary>
<div class="detail-content">
Change the title of a rule.<br>
This requires an ID or old title, and the new title of the rule.<br>
<br>
The recommended structure is:<br>
<div class="syntax-example-box">
**Title Edit**<br>
> [ID or Title]<br>
[New Title]<br>
</div>
</div>
<br>
</details>
</li>
<li>
<details>
<summary>Deletion</summary>
<div class="detail-content">
Delete a rule.<br>
This requires an ID or rule title.<br>
<br>
The recommended structure is:<br>
<div class="syntax-example-box">
**Deletion**<br>
> [ID or Title]<br>
</div>
</div>
<br>
</details>
</li>
<li>
<details>
<summary>Content Appendication</summary>
<div class="detail-content">
Append more content to the end of a rule.<br>
This requires an ID or title and the content to append.<br>
<br>
The recommended structure is:<br>
<div class="syntax-example-box">
**Content Appendication**<br>
> [ID or Title]<br>
[Additional Content]<br>
</div>
</div>
<br>
</details>
</li>
<li>
<details>
<summary>Miscellaneous Change</summary>
<div class="detail-content">
Make a change to the game which has no dedicated modification type.<br>
This requires a description of the modification to be made to the game.<br>
<br>
The recommended structure is:<br>
<div class="syntax-example-box">
**Misc Change**<br>
[Description of modification]<br>
</div>
</div>
</details>
</li>
</ul>
<br>
[ID] = The identification number of the rule you are adding/modifying/removing.<br>
Every rule has a unique global ID which is an integer assigned to it when it is accepted into the rule tree (which makes the global ID chronological).<br>
Note: When referring to a rule in a proposition it is advised to use both its ID and its Title.
<br>
<br>
[Title] = The title of the rule you are adding/modifying/removing.<br>
The "title" of a rule could be more of a brief summary of the purpose of the rule.<br>
Note: When referring to a rule in a proposition it is advised to use both its ID and its Title.
<br>
<br>
[Content] = The functional part of your rule.<br>
For most purposes, this is the only part of your proposition that <i>really</i> matters.<br>
The content of a rule needs to be easily understandable and entirely objective. Anything up to interpretation can (and will) cause loopholes or other issues, so ensure that you check your wording (and spelling) to prevent those issues from ever appearing.
<br>
<br>
The following is an example proposition using all recommended syntax:
<br>
<div id="proposition-syntax-example" class="syntax-example-box">
<b>Addition</b><br>
<span class="discord-quote-indent"></span> First to 100 points wins<br>
The first player to reach at least 100 points wins the game.<br>
<br>
<b>Content Edit</b><br>
<span class="discord-quote-indent"></span> 5 - Entering<br>
A person or group of people, none of whom are currently acting as a player or a part of a player, may request to become a player at any time. All current players may vote (up or down) on allowing the player to join.<br>
When a play joins, they start with 0 points.<br>
<br>
<b>Title Edit</b><br>
<span class="discord-quote-indent"></span> Passing<br>
Turn Passing<br>
<br>
<b>Content Edit</b><br>
<span class="discord-quote-indent"></span> 7 - Exiting<br>
A player always has the option of forfeiting the game. No penalty worse than losing, in the opinion of the player incurring the penalty, may be imposed.<br>
When a player exits, all the points they have are lost.<br>
</div>
<br>
<br>
<br>
</div>
<script>
const root = ".";
</script>
<script src="./main.js"></script>
<script src="./menu.js"></script>
<script src="./themes.js"></script>
<script src="./search.js"></script>
<script src="./Rules/rule-class.js"></script>
</body>
</html>