Add of the ReadMe.txt file

This commit is contained in:
yoyom 2024-06-02 17:27:18 +02:00
parent de03fe1636
commit c97f022853
1 changed files with 64 additions and 0 deletions

64
ReadMe.txt Normal file
View File

@ -0,0 +1,64 @@
# Game of Life Simulation
## Features
### User Interface
- Start/Pause Button: Initiates or pauses the simulation.
- Toggle Click Button: Toggles between different click actions for interacting with the world.
- Click Interaction: Allows users to toggle the state of cells by clicking on them.
- Speed Slider: Adjusts the speed of the simulation.
- Random Field Button: Generates a random world with a specified density of living cells.
- Toggle Border Button: Toggles between closed and looping borders for the simulation world.
- Load World/Rule Button: Loads a previously saved world state from a file.
- Save World/Rule Button: Saves the current world state to a file.
- Save and Load: Enables users to save and load world states to and from files.
IMPORTANT: Always start by loading a world and then loading the rules wanted before starting the simulation.
### Planned Features (Not implemented yet)
- Loading and Saving Agents: Ability to load and save agent populations for advanced simulations.
## Explorations
### Conway World Exploration
1. Simkin Glider Gun
- Behavior: The Simkin Glider Gun is a pattern that periodically generates gliders. It is more compact than the Gosper Glider Gun as it is composed of 6 squares and a small shape. It seems more efficient as it creates a glider that goes downward and then another one that goes upward, making it an interesting alternative.
It is saved as simkin_glider_gun.csv in examples\World
### Blob Rule Exploration
1. Blob Rule "S" Pattern
- Behavior: The "S" pattern is designed to alternate between two states infinitely, resembling the shape of the letter "S". Each state transition creates a distinct visual pattern, contributing to the dynamism and complexity of the simulation under the blob rule.
It is saved as s_blobrule.csv in examples\World
### HighLife Rule Exploration
#### Functionning: The cell survives if it has 2 or 3 neighbors and a new cell is born if it has 3 or 6 neighbors.
It is saved as HighLife.csv in examples\Rule
#### Pattern: The Replicator
- Behavior: This pattern replicates itself after 12 generations.
It is saved as HighLife_Replicator.csv in examples\World
### Discovery by mystake:
We implemented the HighLife Rule in the opposite way: The cell survives if it has 3 or 6 neighbors and a new cell is born if it has 2 or 3 neighbors.
It ended in a rule that make pattern grow symetricaly and infinitely in the grid, even by starting with small patterns. It is really nice to watch and it is an interesting discovery.
The rule is saved as HighLife_Opposite.csv in examples\Rule
#### Pattern:
To show you the power of life with this rule, we created to small patterns, a 2 by 2 square and a 2 point pattern.
They are saved as HL_O_square.csv and HL_O_doublepoints.csv in examples\World
## Known Issues
- Loading and saving agents is not working as we didn't implemented agents yet.
- If you launch a simulation, then click on toggle click and finally click on cells on the grid, it will add small white sheeps in each cell but then if you start the simulation, nothing will happen as the simulation will not work.
## Credits
This project was developed by Yohan Mirabel and Victor Zabé for Multi-Agent Project in Object-Oriented Programming course.