Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spangenberg/alieninvasion
Alien Invasion
https://github.com/spangenberg/alieninvasion
Last synced: about 1 month ago
JSON representation
Alien Invasion
- Host: GitHub
- URL: https://github.com/spangenberg/alieninvasion
- Owner: spangenberg
- License: mit
- Created: 2022-10-06T09:19:35.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-06T09:24:09.000Z (over 2 years ago)
- Last Synced: 2024-06-21T03:27:29.690Z (7 months ago)
- Language: Go
- Homepage: https://spangenberg.github.io/alieninvasion/
- Size: 39.1 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Alien Invasion
Alien Invasion is a CLI tool to simulate an alien invasion.
Getting Started & Documentation
-------------------------------
All documentation is available on the [Alien Invasion documentation](https://github.com/spangenberg/alieninvasion/tree/main/docs).
### Run locally
```sh
$ go run .
...
```
### Build
```sh
$ make build
...
```
### Test
```sh
$ make test
...
```
### Generating a map
This command will generate a decently sized map.
```sh
$ bin/alieninvasion generate --height 300 --width 300 --cities 50000 | grep = > 50k.map
```
### Running the simulation
```sh
$ bin/alieninvasion simulate --map-path 50k.map 10000
```
### Notes
- City names in the map file must not contain spaces, if they do the parsing will fail.
- Alien names can be randomly generated, but they are not guaranteed to be unique and are also hard to read in the output.
- The simulation will run until all aliens are dead or the maximum number of turns is reached.
- The random number generator is seeded with the current time, so the simulation will be different each time, for this use case it's good enough.
- Basic user validation is performed on the CLI, but it is not exhaustive.
- The test coverage is not exhaustive and only cover some core logic.
- The simulation runs sequentially, an experimental concurrency version is available in the [feat/concurrency](https://github.com/spangenberg/alieninvasion/tree/feat/concurrency) branch.