Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/magnetrwn/margolus-cpp

Reversible cellular automaton simulator for Margolus neighborhood automata: from billiard ball, to gas diffusion, tron, and critters, or any other ruleset possible.
https://github.com/magnetrwn/margolus-cpp

automata automaton cellular-automaton command-line configurable library render reversible

Last synced: 28 days ago
JSON representation

Reversible cellular automaton simulator for Margolus neighborhood automata: from billiard ball, to gas diffusion, tron, and critters, or any other ruleset possible.

Awesome Lists containing this project

README 

        
# Margolus CPP: Reversible cellular automaton simulator



[![CodeFactor](https://www.codefactor.io/repository/github/magnetrwn/margolus-cpp/badge)](https://www.codefactor.io/repository/github/magnetrwn/margolus-cpp)



Margolus CPP (`margolus-cpp`) is a simulator for different reversible cellular automata based on the [Margolus neighborhood](https://en.wikipedia.org/wiki/Block_cellular_automaton).



The behaviour of the simulator can be controlled by setting the ruleset used to control how each 2x2 block is changed for each iteration.



![Demo](margolus-demo.gif)



## Build



To build Margolus CPP on Linux systems, you can run `./build.sh` from project root.

Other platforms such as Windows might require slight modifications, such as in the use of `` for `usleep()`, and will need you to manually run `cmake` inside the build folder.



## Storage



Simulations can be loaded and saved, stored in an easily readable and understandable format. They contain simulation parameters and the gamerule used, as well as the status of the grid.



Check the `build/examples` folder to look at actual saves.



## Usage as CLI utility



Output of `./margolus -h`:



```

Available command line options:

  -h, --help                Display help message.

  -l, --load arg            Path to the file to load.

  -s, --save arg            Path to the file to save, once finished.

  -S, --save-stdout         Show output file on stdout instead of an actual file.

  -i, --iters arg (=0)      Iterations to run, positive forwards, negative backwards.

  -r, --render arg (=ANSI)  Engine to use to render grid, options: q, ANSI, SDL2.

  -o, --odd-flip            Flip render colors on odd iterations.

  -a, --animated            Run with a 75ms step animation.

```

Running `./margolus` with no arguments will just display the state of the grid, with default width and height, without stepping the simulation, but additional parameters can change the behaviour of the program.



For example, when running `./margolus -i-100 -a`, a 100 step animation will run **backward** steps of the grid.



## Usage as library



**Note:** I haven't looked at this for a while, so this is likely *outdated*.



Here is a sample program using Margolus CPP.



```cpp

#include 



#include "margolus.hpp"

#include "marg_render.hpp"



int main() {

    // Create a Margolus simulator with a 10x10 grid and specified block transforms

    std::vector transforms = { "ROTATE_90_LEFT", "INVERT" };

    Margolus marg(10, 10, transforms);



    // Fill a rectangular region with random cells

    marg.fillRect(2, 2, 7, 7, Margolus::NOISE, 0.8);



    // Fill a specific point by swapping its value

    marg.fillPoint(3, 3, 6, 6, Margolus::TOGGLE);



    // You can also access the grid directly through indexes

    marg[3][8] = true;



    // Display the initial grid using the render functionality

    std::cout << "Initial Grid:" << std::endl;

    MargolusRender::basicANSI(marg);



    // Perform 20 forward steps

    for (size_t i = 0; i < 20; i++)

        marg.step(Margolus::FORWARD);



    // Show current grid

    std::cout << "Grid after 20 forward steps:" << std::endl;

    MargolusRender::basicANSI(marg, marg.getOffset());



    // Perform 20 backward steps

    for (size_t i = 0; i < 20; i++)

        marg.step(Margolus::BACKWARD);



    // Show current grid

    std::cout << "Grid after 20 backward steps:" << std::endl;

    MargolusRender::basicANSI(marg, marg.getOffset());



    return 0;

}



```



## Contributing



If you feel like contributing, feel free to send issues and PRs! If you use VS Code, the `clangd` extension can be used with the project automatically detecting location of files after running `./build.sh` at least once.