Renaming throughout docs and comments

This commit is contained in:
the-real-herowl 2024-05-02 06:04:41 +02:00 committed by teknomunk
parent 4264606609
commit 4b83aaaa77
50 changed files with 138 additions and 139 deletions

4
API.md

@ -31,7 +31,7 @@ All nodes can have these fields:
Use the `mcl_sounds` mod for the sounds.
## APIs
A lot of things are possible by using one of the APIs in the mods. Many of them are documented in `API.md` files located in the directories of the specific mods. Some use `.txt` files or have some documentation in the comments along the code. Note that not all APIs are documented yet, but it is planned. The following APIs should be more or less stable but keep in mind that MineClone 2 is still unfinished. All directory names are relative to `mods/`
A lot of things are possible by using one of the APIs in the mods. Many of them are documented in `API.md` files located in the directories of the specific mods. Some use `.txt` files or have some documentation in the comments along the code. Note that not all APIs are documented yet, but it is planned. The following APIs should be more or less stable but keep in mind that VoxeLibre is still unfinished. All directory names are relative to `mods/`
### Items
* Doors: `ITEMS/mcl_doors`
@ -54,7 +54,7 @@ API documnetation is included in `ENTITIES/mcl_mobs/api.txt`.
This mod includes modificiations from the original Mobs Redo. Some items have been removed or moved to other mods.
The API is mostly identical, but a few features have been added. Compability is not really a goal,
but function and attribute names of Mobs Redo 1.41 are kept.
If you have code for a mod which works fine under Mobs Redo, it should be easy to make it work in MineClone 2,
If you have code for a mod which works fine under Mobs Redo, it should be easy to make it work in VoxeLibre.
chances are good that it works out of the box.
### Help

@ -133,8 +133,8 @@
## Music
* Jordach for the jukebox music compilation from Big Freaking Dig
* Dark Reaven Music (https://soundcloud.com/dark-reaven-music) for the main menu theme (Calmed Cube) and Traitor (horizonchris96), which is licensed under https://creativecommons.org/licenses/by-sa/3.0/
* Jester for helping to finely tune MineClone2 (https://www.youtube.com/@Jester-8-bit). Songs: Hailing Forest, Gift, 0dd BL0ck, Flock of One (License CC BY-SA 4.0)
* Exhale & Tim Unwin for some wonderful MineClone2 tracks (https://www.youtube.com/channel/UClFo_JDWoG4NGrPQY0JPD_g). Songs: Valley of Ghosts, Lonely Blossom, Farmer (License CC BY-SA 4.0)
* Jester for helping to finely tune VoxeLibre (https://www.youtube.com/@Jester-8-bit). Songs: Hailing Forest, Gift, 0dd BL0ck, Flock of One (License CC BY-SA 4.0)
* Exhale & Tim Unwin for some wonderful VoxeLibre tracks (https://www.youtube.com/channel/UClFo_JDWoG4NGrPQY0JPD_g). Songs: Valley of Ghosts, Lonely Blossom, Farmer (License CC BY-SA 4.0)
* Diminixed for 3 fantastic tracks and remastering and leveling volumes. Songs: Afternoon Lullaby (pianowtune02), Spooled (ambientwip02), Never Grow Up (License CC BY-SA 4.0)
## Original Mod Authors

Binary file not shown.

Binary file not shown.

Binary file not shown.

@ -1,9 +1,9 @@
# Making Textures In Mineclone2
# Making Textures In VoxeLibre
Textures are a crucial asset for all items, nodes, and models in mineclone2. This document is for artist who would like to make and modify textures for mineclone2. While no means comprehensive, this document contains the basic important information for beginners to get started with texture curation and optimization.
Textures are a crucial asset for all items, nodes, and models in VoxeLibre. This document is for artist who would like to make and modify textures for VoxeLibre. While no means comprehensive, this document contains the basic important information for beginners to get started with texture curation and optimization.
## Minetest Wiki
For more detailed information on creating and modifing texture packs for Minetest/Mineclone2, please visit the Minetest wiki's page on creating a texture pack. Click [here](https://wiki.minetest.net/Creating_texture_packs) to view the wiki page on creating texture packs.
For more detailed information on creating and modifing texture packs for Minetest/VoxeLibre, please visit the Minetest wiki's page on creating a texture pack. Click [here](https://wiki.minetest.net/Creating_texture_packs) to view the wiki page on creating texture packs.
## GIMP Tutorials Pixel Art Guide
GIMP Tutorials has an excellent guide to making pixel art in GIMP. If you would like further clarification as well as screenshots for what we are about to cover, it is an excellent resource to turn to. Click [here](https://thegimptutorials.com/how-to-make-pixel-art/) to view the guide

@ -1,4 +1,4 @@
title = MineClone 2
title = VoxeLibre
description = A survival sandbox game. Survive, gather, hunt, build, explore, and do much more.
disallowed_mapgens = v6
version=0.87.0-SNAPSHOT

@ -16,7 +16,7 @@ information.
How the mod is used
===================
In MineClone 2, all diggable nodes have the hardness set in the custom field
In VoxeLibre, all diggable nodes have the hardness set in the custom field
"_mcl_hardness" (0 by default). These values are used together with digging
groups by this mod to create the correct digging times for nodes. Digging
groups are registered using the following code:

@ -1,3 +1,3 @@
name = _mcl_autogroup
author = ryvnf
description = MineClone 2 core mod which automatically adds groups to all items. Very important for digging times.
description = VoxeLibre core mod which automatically adds groups to all items. Very important for digging times.

@ -1,5 +1,5 @@
-- Overrides the builtin minetest.check_single_for_falling.
-- We need to do this in order to handle nodes in mineclone specific groups
-- We need to do this in order to handle nodes in VoxeLibre specific groups
-- "supported_node" and "attached_node_facedir".
--
-- Nodes in group "supported_node" can be placed on any node that does not

@ -1,3 +1,3 @@
name = mcl_autogroup
author = ryvnf
description = MineClone 2 core mod which automatically adds groups to all items. Very important for digging times.
description = VoxeLibre core mod which automatically adds groups to all items. Very important for digging times.

@ -1,8 +1,8 @@
--[[
Explosion API mod for Minetest (adapted to MineClone 2)
Explosion API mod for Minetest (adapted to VoxeLibre)
This mod is based on the Minetest explosion API mod, but has been changed
to have the same explosion mechanics as Minecraft and work with MineClone.
to have the same explosion mechanics as Minecraft and work with VoxeLibre
The computation-intensive parts of the mod has been optimized to allow for
larger explosions and faster world updating.

@ -183,7 +183,7 @@ mcl_vars.mg_end_exit_portal_pos = vector.new(0, mcl_vars.mg_end_min + 71, 0)
mcl_vars.mg_realm_barrier_overworld_end_max = mcl_vars.mg_end_max
mcl_vars.mg_realm_barrier_overworld_end_min = mcl_vars.mg_end_max - 11
-- Use MineClone 2-style dungeons
-- Use VoxeLibre-style dungeons
mcl_vars.mg_dungeons = true
-- Set default stack sizes

@ -1,3 +1,3 @@
name = mcl_init
author = Wuzzy
description = Initialization mod of MineClone 2. Defines some common shared variables and sets up initial default settings which have to be set at the beginning.
description = Initialization mod of VoxeLibre. Defines some common shared variables and sets up initial default settings which have to be set at the beginning.

@ -1,4 +1,4 @@
# Oxidization API for MineClone 2
# Oxidization API for VoxeLibre
This mods adds the oxidization api, so that modders can easily use the same features that copper uses.
## API

@ -1,4 +1,4 @@
name = mcl_oxidation
title = Oxidation API for MineClone 2
title = Oxidation API for VoxeLibre
author = PrairieWind, N011, Michael
description = API to allow oxidizing different nodes.

@ -1,3 +1,2 @@
name = mcl_particles
author = Wuzzy
description = Contains particle images of MineClone 2. No code.

@ -1,3 +1,3 @@
name = mcl_sounds
author = Wuzzy
description = This mod contains the core sounds of MineClone 2 as well as helper function for mods to access them.
description = This mod contains the core sounds of VoxeLibre as well as helper function for mods to access them.

@ -1,4 +1,4 @@
name = mcl_util
author = Wuzzy
description = Helper functions for MineClone 2.
description = Helper functions for VoxeLibre.
depends = mcl_init

@ -31,7 +31,7 @@ This function return the Minecraft dimension of <pos> ("overworld", "nether" or
* pos: position
## mcl_worlds.layer_to_y(layer, mc_dimension)
Takes a Minecraft layer and a “dimension” name and returns the corresponding Y coordinate for MineClone 2.
Takes a Minecraft layer and a “dimension” name and returns the corresponding Y coordinate for VoxeLibre.
mc_dimension can be "overworld", "nether", "end" (default: "overworld").
* layer: int

@ -58,7 +58,7 @@ local pos_to_dimension = mcl_worlds.pos_to_dimension
-- Takes a Minecraft layer and a “dimension” name
-- and returns the corresponding Y coordinate for
-- MineClone 2.
-- VoxeLibre
-- mc_dimension is one of "overworld", "nether", "end" (default: "overworld").
function mcl_worlds.layer_to_y(layer, mc_dimension)
if mc_dimension == "overworld" or mc_dimension == nil then

@ -10,7 +10,7 @@ License of boat model:
GNU GPLv3 <https://www.gnu.org/licenses/gpl-3.0.html>
## Textures
See the main MineClone 2 README.md file to learn more.
See the main VoxeLibre README.md file to learn more.
## Code
Code based on Minetest Game, licensed under the MIT License (MIT).

@ -1,4 +1,4 @@
name = mcl_burning
description = Burning Objects for MineClone2
description = Burning Objects for VoxeLibre
author = Fleckenstein
depends = mcl_weather

@ -1,6 +1,6 @@
# mcl_dripping
Dripping Mod by kddekadenz, modified for MineClone 2 by Wuzzy, NO11 and AFCM
Dripping Mod by kddekadenz, modified for VoxeLibre by Wuzzy, NO11 and AFCM
## Manual

@ -1,7 +1,7 @@
local mob_class = mcl_mobs.mob_class
local mob_class_meta = {__index = mcl_mobs.mob_class}
local math, vector, minetest, mcl_mobs = math, vector, minetest, mcl_mobs
-- API for Mobs Redo: MineClone 2 Edition (MRM)
-- API for Mobs Redo: VoxeLibre Edition
local PATHFINDING = "gowp"
local CRASH_WARN_FREQUENCY = 60
@ -473,7 +473,7 @@ local function warn_user_error ()
if time_since_warning > CRASH_WARN_FREQUENCY then
last_crash_warn_time = current_time
minetest.log("A game crashing bug was prevented. Please provide debug.log information to MineClone2 dev team for investigation. (Search for: --- Bug report start)")
minetest.log("A game crashing bug was prevented. Please provide debug.log information to VoxeLibre dev team for investigation. (Search for: --- Bug report start)")
end
end

@ -1,5 +1,5 @@
Mobs Redo: MineClone 2 Edition
Mobs Redo: VoxeLibre Edition
API documentation
==============================
@ -231,7 +231,7 @@ functions needed for the mob to work properly which contains the following:
MineClone 2 extensions:
VoxeLibre extensions:
'spawn_class' Classification of mod for the spawning algorithm:
"hostile", "passive", "ambient" or "water"
@ -434,7 +434,7 @@ true the mob will not spawn.
'name' is the name of the animal/monster
MineClone 2 extensions
VoxeLibre extensions
----------------------
mcl_mobs:spawn_child(pos, mob_type)
@ -524,7 +524,7 @@ Does nothing and returns false.
This function is provided for compability with Mobs Redo for an attempt to
capture a mob.
Mobs cannot be captured in MineClone 2.
Mobs cannot be captured in VoxeLibre.
In Mobs Redo, this is generally called inside the on_rightclick section of the mob
api code, it provides a chance of capturing the mob. See Mobs Redo documentation

@ -1,5 +1,5 @@
Mobs Redo: MineClone 2 Edition
Mobs Redo: VoxeLibre Edition
Based on Mobs Redo from TenPlus1
Built from PilzAdam's original Simple Mobs with additional mobs by KrupnoPavel, Zeg9, ExeterDad and AspireMint.

@ -1,4 +1,4 @@
name = mcl_wither_spawning
description = Wither Spawning for MineClone2
description = Wither Spawning for VoxeLibre
author = Fleckenstein
depends = mobs_mc, mcl_heads

@ -1,2 +1,2 @@
name = ENTITIES
description = Meta-modpack containing entity-related mods for MineClone 2
description = Meta-modpack containing entity-related mods for VoxeLibre

@ -1,5 +1,5 @@
# lightning
Lightning mod for MineClone2 with the following API:
Lightning mod for VoxeLibre with the following API:
## lightning.register_on_strike(function(pos, pos2, objects))
Custom function called when a lightning strikes.

@ -1,7 +1,7 @@
--[[
Copyright (C) 2016 - Auke Kok <sofar@foo-projects.org>
Adapted by MineClone2 contributors
Adapted by VoxeLibre contributors
"lightning" is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as

@ -1,6 +1,6 @@
`mcl_weather`
=======================
Weather mod for MineClone 2. Forked from the `weather_pack` mod by xeranas.
Weather mod for VoxeLibre. Forked from the `weather_pack` mod by xeranas.
Weathers included
-----------------------

@ -1,2 +1,2 @@
name = ENVIRONMENT
description = Meta-modpack containing environment and nature-related mods for MineClone 2
description = Meta-modpack containing environment and nature-related mods for VoxeLibre

@ -1,5 +1,5 @@
# Help
MineClone 2 uses some of the mods found in the Help modpack by Wuzzy.
VoxeLibre uses some of the mods found in the Help modpack by Wuzzy.
The goal of this modpack is to make using Minetest and mods easier for both
newcomers and advanced users.
@ -11,7 +11,7 @@ directly into mods (via `doc_items`).
More information is given in the respective mods.
Overview of the mods used in MineClone 2:
Overview of the mods used in VoxeLibre:
* `doc`: Documentation System. Core API and user interface. Mods can add arbitrary categories and entries
* `doc_items`: Item Help. Adds automatically generated help texts for items and an API

@ -1,4 +1,4 @@
# Crafting Guide (MineClone 2 edition)
# Crafting Guide (VoxeLibre edition)
#### `mcl_craftguide` is based on, `craftguide` the most comprehensive crafting guide on Minetest.
#### Consult the [Minetest Wiki](http://wiki.minetest.net/Crafting_guide) for more details.

@ -1,4 +1,4 @@
name = mcl_doc
author = Wuzzy
description = This MineClone 2 mod sets up and configures the Help modpack mods to tailor the help towards MineClone 2.
description = This VoxeLibre mod sets up and configures the Help modpack mods to tailor the help towards VoxeLibre2.
depends = doc, doc_items

@ -3,7 +3,7 @@
A faithful Open Source clone of Minecraft=Ein treuer Open-Source-Klon von Minecraft
Contributors=Mitwirkende
Creator of MineClone=Schöpfer von MineClone
Creator of MineClone2=Schöpfer von MineClone2
Creator of VoxeLibre=Schöpfer von VoxeLibre
Developers=Entwickler
Jump to speed up (additionally sprint)=Springen, um zu beschleunigen (zusätzlich sprinten)
Maintainers=Betreuer

@ -3,7 +3,7 @@
A faithful Open Source clone of Minecraft=
Contributors=
Creator of MineClone=
Creator of MineClone2=
Creator of VoxeLibre=
Developers=
Jump to speed up (additionally sprint)=
Maintainers=

@ -3,7 +3,7 @@
A faithful Open Source clone of Minecraft=Un clone open source de Minecraft
Contributors=Contributeurs
Creator of MineClone=Créateur de MineClone
Creator of MineClone2=Créateur de MineClone2
Creator of VoxeLibre=Créateur de VoxeLibre
Developers=Développeurs
Past Developers=Anciens Développeurs
Jump to speed up (additionally sprint)=Saut pour accélérer (peut être combiné avec sprint)

@ -3,7 +3,7 @@
A faithful Open Source clone of Minecraft=オープンソースによるマインクラフトの忠実なクローン
Contributors=投稿者
Creator of MineClone=MineClone の創始者
Creator of MineClone2=MineClone2 の創始者
Creator of VoxeLibre=VoxeLibre の創始者
Developers=開発者
Jump to speed up (additionally sprint)=ジャンプでスピードアップ(追加で疾走)
Maintainers=メンテナンス

@ -3,7 +3,7 @@
A faithful Open Source clone of Minecraft=
Contributors=
Creator of MineClone=
Creator of MineClone2=
Creator of VoxeLibre=
Developers=
Jump to speed up (additionally sprint)=
Maintainers=

@ -3,7 +3,7 @@
A faithful Open Source clone of Minecraft=Um clone fiel Open Source do Minecraft
Contributors=Colaboradores
Creator of MineClone=Criador do MineClone
Creator of MineClone2=Criador do MineClone2
Creator of VoxeLibre=Criador do VoxeLibre
Developers=Desenvolvedores
Past Developers=Desenvolvedores Passados
Jump to speed up (additionally sprint)=Pule para acelerar (arrancada adicional)

@ -3,7 +3,7 @@
A faithful Open Source clone of Minecraft=Верный открытый клон Minecraft
Contributors=Контрибьюторы
Creator of MineClone=Создатель MineClone
Creator of MineClone2=Создатель MineClone2
Creator of VoxeLibre=Создатель VoxeLibre
Developers=Разработчики
Past Developers=Бывшие разработчики
Jump to speed up (additionally sprint)=[Прыжок] или [Спринт] для промотки вперед

@ -3,7 +3,7 @@
A faithful Open Source clone of Minecraft=
Contributors=
Creator of MineClone=
Creator of MineClone2=
Creator of VoxeLibre=
Developers=
Past Developers=
Jump to speed up (additionally sprint)=

@ -5,7 +5,7 @@ return {
{S("Creator of MineClone"), 0x0A9400, {
"davedevils",
}},
{S("Creator of MineClone2"), 0xFBF837, {
{S("Creator of VoxeLibre"), 0xFBF837, {
"Wuzzy",
}},
{S("Maintainers"), 0xFF51D5, {
@ -135,8 +135,8 @@ return {
{S("Music"), 0xA60014, {
"Jordach for the jukebox music compilation from Big Freaking Dig",
"Dark Reaven Music (https://soundcloud.com/dark-reaven-music) for the main menu theme (Calmed Cube) and Traitor (horizonchris96), which is licensed under https://creativecommons.org/licenses/by-sa/3.0/",
"Jester for helping to finely tune MineClone2 (https://www.youtube.com/@Jester-8-bit). Songs: Hailing Forest, Gift, 0dd BL0ck, Flock of One (License CC BY-SA 4.0)",
"Exhale & Tim Unwin for some wonderful MineClone2 tracks (https://www.youtube.com/channel/UClFo_JDWoG4NGrPQY0JPD_g). Songs: Valley of Ghosts, Lonely Blossom, Farmer (License CC BY-SA 4.0)",
"Jester for helping to finely tune VoxeLibre (https://www.youtube.com/@Jester-8-bit). Songs: Hailing Forest, Gift, 0dd BL0ck, Flock of One (License CC BY-SA 4.0)",
"Exhale & Tim Unwin for some wonderful VoxeLibre tracks (https://www.youtube.com/channel/UClFo_JDWoG4NGrPQY0JPD_g). Songs: Valley of Ghosts, Lonely Blossom, Farmer (License CC BY-SA 4.0)",
"Diminixed for 3 fantastic tracks and remastering and leveling volumes. Songs: Afternoon Lullaby (pianowtune02), Spooled (ambientwip02), Never Grow Up (License CC BY-SA 4.0)",
}},
{S("Original Mod Authors"), 0x343434, {

@ -1,4 +1,4 @@
# MineClone2 Formspec API
# VoxeLibre Formspec API
## `mcl_formspec.label_color`

@ -1,10 +1,10 @@
# MineClone2 Formspec Guide
# VoxeLibre Formspec Guide
**_This guide will teach you the rules for creating formspecs for the MineClone2 game._**
**_This guide will teach you the rules for creating formspecs for the VoxeLibre game._**
Formspecs are an important part of game and mod development.
First of all, MineClone2 aims to support ONLY last formspec version. Many utility functions will not work with formspec v1 or v2.
First of all, VoxeLibre aims to support ONLY last formspec version. Many utility functions will not work with formspec v1 or v2.
The typical width of an 9 slots width inventory formspec is `0.375 + 9 + ((9-1) * 0.25) + 0.375 = 11.75`

@ -226,7 +226,7 @@ mcl_armor.update(obj)
Armors can be enchanted in most cases.
The enchanting part of MineClone2 is separated from the armor part, but closely linked.
The enchanting part of VoxeLibre is separated from the armor part, but closely linked.
Existing armor enchantments in Minecraft improve most of the time how the armor protect the entity from damage.

@ -1,6 +1,6 @@
mcl_bells
---------
Village bells for MineClone2, originally imported from mcl5, heavily modified by cora.
Village bells for VoxeLibre, originally imported from mcl5, heavily modified by cora.
License of media files
----------------------

@ -11,7 +11,7 @@ from libtextureconverter.common import convert_resource_packs
def main():
make_texture_pack = True
parser = argparse.ArgumentParser(description=f"This is the official MineClone 2 Texture Converter. This will convert textures from Minecraft resource packs to a Minetest texture pack. Supported Minecraft version: {SUPPORTED_MINECRAFT_VERSION} (Java Edition)")
parser = argparse.ArgumentParser(description=f"This is the official VoxeLibre Texture Converter. This will convert textures from Minecraft resource packs to a Minetest texture pack. Supported Minecraft version: {SUPPORTED_MINECRAFT_VERSION} (Java Edition)")
parser.add_argument("-i", "--input", help="Directory of Minecraft resource pack to convert")
parser.add_argument("-o", "--output", default=working_dir, help="Directory in which to put the resulting Minetest texture pack")
parser.add_argument("-p", "--pixel-size", type=int, help="Size (in pixels) of the original textures")