cromulant/README.md

# Cromulant

[Click here for screenshots](screenshots.md)

## What is this?

This is a kind of toy you can use for your amusement.

You start with random ants from a list of 1000 names.

The ants will produce random updates.

The updates can be random non-sensical sentences.

The ants can score triumphs or take hits.

You can adjust the speed of the updates.

## Game Loop

You start a new game with 25 to 250 ants.

You get to read funny updates from the ants.

You watch who gets the most triumphs or the most hits.

The ant with the highest score is shown in the footer.

Ants get merged and replaced over time.

All of this happens automatically.

You can manually trigger terminations or merges by
clicking or middle clicking the images on the left.

## Installation

### Quick Installation

If you have `pipx` and `linux` installed you can use the following command:

```sh
pipx install git+https://github.com/madprops/cromulant --force
```

### Advanced Installation

1) Clone this repo.

2) python -m venv venv

3) venv/bin/pip install -r requirements.txt

4) Use `run.sh` or `venv/bin/python -m cromulant.main`

5) (Optional) Manually create desktop entries and icons for the application.

## Algorithm

A random ant is picked based on weights (oldest update date weighs more).
Then a random number between 0 and 12 is picked.
For each number an action happens to produce an update.

The top score is calculated as (Triumph - Hits).
If multiple ants have the same score, the oldest one wins.

For merge, the words of each name are used.
They get filled with random words if less than 2 words.
One word from each set is picked randomly.
The triumph and hits get combined.
The original ants get terminated and the merged one hatches.
An extra random ant is hatched to fill the gap.

## Technology

This is made with python + qt (pyside6)

## The name

I read the word [cromulent](https://www.merriam-webster.com/wordplay/what-does-cromulent-mean) being used somewhere which turned out to be invented by The Simpsons.


I created a new programming project to practice/study and tried to use that word for the name but made a typo.

I liked the typo and made a game about ants.

---

[Command line arguments](arguments.md)

[Click here for more](more.md)
Mods 2024-07-20 11:24:24 +00:00			`# Cromulant`

Mods 2024-07-22 07:26:29 +00:00			`[Click here for screenshots](screenshots.md)`
Mods 2024-07-22 07:25:06 +00:00
Mods 2024-07-20 11:24:24 +00:00			`## What is this?`
Mods 2024-07-20 11:16:02 +00:00
			`This is a kind of toy you can use for your amusement.`

Mods 2024-07-21 12:01:20 +00:00			`You start with random ants from a list of 1000 names.`
Mods 2024-07-20 11:16:02 +00:00
Mods 2024-07-21 07:18:23 +00:00			`The ants will produce random updates.`
Mods 2024-07-20 11:16:02 +00:00
			`The updates can be random non-sensical sentences.`

			`The ants can score triumphs or take hits.`

			`You can adjust the speed of the updates.`

			`## Game Loop`

Mods 2024-07-21 13:00:05 +00:00			`You start a new game with 25 to 250 ants.`
Mods 2024-07-21 07:25:48 +00:00
Mods 2024-07-21 12:01:20 +00:00			`You get to read funny updates from the ants.`
Mods 2024-07-20 11:16:02 +00:00
			`You watch who gets the most triumphs or the most hits.`

			`The ant with the highest score is shown in the footer.`

Mods 2024-07-21 07:18:23 +00:00			`Ants get merged and replaced over time.`
Mods 2024-07-21 06:27:44 +00:00
Mods 2024-07-21 10:21:01 +00:00			`All of this happens automatically.`

Mods 2024-07-21 13:44:00 +00:00			`You can manually trigger terminations or merges by`
			`clicking or middle clicking the images on the left.`

Mods 2024-07-20 15:31:01 +00:00			`## Installation`

Mods 2024-07-28 09:41:47 +00:00			`### Quick Installation`

			If you have `pipx` and `linux` installed you can use the following command:

Mods 2024-07-20 15:31:01 +00:00			```sh
			`pipx install git+https://github.com/madprops/cromulant --force`
			```

Mods 2024-07-28 09:41:47 +00:00			`### Advanced Installation`

			`1) Clone this repo.`

			`2) python -m venv venv`

			`3) venv/bin/pip install -r requirements.txt`

			4) Use `run.sh` or `venv/bin/python -m cromulant.main`

			`5) (Optional) Manually create desktop entries and icons for the application.`

Mods 2024-07-20 11:16:02 +00:00			`## Algorithm`

Mods 2024-07-20 12:55:15 +00:00			`A random ant is picked based on weights (oldest update date weighs more).`
Mods 2024-07-21 07:21:20 +00:00			`Then a random number between 0 and 12 is picked.`
Mods 2024-07-20 11:22:21 +00:00			`For each number an action happens to produce an update.`

Mods 2024-07-20 15:26:40 +00:00			`The top score is calculated as (Triumph - Hits).`
Mods 2024-07-22 04:05:17 +00:00			`If multiple ants have the same score, the oldest one wins.`
Mods 2024-07-20 15:26:40 +00:00
Mods 2024-07-21 06:55:37 +00:00			`For merge, the words of each name are used.`
			`They get filled with random words if less than 2 words.`
			`One word from each set is picked randomly.`
			`The triumph and hits get combined.`
			`The original ants get terminated and the merged one hatches.`
Mods 2024-07-21 07:28:06 +00:00			`An extra random ant is hatched to fill the gap.`
Mods 2024-07-21 06:55:37 +00:00
Mods 2024-07-20 11:26:29 +00:00			`## Technology`

			`This is made with python + qt (pyside6)`

Mods 2024-07-20 11:47:50 +00:00			`## The name`

Mods 2024-07-27 05:41:31 +00:00			`I read the word [cromulent](https://www.merriam-webster.com/wordplay/what-does-cromulent-mean) being used somewhere which turned out to be invented by The Simpsons.`
Mods 2024-07-20 11:47:50 +00:00

Mods 2024-07-20 11:50:53 +00:00			`I created a new programming project to practice/study and tried to use that word for the name but made a typo.`
Mods 2024-07-20 11:47:50 +00:00
Mods 2024-07-20 11:50:53 +00:00			`I liked the typo and made a game about ants.`
Mods 2024-07-20 11:47:50 +00:00
Mods 2024-07-22 07:29:03 +00:00			`---`
Mods 2024-07-20 11:22:21 +00:00
Mods 2024-07-27 03:57:19 +00:00			`[Command line arguments](arguments.md)`

Mods 2024-07-22 07:29:03 +00:00			`[Click here for more](more.md)`