Skip to content

Commit

Permalink
inital commit
Browse files Browse the repository at this point in the history
  • Loading branch information
MarkusDick committed Feb 14, 2024
0 parents commit 02ecbd2
Show file tree
Hide file tree
Showing 25 changed files with 2,409 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
_output/*.png
_output/*.pdf
~$*
.DS_Store
shuffled_words.csv
5 changes: 5 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
source 'https://rubygems.org'

gem 'squib'
gem 'rake', '13.0.6'
gem 'pango', '4.2.0'
72 changes: 72 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
GEM
remote: https://rubygems.org/
specs:
cairo (1.17.13)
native-package-installer (>= 1.0.3)
pkg-config (>= 1.2.2)
red-colors
cairo-gobject (4.2.0)
cairo (>= 1.16.2)
glib2 (= 4.2.0)
classy_hash (1.0.0)
fiddle (1.1.2)
gdk_pixbuf2 (4.2.0)
gio2 (= 4.2.0)
gio2 (4.2.0)
fiddle
gobject-introspection (= 4.2.0)
glib2 (4.2.0)
native-package-installer (>= 1.0.3)
pkg-config (>= 1.3.5)
gobject-introspection (4.2.0)
glib2 (= 4.2.0)
highline (2.1.0)
matrix (0.4.2)
mercenary (0.4.0)
native-package-installer (1.1.9)
nokogiri (1.16.1-x64-mingw-ucrt)
racc (~> 1.4)
nokogiri (1.16.1-x86_64-linux)
racc (~> 1.4)
pango (4.2.0)
cairo-gobject (= 4.2.0)
gobject-introspection (= 4.2.0)
pkg-config (1.5.6)
racc (1.7.3)
rainbow (3.1.1)
rake (13.0.6)
red-colors (0.3.0)
matrix
roo (2.10.1)
nokogiri (~> 1)
rubyzip (>= 1.3.0, < 3.0.0)
rsvg2 (4.2.0)
cairo-gobject (= 4.2.0)
gdk_pixbuf2 (= 4.2.0)
ruby-progressbar (1.13.0)
rubyzip (2.3.2)
squib (0.19.0)
cairo (~> 1.17, >= 1.17.8)
classy_hash (= 1.0.0)
gio2 (~> 4.1, >= 4.1.2)
gobject-introspection (~> 4.1, >= 4.1.2)
highline (= 2.1.0)
mercenary (= 0.4.0)
nokogiri (~> 1.14, >= 1.14.2)
pango (~> 4.1, >= 4.1.2)
rainbow (~> 3.1)
roo (~> 2.9)
rsvg2 (~> 4.1, >= 4.1.2)
ruby-progressbar (~> 1.11)

PLATFORMS
x64-mingw-ucrt
x86_64-linux

DEPENDENCIES
pango (= 4.2.0)
rake (= 13.0.6)
squib

BUNDLED WITH
2.4.20
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Markus Dick

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
70 changes: 70 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
# german-word-card-deck

This repository is dedicated to creating playing cards with six words per card, suitable for various word games such as Broad Lines, Just One, etc.

<img src="showcase_front.png" width="800">
<img src="showcase_back.png" width="800">

If you want to read the process of creating and crafting the cards you can read this in [my blog post](https://markusdick.de/posts/creating-print-and-play-cards/).

## Download the Print and Play File
If you only want to use the latest print and play file you can find the file under [releases](https://github.com/markusdick/german-word-card-deck/releases).

## How to Use

To use this tool, you'll need the following dependencies installed on your system:

- [Ruby](https://www.ruby-lang.org/en/) with rake
- [Squib](https://squib.rocks/)
- Font: Grundschrift

### Instructions

1. Clone this repository to your local machine.

```bash
git clone https://github.com/markusdick/german-word-card-deck.git
cd german-word-card-deck
```

2. Edit the `words.csv` file with your desired words.

3. Install the font `.\assets\Grundschrift-Bold.otf`.

3. Run the following command to generate the playing cards in PDF format.

```bash
rake
```

4. The generated PDF file `deck.pdf` will be available in the `_output` directory.

## Contributing

If you'd like to contribute to this project, feel free to submit a pull request or open an issue.

## Credits
- Family ❤️ for brainstorming words, designs, crafting and proof reading

### Tools / Tutorials
- [Squib](https://squib.rocks) by Andy Meneely
- [How To Make Game Cards that Shuffle - Print and Play Tutorial](https://www.youtube.com/watch?v=DgNJmAkO1_M) by Rachel Bruner

### Icons
All icons are from [game-icons.net](https://game-icons.net/).

Category | Icon / URL | By | License
---------|----|----|---------
General|https://game-icons.net/1x1/delapouite/wireframe-globe.html | [delapouite](https://delapouite.com/) | [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)
Animals |https://game-icons.net/1x1/lorc/flat-paw-print.html | [lorc](https://lorcblog.blogspot.com/) | [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)
Christmas | https://game-icons.net/1x1/delapouite/present.html | [delapouite](https://delapouite.com/) | [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)
Board Games| https://game-icons.net/1x1/delapouite/rolling-dices.html | [delapouite](https://delapouite.com/) | [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)
Everyday objects |https://game-icons.net/1x1/delapouite/house-keys.html | [delapouite](https://delapouite.com/) | [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)
Food & Drink| https://game-icons.net/1x1/delapouite/french-fries.html | [delapouite](https://delapouite.com/) | [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)
Family | https://game-icons.net/1x1/lorc/two-shadows.html | [lorc](https://lorcblog.blogspot.com/) | [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/)

### Font
The project uses the font "Grundschrift" by [Christian Urff](https://www.urff.info/) under the [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/).

## License
The code is licensed under the [MIT License](./LICENSE). The [german wordlist](./words.csv) is licensed under the [CC BY-SA 4.0 DEED](https://creativecommons.org/licenses/by-sa/4.0/deed).
15 changes: 15 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
require 'squib'

task default: [:check_duplicates, :shuffle_words, :deck]

task :check_duplicates do
load 'check_duplicates.rb'
end

task :shuffle_words do
load 'shuffle_words.rb'
end

task :deck do
load 'deck.rb'
end
1 change: 1 addition & 0 deletions _output/gitkeep.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Keep this here so that Git knows to keep the _output directory on a fresh clone
1 change: 1 addition & 0 deletions assets/1.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/2.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/3.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/4.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/5.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions assets/6.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 02ecbd2

Please sign in to comment.