HTTPS SSH

README

"The REFCODES.ORG codes represent a group of artifacts consolidating parts of my work in the past years. Several topics are covered which I consider useful for you, programmers, developers and software engineers."

What is this repository for?

The funcodes-cellomat repository bears some cellular automaton experiments such as some BoulderDash simulation.

Getting started

To get up and running, clone the funcodes-cellomat repository from bitbucket's git repository.

How do I get set up?

Using SSH, go as follows to get the Maven CELL-O-MAT project:

git clone git@bitbucket.org:funcodez/funcodes-cellomat.git

Using HTTPS, go accordingly as follows to get the Maven CELL-O-MAT project:

git clone https://bitbucket.org/funcodez/funcodes-cellomat.git

Then you can build a fat-jar and launch the application:

cd funcodes-cellomat
mvn clean install
java -jar target/funcodes-cellomat-0.0.1-SNAPSHOT.jar

Big fat executable bash script (optional)

This step is optional, though when running your application under Linux, the following will be your friend:

To build a big fat single executable bash script, take a look at the shell-exec.sh script and the build.sh script respectively:

./shell-exec.sh
./target/cellomat.sh

The resulting cellomat.sh file is a big fat single executable bash script being launched via ./target/cellomat.sh.

Building and creating an executable bash script is done by calling ./build.sh!

Starting Cellomat

As described above, you may go with directly executing the JAR file by invoking java -jar target/funcodes-cellomat-0.0.1-SNAPSHOT.jar or, after some doings, you may also go with the big fat executable bash script like ./target/cellomat.sh to start the CELL-O-MAT.

Either way you launch the CELL-O-MAT application, you will be greeted with an ASCII art banner and a log output. We assume you are in the target folder and use the cellomat.sh script:

./cellomat.sh --help                     # Show a help message
./cellomat.sh                            # Start with a random cellular automaton and a random board
./cellomat.sh -b                         # Start with the BoulderDash cellular automaton and a random board
./cellomat.sh -b --console               # As above, in addition also print the current state to the console
./cellomat.sh -b --board CAVE_99_TESTRUN # Start with the BoulderDash cellular automaton and the 'CAVE_99_TESTRUN' board
./cellomat.sh -b --boards                # List all available BoulderDash boards
./cellomat.sh -w                         # Start with the Watchdog cellular automaton and a random board
./cellomat.sh -w --console               # As above, in addition also print the current state to the console
./cellomat.sh -w --board lecture         # Start with the Watchdog cellular automaton and the 'lecture' board
./cellomat.sh -w --boards                # List all available Watchdog boards

Have fun playing around with the various CELL-O-MAT settings!

Contribution guidelines

  • Add a nifty user-interface
  • Add cool functionality (open/closed principle)
  • Finding bugs
  • Helping fixing bugs
  • Making code and documentation better
  • Enhance the code

Who do I talk to?

  • Siegfried Steiner (steiner@refcodes.org)

Terms and conditions

The REFCODES.ORG group of artifacts is published under some open source licenses; covered by the refcodes-licensing (org.refcodes group) artifact - evident in each artifact in question as of the pom.xml dependency included in such artifact.