Merge branch 'knobs'

Makefile

@@ -4,7 +4,7 @@
 
 # hint: md5sha1sum via brew for OS X
 
-JAR  := target/wadc-3.0.jar
+JAR  := target/wadc-3.1-jar-with-dependencies.jar
 WADS := $(patsubst %.wl,%.wad, $(wildcard examples/*.wl) $(wildcard tests/*.wl))
 
 default: check
@@ -15,7 +15,7 @@ check:
 wads: $(WADS)
 
 %.wad : %.wl
-	java -cp $(JAR) org.redmars.wadc.WadCCLI -nosrc "$<"
+	java -cp $(JAR) org.redmars.wadc.WadCCLI -nosrc --seed 1337 "$<"
 
 # this should not be automatically re-generated so it should not appear as
 # a dependency in any other rules. To be run by hand by someone who is very

README.adoc

@@ -12,24 +12,34 @@ WadC is a lazy functional/macro hybrid programming language. Think of it
 like https://en.wikipedia.org/wiki/Logo_(programming_language)[Logo] on
 steroids, with monsters.
 
+See the WadC homepage: <https://jmtd.net/wadc/>.
+
 == Documentation
 
+ * link:doc/setup.adoc[Setup and getting started]
  * link:doc/reference.adoc[Complete reference]
  * link:doc/release_notes.adoc[Release notes and version history]
  * link:doc/tutorial.adoc[Incomplete tutorial (work in progress)]
+ * link:https://redmars.org/wadc/examples/[Examples gallery] (external)
 
-It's also worth reading the link:examples/[examples] and
+It's also worth reading the link:examples/[] and
 link:include/[standard library].
 
 == Download
 
-Downloads are on the https://github.com/jmtd/wadc/releases[releases page].
-
-See also the WadC homepage: <https://jmtd.net/wadc/>.
+Downloads are on the https://github.com/jmtd/wadc/releases[GitHub releases page].
 
 == Who
 
 Since 2008, WadC is developed by link:https://jmtd.net[Jonathan Dowland].
 
 WadC was originally written by Wouter van Oortmerssen
 (link:http://strlen.com/wadc/[Aardappel]) in 2001.
+
+== License
+
+WadC is licensed under the terms of link:LICENSE.txt[the GNU Public License,
+version 2].
+
+WadC uses the Picocli Java library, which is licensed under
+link:doc/Apache-License-2.0.txt[the Apache License, version 2.0].

doc/Apache-License-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

doc/reference.adoc

@@ -22,7 +22,7 @@ software.
 Since 2008, WadC is developed by Jonathan Dowland <[email protected]>.
 
 WadC was originally written by Wouter van Oortmerssen
-(link:http://strlen.com/wadc/[Aardappel]) in 2001.
+(link:http://strlen.com/wadc/[Aardappel]) in 1999.
 
 == Version history
 
@@ -32,7 +32,7 @@ See link:release_notes.adoc[Release notes and version history].
 
 - any computer that runs Java 1.8 or better
 - any version of Doom
-- a Doom nodebuilder (bsp 5.2 recommended)
+- a Doom nodebuilder (link:zdbsp[https://github.com/rheit/zdbsp] recommended)
 
 
 == Source code
@@ -45,24 +45,24 @@ GPL (GNU Public License, version 2. see the included LICENSE.txt file.)
 
 
 You need a Java runtime environment installed to use WadC. Get one from
-https://java.com/download if you don't have it already.
+https://adoptopenjdk.net/ if you don't have it already.
 
 Unpack the whole zip to any directory you like. On most systems, just
-double-click or activate the "wadc-2.1.jar" file. From a command line in
-the location where you extracted the ZIP, could also run
+double-click or activate the "wadc-3.1-jar-with-dependencies.jar" file. From a
+command line in the location where you extracted the ZIP, could also run
 
-    java -jar wadc.jar
+    java -jar wadc-3.1-jar-with-dependencies.jar
 
 To play the .wad files you create using WadC in Doom, you also need a
-node builder, such as BSP, available from http://games.moria.org.uk/doom/bsp/
+node builder, such as zdBSP, available from https://github.com/rheit/zdbsp
 For a list of other node builders, see http://doomwiki.org/wiki/Category:Node_builders
 
 === Sneak-peek: command-line interface
 
 There is a very early-stages command-line interface now available. To
 launch it, you need to run
 
-    java -cp wadc.jar org.redmars.wadc.WadCCLI path/to/input.wl
+    java -cp wadc-3.1-jar-with-dependencies.jar org.redmars.wadc.WadCCLI path/to/input.wl
 
 It will attempt to parse, run and write out to path/to/output.wad. Be
 aware that this is alpha quality, consider this a tech preview :)
@@ -390,6 +390,45 @@ use larger.
 
 `simplex` is entirely deterministic, reproducible and not affected by `seed`.
 
+=== Tuneable Knobs
+
+When developing maps in WadC, it is sometimes useful to structure a set of
+variables as switches for map behaviour. Examples might be turning on "high
+detail mode", or setting a global default light level, or ceiling height,
+or the number of things in a population, or the size or scale of geometry.
+E.g.:
+
+    lightlevel { 200 } -- default light level
+    ...
+    main {
+    ...
+        leftsector(0, 400, lightlevel)
+    ...
+
+It is possible to mark such variables as tuneable Knobs. WadC provides a UI
+of sliders for such variables that can be adjusted to quickly experiment with
+different combinations of values. To mark a variable as a Knob, use
+`knob(label, min, value, max)`. E.g.
+
+    lightlevel { knob("lightlevel", 0, 200, 255) }
+
+The first time a `knob` expression is evaluated, it returns the value
+declared within, and registers a Knob with the given label, value, and
+minimum/maximum bounds.
+
+The WadC UI provides visual sliders to set a different value for the Knob
+within the minimum/maximum bounds.
+
+Subsequent evaluations of `knob` with the same label will return the value
+set in the UI. If the subsequent `knob` declarations specify different
+minimum/maximum bounds, the value will be clamped within that range and
+the registered bounds updated.
+
+Setting the value of Knobs is not currently possible from the CLI.
+
+Several of the examples provided with WadC define knobs. Try loading one
+into the GUI, tweaking the sliders and Running the results.
+
 === Doom Specific Commands
 
 The bit you have been waiting for :)
@@ -608,6 +647,13 @@ width, i.e. if width = 128, then subdivision = 64 gives you sectors of 2 units w
 Arch adds to xoff automatically to reduce funny texturing. On the y axis it is best
 if you precede arch by unpegged.
 
+
+    archclip(height,width,depth,subdivision,floor,lightlevel,clip)
+
+This is a special-case version of arch which has an additional parameter, clip, to
+cut short generating the arch. This can be used to create structures such as gothic
+arches.
+
     mergesectors
 
 turns sector merge mode on. In this mode WadC will check for existing sectors