X-Git-Url: https://git.subgeniuskitty.com/screensavers/.git/blobdiff_plain/3181d46aae9f5fc47db82958f2dcde7219f3b21a..963226f78433e2a83465604d53c35c0da0627540:/hacks/WolframAutomata/README.md diff --git a/hacks/WolframAutomata/README.md b/hacks/WolframAutomata/README.md index 751108f..d3546d1 100644 --- a/hacks/WolframAutomata/README.md +++ b/hacks/WolframAutomata/README.md @@ -84,12 +84,30 @@ are re-randomized every time the simulation is reset, such as after a simulation completes or after resizing the window. +CLI: Rule Selection +------------------- + +If neither of the following two options are passed, rules are randomly selected +from `curated_ruleset_list[]` in `WolframAutomata.c`. + + - **`-true-random-rule`**: Select a rule completely at random, NOT randomly + from a curated list. Note that many rules are visually uninteresting. + + - **`-rule N`**: Select a specific rule where `N` is a Wolfram number. Values + from 0-255 inclusive are valid. + + CLI: Simulation Seed -------------------- -If none of the following options are specified, the starting seed will contain -randomly interspersed active/inactive cells at a 30/70, 50/50, or 70/30 ratio, -itself also randomly selected. +The following seed related CLI flags apply only when using the +`-true-random-rule` or `-rule N` flags. Without these flags, the program draws +rules from `curated_ruleset_list[]` which also includes curated seeds, all of +which override any seed related CLI flags. + +If the curated rule list is not in use and none of the following options are +specified, the starting seed will contain randomly interspersed active/inactive +cells at a 30/70, 50/50, or 70/30 ratio, itself also randomly selected. - **`-seed-left`**: Seeds a single active cell on the left side of the display. All other cells are inactive. @@ -101,22 +119,22 @@ itself also randomly selected. - **`-seed-density N`**: Generates random seed with `N` percent active cells. -CLI: Rule Selection -------------------- +CLI: Simulation Length +---------------------- -If neither of the following two options are passed, rules are randomly selected -from `curated_ruleset_list[]` in `WolframAutomata.c`. +If neither of the following two options are passed, the simulation runs as +thought `-length 5000` was passed. - - **`-true-random-rule`**: Select a rule completely at random, NOT randomly - from a curated list. Note that many rules are visually uninteresting. + - **`-random-length`**: A random length smaller than 10,000 generations but + large enough to fill the screen is selected. - - **`-rule N`**: Select a specific rule where `N` is a Wolfram number. Values - from 1-255 inclusive are valid. + - **`-length N`**: Request `N` generations be simulated on each run. -Note that, although Rule 0 is a valid set of rules, it is reused as a null -value by the program and thus is ignored if passed as `-rule 0`. If you want to -see Rule 0, choose any starting conditions you desire, then turn off your -monitor and enjoy the resulting simulation. +Note that an upper limit of 10,000 generations is enforced in order to avoid +`BadAlloc` errors from some X servers. For more details, read +`WolframAutomata.c` starting around the comment, "The maximum number of +generations is cell_size dependent. This is a soft limit and may be increased +if ..." CLI: Simulation Speed @@ -136,24 +154,6 @@ though `-delay 25000` was passed. well respected. -CLI: Simulation Length ----------------------- - -If neither of the following two options are passed, the simulation runs as -thought `-length 5000` was passed. - - - **`-random-length`**: A random length smaller than 10,000 generations but - large enough to fill the screen is selected. - - - **`-length N`**: Request `N` generations be simulated on each run. - -Note that an upper limit of 10,000 generations is enforced in order to avoid -`BadAlloc` errors from some X servers. For more details, read -`WolframAutomata.c` starting around the comment, "The maximum number of -generations is cell_size dependent. This is a soft limit and may be increased -if ..." - - CLI: Cell Dimensions --------------------