README.md 2.39 KB
Newer Older
Fanny Cheung's avatar
Fanny Cheung committed
1
2
# Shanawdithit

Fanny Cheung's avatar
Fanny Cheung committed
3
4
Shanawdithit is a library that generates random maps from a tile collection.
The main inspiration for this funny project comes from the board game
Fanny Cheung's avatar
Fanny Cheung committed
5
[Carcassonne](https://en.wikipedia.org/wiki/Carcassonne_(board_game)).
Fanny Cheung's avatar
Fanny Cheung committed
6
7

For the moment, the library can only generate ASCII maps.
Fanny Cheung's avatar
Fanny Cheung committed
8
9
10

![shanawdithit](/uploads/243be03edfb55b89adda04fa2818f407/shanawdithit.gif)

Fanny Cheung's avatar
Fanny Cheung committed
11
12
## Summary

Fanny Cheung's avatar
Fanny Cheung committed
13
14
15
- [Pre-requisites](#pre-requisites)
- [Quick start](#quick-start)
- [Development](#development)
Fanny Cheung's avatar
Fanny Cheung committed
16
- [Documentation](#documentation)
Fanny Cheung's avatar
Fanny Cheung committed
17
18
19
- [Next steps](#next-steps)
- [About the name](#about-the-name)

Fanny Cheung's avatar
Fanny Cheung committed
20
## Pre-requisites
Fanny Cheung's avatar
Fanny Cheung committed
21
- Ruby >= 2.7.6
Fanny Cheung's avatar
Fanny Cheung committed
22
23
- Bundler >= 2.2.3

Fanny Cheung's avatar
Fanny Cheung committed
24
## Quick start
Fanny Cheung's avatar
Fanny Cheung committed
25
26
27
28
29

```
bundle install
```

Fanny Cheung's avatar
Fanny Cheung committed
30
31
Then:
```ruby
Fanny Cheung's avatar
Fanny Cheung committed
32
require './lib/shanawdithit'
Fanny Cheung's avatar
Fanny Cheung committed
33

Fanny Cheung's avatar
Fanny Cheung committed
34
# Create a map with the default ASCII collection
Fanny Cheung's avatar
Fanny Cheung committed
35
map = Shanawdithit::Core::Map.new(
Fanny Cheung's avatar
Fanny Cheung committed
36
37
38
39
40
  rows: 5,
  columns: 8,
)

# Populate an map with empty locations for each tile
Fanny Cheung's avatar
Fanny Cheung committed
41
map.populate
Fanny Cheung's avatar
Fanny Cheung committed
42
43

# Use a projection to draw the map
Fanny Cheung's avatar
Fanny Cheung committed
44
projection = map.default_projection
Fanny Cheung's avatar
Fanny Cheung committed
45
46
47
projection.draw
```

Fanny Cheung's avatar
Fanny Cheung committed
48
49
50
51
52
53
54
## Development

Run the tests:
```
bin/rspec
```

Fanny Cheung's avatar
Fanny Cheung committed
55
56
57
## Documentation

[Check out the documentation](/docs/README.md) 📖
Fanny Cheung's avatar
Fanny Cheung committed
58

Fanny Cheung's avatar
Fanny Cheung committed
59
60
## Next steps

Fanny Cheung's avatar
Fanny Cheung committed
61
62
- Add `area_types` helper in `Shanawdithit::Certificate::Base`
- Add `tile_attribute` helper in `Shanawdithit::Certificate::Base`
Fanny Cheung's avatar
Fanny Cheung committed
63
- Create a new `Projection` that outputs an HTML list of images.
Fanny Cheung's avatar
Fanny Cheung committed
64

Fanny Cheung's avatar
Fanny Cheung committed
65
## About the name
Fanny Cheung's avatar
Fanny Cheung committed
66

Fanny Cheung's avatar
Fanny Cheung committed
67
68
As I get older, I'm more and more upset by all the things around us that are
clearly impacted by patriarchy and colonialism, and yet accepted as the norm.
Fanny Cheung's avatar
Fanny Cheung committed
69
We are so used to a "white/straight/cisgender/valid man" world that we don't
Fanny Cheung's avatar
Fanny Cheung committed
70
notice that lots of us are not even represented in our daily environment.
Fanny Cheung's avatar
Fanny Cheung committed
71

Fanny Cheung's avatar
Fanny Cheung committed
72
For this project, I decided to pay tribute to
Fanny Cheung's avatar
Fanny Cheung committed
73
[Shanawdithit](https://en.wikipedia.org/wiki/Shanawdithit), the last known
Fanny Cheung's avatar
Fanny Cheung committed
74
living member of the Beothuk people (Canada) who is known for her
Fanny Cheung's avatar
Fanny Cheung committed
75
76
77
78
contributions to the historical understanding of
[Beothuk culture](https://en.wikipedia.org/wiki/Beothuk), including some maps.
I hope that mentionning her name will pique curiosity and encourage people to
read about the
Fanny Cheung's avatar
Fanny Cheung committed
79
80
[Beothuk genocide](https://vancouversun.com/news/local-news/beothuk-genocide-remembered-200-years-after-kidnapping-and-murder).
I want to raise awareness on how history and culture are always greatly
Fanny Cheung's avatar
Fanny Cheung committed
81
82
83
influenced by the people who convey them. Bias and lack of points of view can
create cultural resources that claims to be universal, but actually, are simply
just the voice of the powerful.