rename etc to src, improve docs formatting

CHANGELOG.md

@@ -0,0 +1,170 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a
+Changelog](https://keepachangelog.com/en/1.0.0/).
+
+'!' (near bottom) is for bugs in 2012 version that are fixed (as opposed
+to features that were changed/added) in this fork.
+
+
+## [git] - 2019-07-02
+### Changed
+* Rename etc to src to denote that the files are unnecessary for use.
+* Move log to CHANGELOG.md (and format as per keepachangelog.com)
+* Rename expertmm to poikilos to reflect my GitHub username change.
+* Improve use of markdown in README.md and CHANGELOG.md.
+
+
+## [git] - 2017-05-14
+### Added
+- ruby item, mineral, & (realistic mode) block textures
+
+
+## [git] - 2017-03-23
+### Added
+- peridot (realistic mode) block texture
+
+
+## [git] - 2017-03-21
+### Changed
+- improved peridot item & mineral textures
+
+
+## [git] - 2017-03-20
+### Added
+- Add improved opal item texture (All except optional realistic mode
+  opal block are finished)
+### Changed
+- Change garnet from Spessartine to pomegranate seed colored Rhodolite
+  to reflect the original meaning of the word garnet (comes from the
+  word pomegranate) -- see
+  <https://www.americangemsociety.org/en/garnet-history>.
+
+
+## [git] - 2017-03-18
+### Added
+- new textures for garnet: gem (item), mineral, block (realistic style)
+### Changed
+- Change tint of garnet block (classic style) to look like Spessartine
+  garnet.
+
+
+## [git] - 2017-03-13
+### Changed
+- Use settings from server's minetest.conf:
+  birthstones_texture_style (can be realistic or classic)
+- Change default block style to classic
+- Improve opal mineral overlay, alexandrite classic block texture.
+
+
+## [git] - 2017-03-11
+### Changed
+- Redo emerald mineral and item textures.
+- Redo classic textures for gems where realistic block is not
+  finished yet.
+
+
+## [git] - 2017-03-10
+### Changed
+- Redo textures for "white diamond" mineral and item [blend file:
+  octagon beveled all but top and bottom by .12 offset] and for topaz
+  mineral.
+- Change sun square emission from 10 to 100.
+
+
+## [git] - 2017-02-16
+### Added
+- Rerender Alexandrite block & item; new textures for minerals:
+  Alexandrite, Amethyst (collect HD versions in src/hd).
+### Changed
+- Completely rework gem shader (blend version 2).
+- Redo textures for aquamarine: mineral, block, item.
+
+
+## [git] - 2017-02-15
+### Changed
+- In blend file, connect ID Mask to Image output (in Compositor nodes)
+  for alpha in rendered image.
+
+
+## [git] - 2017-02-13
+### Added
+- Make Blender project for gem rendering (see Developer Notes in
+  README.md for usage)
+- Make multi-sided Topaz Block (WIP) made in Blender.
+- Finish gem and block textures for Topaz, Alexandrite, Amethyst (in
+  Blender by Poikilos)
+
+
+## [git] - 2017-02-12
+### Added
+- (2017-02-12) Add gem hoes (using farming api).
+
+
+## [git] - 2017-02-11
+### Added
+- (!) Make opal possible to get: added missing register_on_generated for
+  changing some stone to opal (see oregen.lua).
+- swords & shovels
+- Add crafting recipe to convert block back into 9 gems.
+- Add recipe to create `default:diamond` from `dye:blue` +
+  `birthstones:diamond` for playability (for when other mods like
+  technic need diamonds for things)
+### Changed
+- (!) Preliminary step in fixing one-chop axes: Change register_tool
+  `time2` and `time3` from:
+  `[1]=time1-2.0, [2]=2.0-time2, [3]=2.0-time3}`
+  to
+  `times={[1]=time1/2.0, [2]=time2/2.0, [3]=time3/2.0}`
+- Change `* Ore` to `Stone with *` (because why copy other people when
+  you can make sense instead).
+- (!) Ore needs better pick to be mined: changed groups.cracky of all
+  from 3 to 1
+- (!) Block needs better pick to be mined: Changed groups:
+```lua
+	-- groups = {cracky = 3}
+	groups = {cracky = 1, level = 3}
+```
+- (!) Change drop of ores (to match modern style from default in
+  minetest_game from minetest 0.4.15-git 2017-01), where * below is
+  name:
+```lua
+	-- drop = 'craft "birthstones:*" 1',
+	drop = "birthstones:*",
+```
+- (!) Change drop for stone_with_topaz from stone_with_topaz to topaz
+  (apparently this didn't cause an issue since craft method had been
+  used).
+- Componentize into separate lua files for each category of operations.
+
+
+## [git] - 2017-02-10
+### Changed
+- Poikilos fork starts today.
+- Match minetest texture & variable naming scheme:
+```
+    (see changes below, where ^* is capitalized mineral name and * is
+    uncapitalized)
+	(aliases added only for backward compatibility--see aliases.lua
+	--doing aliases can be commented in init.lua)
+	Files:
+		^* TO birthstones_* (ITEM)
+		^*_overlay TO birthstones_mineral_* (ORE OVERLAY)
+		^*_block TO birthstones_*_block
+		*_axe to birthstones_tool_*axe
+		*_pick to birthstones_tool_*pick
+		^*_block to birthstones_*_block
+	Variables:
+		birthstones:*ore TO birthstones:stone_with_*
+		"birthstones:".. name .. "_pick" TO "birthstones:pick_"..name
+		"birthstones:".. name .. "_axe" TO "birthstones:axe_"..name
+```
+- (!) Capitalize stone name when used within tool display name.
+- (!) Fix issue where topaz ore was registered twice (didn't seem to
+  cause problems)
+- (!) Remove month from display names to avoid breaking immersion (draws
+  too much attention to the items having a "label") if re-added, months
+  would have to be corrected anyway as follows (in the original mod,
+  alphabetical order instead of actual birthstone month determined
+  month): see src/birthstones list.csv

README.md

@@ -3,92 +3,29 @@
 see LICENSE for full credits)
 
 ## Primary differences from original
-### Main reasons for fork:
-* add more tools
-* make changes to code to make use of modern Minetest (such as ore drop string)
-* make 3D prerendered textures of gem (item) and mineral (and optional block textures)
+(see also CHANGELOG.md)
 
-### Notable issues found in original (see items marked with '!' in "Changes" section for others):
-(hopefully these changes get corrected there)
-* birthstones were wrong month (see "birthstones list.csv" in etc folder for corrections, though month names are removed in fork)
-* now stone_with_opal is generated now (was impossible to get by mining before, apparently)
-* crafting block back to 9 gemstones is now possible
-* found some code bugs (see exclamation points under "Changes" below)
+### Main reasons for fork
+* Add more tools.
+* Make changes to code to make use of modern Minetest (such as ore drop
+  string).
+* Make 3D prerendered textures of gem (item) and mineral (and optional
+  block textures)
 
-### Other major differences from original
-Some major changes were done to make the mod easier to maintain:
-* changed to minetest_game's naming scheme for filenames and node/tool names (aliases added for backward compatibility)
-* componentized into separate lua files for each category of operations
+### Notable Issues Found in Original
+(see also exclamation points in **CHANGELOG.md**)
+* I removed incorrect birth stone months (see "birthstones list.csv" in
+  src. folder for corrections, though month names are removed in this
+  fork).
+* Now stone_with_opal is generated (it was impossible to get by mining
+  before, apparently).
+* Crafting a block back into 9 gemstones is now possible.
 
-
-## Changes:
-'!' (near bottom) is for bugs in 2012 version that are fixed (as opposed to features that were changed/added) in this fork
-* (2017-05-14) Added improved ruby item, mineral, & (realistic mode) block textures
-* (2017-03-23) Added improved peridot (realistic mode) block texture
-* (2017-03-21) Added improved peridot item&mineral textures
-* (2017-03-20) Added improved opal item texture (finished all except optional realistic mode opal block)
-* (2017-03-20) Change garnet from Spessartine to pomegranate seed colored Rhodolite to reflect the original meaning of the word garnet (comes from the word pomegranate) -- see  and  https://www.americangemsociety.org/en/garnet-history
-* (2017-03-18) new textures for garnet: gem (item), mineral, block (realistic style)
-* (2017-03-18) tint of garnet block (classic style) changed to be that of Spessartine garnet
-* (2017-03-13) textures improved: opal mineral overlay, alexandrite classic block
-* (2017-03-13) default block style changed to classic
-* (2017-03-13) now uses settings from server's minetest.conf: birthstones_texture_style (can be realistic or classic)
-* (2017-03-11) added better classic textures for gems where realistic block is not finished yet
-* (2017-03-11) added new texture for emerald: mineral, item
-* (2017-03-10) changed sun square emission from 10 to 100
-* (2017-03-10) new textures for "white diamond": mineral, item [blend file: octagon beveled all but top and bottom by .12 offset]; for topaz: mineral
-* (2017-02-19) new textures for aquamarine: mineral, block, item
-* (2017-02-16) Rerendered Alexandrite block&item; new textures for minerals: Alexandrite, Amethyst; collecting hd versions in etc/hd  
-* (2017-02-16) blend file: completely reworked gem shader (blend version 2)
-* (2017-02-15) blend file: connected ID Mask to Image output (in Compositor nodes) for alpha in rendered image
-* (2017-02-13) Finished working gem and block textures for Topaz, Alexandrite, Amethyst, made in Blender by expertmm
-* (2017-02-13) Made multi-sided Topaz Block (WIP) made in Blender
-* (2017-02-13) Made Blender project for gem rendering (see Developer Notes below for usage)
-* (2017-02-12) Add farming hoes
-* (2017-02-11) Add recipe to create default:diamond from dye:blue + birthstones:diamond for playability (for when other mods like technic need diamonds for things)
-* (2017-02-11) Add crafting recipe to convert block back into 9 gems
-* (2017-02-11) Add Swords & Shovels
-* (2017-02-11) Componentize into separate lua files for each category of operations
-* !(2017-02-11) Make opal possible to get: added missing register_on_generated for changing some stone to opal (see oregen.lua)
-* !(2017-02-11) Change drop for stone_with_topaz from stone_with_topaz to topaz (apparently this didn't cause an issue since craft method had been used)
-* !(2017-02-11) Change drop of ores (to match modern style from default in minetest_game from minetest 0.4.15-git 2017-01), where * below is name:
-```lua
-	-- drop = 'craft "birthstones:*" 1',
-	drop = "birthstones:*",
-```
-* !(2017-02-11) Block needs better pick to be mined: Changed groups:
-```lua
-	-- groups = {cracky = 3}
-	groups = {cracky = 1, level = 3}
-```
-* !(2017-02-11) Ore needs better pick to be mined: changed groups.cracky of all from 3 to 1
-* (2017-02-11) Changed "* Ore" to "Stone with *" (because why copy other people when you can make sense instead)
-* !(2017-02-11) Preliminary step in fixing one-chop axes: changed register_tool time2 and time3 from:
-	[1]=time1-2.0, [2]=2.0-time2, [3]=2.0-time3}
-	to
-	times={[1]=time1/2.0, [2]=time2/2.0, [3]=time3/2.0}
-* !(2017-02-10) Removed month from display names to avoid breaking immersion (draws too much attention to the items having a "label")
-	if re-added, months would have to be corrected anyway as follows (in the original mod, alphabetical order instead of actual birthstone month determined month):
-	see etc/birthstones list.csv
-* !(2017-02-10) Fixed issue where topaz ore was registered twice (didn't seem to cause problems)
-* !(2017-02-10) Capitalized stone name when used within tool display name
-* (2017-02-10) Naming changed to match minetest texture&variable naming scheme
-```
-    (see changes below, where ^* is capitalized mineral name and * is uncapitalized)
-	(aliases added only for backward compatibility--see aliases.lua--doing aliases can be commented in init.lua)
-	Files:
-		^* TO birthstones_* (ITEM)
-		^*_overlay TO birthstones_mineral_* (ORE OVERLAY)
-		^*_block TO birthstones_*_block
-		*_axe to birthstones_tool_*axe
-		*_pick to birthstones_tool_*pick
-		^*_block to birthstones_*_block
-	Variables:
-		birthstones:*ore TO birthstones:stone_with_*
-		"birthstones:".. name .. "_pick" TO "birthstones:pick_"..name
-		"birthstones:".. name .. "_axe" TO "birthstones:axe_"..name
-```
-* (2017-02-10) expertmm fork starting today
+### Other Major Differences from Original
+I made some major changes to make the mod easier to maintain:
+* I changed to minetest_game's naming scheme for filenames and node/tool
+  names (adding aliases for backward compatibility).
+* Componentize into separate Lua files by operation.
 
 ## Known Issues
 * Improve remaining block textures
@@ -102,7 +39,7 @@ Some major changes were done to make the mod easier to maintain:
 (to use Speedcrunch to get values not listed, enter the number without any equation, then paste the formulas above exactly to use that "answer" as a variable--see spreadsheet's "Hardness - Extrapolated" sheet for spreadsheet version of formulas)
 
 ### Things that will be kept the same:
-* You must manually delete the etc folder (source material) from your mods/birthtones folder to reduce download times of the mod when using a server
+* You must manually delete the src folder (source material) from your mods/birthtones folder to reduce download times of the mod when using a server
 * birthstones:diamond will still be present for now (as opposed to becoming an alias for default:diamond), since the birthstones diamond texture looks cool. The display names for all of the items will say "White Diamond". (planned: recipe to make it into regular diamond)
 * No shields & armor (planned as separate mod: birthstones_3d_armor)
 * No arrows (planned as separate mod: birthstones_throwing)
@@ -112,7 +49,7 @@ Some major changes were done to make the mod easier to maintain:
 * Look into changes in "birthstones fixed" at https://forum.minetest.net/viewtopic.php?f=9&t=11497&hilit=birthstones
 * Look into overlap in stone list found in Glooptest
 * Make compatible with glooptest
-```lua
+```Lua
   local glooptest = minetest.get_modpath("glooptest")
   if glooptest then
     register_alias("birthstones:amethyst","glooptest:amethyst_gem")
@@ -147,6 +84,7 @@ Do the following steps to re-render a block:
 * Open the included Blend file in Blender and set the input nodes as follows (if there are two, set one as the input for absorption and turn that up--or experiment; ~ means wasn't plugged into any nodes):
 (v1L you can also tweak whether fresnel, facing, or IsTransmissionRay is Factor for "Glow Mix" node (you can also flip the inputs)
 (v2 you can also tweak whether Tangent, which Light Path output [and whether passes through Reduction node], or nothing [0.00] is used for Glare Mix's Factor; warped block shards can be fitted together then scaled by 1.01 on the x&z [s, shift z, 1.01])
+```
 Name,		GemColor,			IOR**,		Frost,	Gloss,	Clarity,Absorption,	AbspSat,	Glare Mix, 						GlareSat (Glare Saturation)
 ***Alexandrite,567274 to 63152c,1.75,		~,		~,		.95,	1,			1.0,		Gem:Tangent ; Block: Tangent*Reduction; Block east: 0.00, ~
 ***Amethyst,	ad87a6,			1.55,		.5,		0,		0,		1,			.5,			~,								~
@@ -163,16 +101,18 @@ Sapphire,	163f7d,				,		,		,		,		,			,			,
 ***Topaz, 	E5A55F,				1.62,		.5,		.5,		1.0, 	0.0,		0.0,		,
 Zircon,		255f75,				,	,	,		,		,
 ****LampSky changed from ~1 to 3, LampSunSquareYellow changed from .3 to 30, clouds from 1 to 4, starting from only item version of this to all future renders
-[] if in brackets, value is for block version
-! means not that value: though that value is apparent from a reference photo, it is apparently not the true albedo
-{} if in bracurly braces, value is for mineral (ore) version
-** Complete IOR Lists (values averaged or used from)
+```
+Symbols:
+- `[]` if in brackets, value is for block version
+- `!` means not that value: though that value is apparent from a reference photo, it is apparently not the true albedo
+- `{}` if in bracurly braces, value is for mineral (ore) version
+- `**` Complete IOR Lists (values averaged or used from)
   http://forums.cgsociety.org/archive/index.php?t-513458.html
   http://www.gemselect.com/gem-info/refractive-index.php (use this one--has double refraction info)
-*** old shader (usually Gem2, or sometimes Gem) was used as opposed to Gem3 (Frost was called Scatter, but it wasn't actually volumetric scatter in Gem shaders 1-2)
+- `***` old shader (usually Gem2, or sometimes Gem) was used as opposed to Gem3 (Frost was called Scatter, but it wasn't actually volumetric scatter in Gem shaders 1-2)
 - where '-' appears in IOR column, double refraction is used [different values in each IOR value input node])
-Starting with emerald, block is rotated by 90 on z
-pom-colored means pomegranate-seed-colored
+- Starting with **Emerald**, block is rotated by 90 on z
+- pom-colored means pomegranate-seed-colored
 
 Take note that this list is in alphabetical order (like birthstones-mod git 2012) for convenience, not in actual birthstone month order.
 * Keep default resolution of 32x32 (must be full bleed then cropped to 16x16 manually to avoid edge issues with cycles)
@@ -196,52 +136,51 @@ To make a Gem:
 * To use existing Block Shards, keep in mind that for Block Shard Hex Pointed, Object data, mesh name can be changed between "BlockShardHexFlatSide" and "BlockShardHexPointed"
 
 ### Special Thanks
+- [How to Create a Rock in Blender Using Built-In
+  Textures](https://www.youtube.com/watch?v=5v8pzsYImc8)
+  by Blender Smoothie
 
-How to Create a Rock in Blender Using Built-In Textures
-https://www.youtube.com/watch?v=5v8pzsYImc8
-by Blender Smoothie 
+- [Blender - shiny glass sculpture - Cycles render -
+  Zeitfreund](https://www.youtube.com/watch?v=jDHYQUj3N90)
+  by Zeitfreund
 
-Blender - shiny glass sculpture - Cycles render - Zeitfreund
-https://www.youtube.com/watch?v=jDHYQUj3N90
-by Zeitfreund
-
-Cycles' Volume Materials
-https://www.youtube.com/watch?v=CU_igW_1ZXs
-by EnigmaToots
+- [Cycles' Volume
+  Materials](https://www.youtube.com/watch?v=CU_igW_1ZXs)
+  by EnigmaToots
 
 ### Possibly helpful other tutorials
-(basis for Gem1 material)
-Blender gem tutorial
-https://www.youtube.com/watch?v=3EN6mAFDqaI
-by Marijus Jacevičius
+- (basis for Gem1 material)
+  [Blender gem tutorial](https://www.youtube.com/watch?v=3EN6mAFDqaI)
+  by Marijus Jacevičius
 
-(additional influence on Gem2 material):
-Creating advanced shaders in Blender / cycles - Flat
-https://www.youtube.com/watch?v=nnpvFbvRSyM&t=1344s
-by Thornton Strolia
+- (additional influence on Gem2 material):
+  [Creating advanced shaders in Blender / cycles -
+  Flat](https://www.youtube.com/watch?v=nnpvFbvRSyM&t=1344s)
+  by Thornton Strolia
 
-(unused, but can be used for color diffraction)
-Blender Quick Tip #4 | Diamonds in Blender
-https://www.youtube.com/watch?v=4sk6RFcORd0
-The Digital M
+- (unused, but can be used for color diffraction)
+  [Blender Quick Tip #4 | Diamonds in
+  Blender](https://www.youtube.com/watch?v=4sk6RFcORd0)
+  by The Digital M
 
-Gemstone (Tutorial)
-https://www.youtube.com/watch?v=I4PmptWMA08&t=8s
-by toki FX
+- [Gemstone
+  (Tutorial)](https://www.youtube.com/watch?v=I4PmptWMA08&t=8s)
+  by toki FX
 
 ## Minetest 2017 API notes
-(see http://wiki.minetest.net/Groups and https://github.com/minetest/minetest/blob/142e2d3b74ad886eed83b0fc9d6cfea100dae10a/doc/lua_api.txt#L736 )
+(see <http://wiki.minetest.net/Groups> and
+<https://github.com/minetest/minetest/blob/142e2d3b74ad886eed83b0fc9d6cfea100dae10a/doc/lua_api.txt#L736>)
 ### groupcaps (in tool_capabilities dict in register_tool 2nd param dict): a dictionary of groupcap dictionaries such as:
-* choppy: chops wood
-* snappy: leaves and other thin materials -- possible with sword, but wears sword out quickly
-* fleshy: damage mobs/players
-* crumbly: shovels etc
-* cracky: picks etc
-(and more unrelated to this mod)
+- choppy: chops wood
+- snappy: leaves and other thin materials -- possible with sword, but wears sword out quickly
+- fleshy: damage mobs/players
+- crumbly: shovels etc.
+- cracky: picks etc.
+- (and more unrelated to this mod)
 
 ### register_node:
-http://dev.minetest.net/minetest.register_node
-http://dev.minetest.net/Groups
-* groups.cracky: like other dig types, the value is normally 1 to 3, and 1 requires the best pick to mine.
-* groups.level: prevents being mined by lower level stuff
+<http://dev.minetest.net/minetest.register_node>
+<http://dev.minetest.net/Groups>
+- groups.cracky: like other dig types, the value is normally 1 to 3, and 1 requires the best pick to mine.
+- groups.level: prevents being mined by lower level stuff