Add README.md
[minetest_colorcubes.git] / README.md
blob70c77436375278759a1a937e78009666c6a8c8bc
1 # Color Cubes [`colorcubes`]
2 ## Description
3 This mod adds various decorational and colorful blocks to Minetest. This is mostly for creative purposes.
5 ## Current version
6 The current version of this mod is 0.2.
8 ## Block types and colors
9 The blocks come in 5 types and 19 colors.
11 Each block can be dug by hand in a half second.
13 The following block types are available:
15 * Basic color cubes: These blocks have a single square pattern
16 * Tiled color cubes: These blocks have 4 squares in a tile pattern
17 * Concentric color cubes: These blocks have a pattern of 4 concentric squares
18 * Window color cubes: These blocks are semi-transparent and let sunlight go through
19 * Light color cubes: These blocks emit light
21 ### Light color cubes
22 There are 13 lamps. There aren't lamps for all colors. Each lamp has a different
23 brightness, depending on its color. The available lamp colors are, sorted by brightness:
25 1. White
26 2. Yellow
27 3. Orange
28 4. Red
29 5. Red-violet
30 6. Magenta
31 7. Violet
32 8. Blue
33 9. Skyblue
34 10. Cyan
35 11. Aqua
36 12. Green
37 13. Lime
39 ## Crafting
40 Some blocks can be crafted for convenience.
42 ### Basic color cubes
43 This is crafted by multiple means.
45 Place a tiled color cube of a single color in the crafting grid
46 to obtain 4 basic color cubes.
48 Place a concentric color cube in the crafting grid
49 to obtain 8 basic color cubes.
51 ### Tiled color cubes
52 This is crafted by placing 4 basic color cubes of the same
53 color into the crafting grid like this:
55     XX
56     XX
58 This yields one tiled color cube of the same color.
60 There are also a few tiled color cubes with a 2 color mosaic available.
61 They can be crafted from 4 basic color cubes:
63     12
64     21
66 “1” stands for the first color and “2” for the second color.
68 The following color combinations are available (usually complementary colors):
70 * Yellow and blue
71 * Red and cyan
72 * Green and magenta
73 * Aqua and red-violet
74 * Orange and skyblue
75 * Orange and brown
76 * Black and white
77 * Light gray and dark gray
79 ### Concentric color cubes
80 This is crafted by placing 8 basic color cubes of the same
81 color into the crafting grid like this:
83     XXX
84     X X
85     XXX
87 This yields one concentric color cube of the same color.
89 ## Coloring
90 This mod supports the Paint Roller mod [`paint_roller`].
91 All color cubes except the light color cubes can be painted
92 to change their color.
94 This mod is supported by the Color Machine mod [`colormachine`]
95 for repainting most of the blocks in this mod.
97 ## License
98 The entire mod (including all its files) falls under the WTFPL.
99 Do whatever you want, have fun! :-)