Add mod.conf
[minetest_colorcubes.git] / README.md
blobfbcefa6058d6728a2c062662391e496b67f390bb
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.4.
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 light color cubes. Each light color cube has a different
23 brightness, depending on its color. The available colors for light color
24 cubes are, sorted by brightness:
26 1. White
27 2. Yellow
28 3. Orange
29 4. Red
30 5. Red-violet
31 6. Magenta
32 7. Violet
33 8. Blue
34 9. Skyblue
35 10. Cyan
36 11. Aqua
37 12. Green
38 13. Lime
40 ## Crafting
41 Some blocks can be crafted for convenience.
43 ### Basic color cubes
44 This is crafted by multiple means.
46 Place a tiled color cube of a single color in the crafting grid
47 to obtain 4 basic color cubes.
49 Place a concentric color cube in the crafting grid
50 to obtain 8 basic color cubes.
52 ### Tiled color cubes
53 This is crafted by placing 4 basic color cubes of the same
54 color into the crafting grid like this:
56     XX
57     XX
59 This yields one tiled color cube of the same color.
61 There are also a few tiled color cubes with a 2 color mosaic available.
62 They can be crafted from 4 basic color cubes:
64     12
65     21
67 “1” stands for the first color and “2” for the second color.
69 The following color combinations are available (usually complementary colors):
71 * Yellow and blue
72 * Red and cyan
73 * Green and magenta
74 * Aqua and red-violet
75 * Orange and skyblue
76 * Orange and brown
77 * Black and white
78 * Light gray and dark gray
80 ### Concentric color cubes
81 This is crafted by placing 8 basic color cubes of the same
82 color into the crafting grid like this:
84     XXX
85     X X
86     XXX
88 This yields one concentric color cube of the same color.
90 ## Coloring
91 All cubes can be colored by multiple means. The first one
92 is by crafting: Place a dye and a color cube into the crafting
93 grid (shapeless recipe) to create a color cube of the dye color.
95 This mod supports the Paint Roller mod [`paint_roller`].
96 All color cubes can be painted to change their color,
97 provided the color is available.
99 This mod is supported by the Color Machine mod [`colormachine`]
100 for repainting most of the blocks in this mod.
102 ## License
103 The entire mod (including all its files) falls under the WTFPL.
104 Do whatever you want, have fun! :-)