forked from VoxeLibre/VoxeLibre
Compare commits
1 Commits
master
...
water_foot
| Author | SHA1 | Date |
|---|---|---|
iliekprogrammar
|
6111f3465a |
|
|
@ -4,7 +4,7 @@ root = true
|
|||
end_of_line = lf
|
||||
|
||||
[*.lua]
|
||||
charset = utf-8
|
||||
charset = utf8
|
||||
indent_style = tab
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
|
|
|||
|
|
@ -1,36 +0,0 @@
|
|||
---
|
||||
|
||||
name: "Bug report"
|
||||
about: "File a bug report"
|
||||
labels:
|
||||
|
||||
- unconfirmed
|
||||
- bug
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
|
||||
Please follow our contributing guidelines first:
|
||||
https://git.minetest.land/MineClone2/MineClone2/src/branch/master/CONTRIBUTING.md#rules-about-both-bugs-and-feature-requests
|
||||
|
||||
By submitting this issue, you agree to follow our Code of Conduct:
|
||||
https://git.minetest.land/MineClone2/MineClone2/src/branch/master/CODE_OF_CONDUCT.md
|
||||
-->
|
||||
|
||||
<!--
|
||||
What version of VoxeLibre are you using? We do not provide support for outdated versions of VoxeLibre.
|
||||
Current latest version is listed here, at the top:
|
||||
https://git.minetest.land/MineClone2/MineClone2/tags
|
||||
-->
|
||||
VoxeLibre version:
|
||||
|
||||
### What happened?
|
||||
Report about the bug! Please send large log snippets as an attachement file.
|
||||
|
||||
### What should happen:
|
||||
Tell us what should happen!
|
||||
|
||||
### Steps to reproduce
|
||||
Tell us how we can reproduce the bug!
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
---
|
||||
|
||||
name: "Feature request"
|
||||
about: "File a feature request not in Minecraft"
|
||||
labels:
|
||||
|
||||
- "non-Minecraft feature"
|
||||
- "needs discussion"
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Got a new non-Minecraft feature request? Explain to us why we should consider your idea.
|
||||
|
||||
Please follow our contributing guidelines first:
|
||||
https://git.minetest.land/MineClone2/MineClone2/src/branch/master/CONTRIBUTING.md#rules-about-both-bugs-and-feature-requests
|
||||
|
||||
By submitting this issue, you agree to follow our Code of Conduct:
|
||||
https://git.minetest.land/MineClone2/MineClone2/src/branch/master/CODE_OF_CONDUCT.md
|
||||
-->
|
||||
|
||||
### Feature
|
||||
Tell us about your requested feature not in Minecraft!
|
||||
|
||||
### Why
|
||||
Tell us why should we implement it!
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
---
|
||||
|
||||
name: "Missing Feature request"
|
||||
about: "File a missing feature request in Minecraft but not in MineClone2"
|
||||
labels:
|
||||
|
||||
- "missing feature"
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Thanks for taking the time to fill out this missing feature request!
|
||||
|
||||
Please follow our contributing guidelines first:
|
||||
https://git.minetest.land/MineClone2/MineClone2/src/branch/master/CONTRIBUTING.md#rules-about-both-bugs-and-feature-requests
|
||||
|
||||
By submitting this issue, you agree to follow our Code of Conduct:
|
||||
https://git.minetest.land/MineClone2/MineClone2/src/branch/master/CODE_OF_CONDUCT.md
|
||||
-->
|
||||
|
||||
### Current feature in Minecraft
|
||||
Tell us about the feature currently in Minecraft! What is it like on Minecraft?
|
||||
|
||||
### Current feature in VoxeLibre
|
||||
Tell us about the feature currently in VoxeLibre! What is different?
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
---
|
||||
|
||||
name: "Pull request"
|
||||
about: "Submit a pull request"
|
||||
labels:
|
||||
|
||||
---
|
||||
|
||||
<!--
|
||||
Please follow our contributing guidelines first:
|
||||
https://git.minetest.land/MineClone2/MineClone2/src/branch/master/CONTRIBUTING.md#how-you-can-help-as-a-programmer
|
||||
|
||||
By submitting this pull request, you agree to follow our Code of Conduct:
|
||||
https://git.minetest.land/MineClone2/MineClone2/src/branch/master/CODE_OF_CONDUCT.md
|
||||
-->
|
||||
|
||||
Tell us about your pull request! Reference related issues, if necessary
|
||||
|
||||
### Testing
|
||||
Tell us how to test your changes!
|
||||
|
|
@ -4,7 +4,3 @@
|
|||
*.blend2
|
||||
*.blend3
|
||||
/.idea/
|
||||
*.xcf
|
||||
.Rproj.user
|
||||
prompt.txt
|
||||
__pycache__
|
||||
|
|
|
|||
24
.luacheckrc
24
.luacheckrc
|
|
@ -1,12 +1,10 @@
|
|||
---@diagnostic disable
|
||||
|
||||
unused_args = false
|
||||
allow_defined_top = true
|
||||
max_line_length = false
|
||||
redefined = false
|
||||
|
||||
globals = {
|
||||
"minetest", "core",
|
||||
"minetest", "core",
|
||||
}
|
||||
|
||||
read_globals = {
|
||||
|
|
@ -42,16 +40,16 @@ read_globals = {
|
|||
"factorial"
|
||||
}
|
||||
},
|
||||
------
|
||||
--MODS
|
||||
------
|
||||
------
|
||||
--MODS
|
||||
------
|
||||
|
||||
--GENERAL
|
||||
"default",
|
||||
--GENERAL
|
||||
"default",
|
||||
|
||||
--ENTITIES
|
||||
"cmi",
|
||||
--ENTITIES
|
||||
"cmi",
|
||||
|
||||
--HUD
|
||||
"sfinv", "sfinv_buttons", "unified_inventory", "cmsg", "inventory_plus",
|
||||
}
|
||||
--HUD
|
||||
"sfinv", "sfinv_buttons", "unified_inventory", "cmsg", "inventory_plus",
|
||||
}
|
||||
22
.luarc.json
22
.luarc.json
|
|
@ -1,22 +0,0 @@
|
|||
{
|
||||
"runtime.version": "LuaJIT",
|
||||
"diagnostics": { "disable": ["lowercase-global"] },
|
||||
"diagnostics.globals": [
|
||||
"minetest",
|
||||
"dump",
|
||||
"dump2",
|
||||
"Raycast",
|
||||
"Settings",
|
||||
"PseudoRandom",
|
||||
"PerlinNoise",
|
||||
"VoxelManip",
|
||||
"SecureRandom",
|
||||
"VoxelArea",
|
||||
"PerlinNoiseMap",
|
||||
"PcgRandom",
|
||||
"ItemStack",
|
||||
"AreaStore",
|
||||
"vector"
|
||||
],
|
||||
"workspace.ignoreDir": [".luacheckrc"]
|
||||
}
|
||||
15
API.md
15
API.md
|
|
@ -1,10 +1,10 @@
|
|||
# API
|
||||
## Groups
|
||||
VoxeLibre makes very extensive use of groups. Making sure your items and objects have the correct group memberships is very important.
|
||||
MineClone 2 makes very extensive use of groups. Making sure your items and objects have the correct group memberships is very important.
|
||||
Groups are explained in `GROUPS.md`.
|
||||
|
||||
## Mod naming convention
|
||||
Mods mods in VoxeLibre follow a simple naming convention: Mods with the prefix "`vl_`" and “`mcl_`” are specific to VoxeLibre (formerly known as MineClone2), although they may be based on an existing standalone. Mods which lack this prefix are *usually* verbatim copies of a standalone mod. Some modifications may still have been applied, but the APIs are held compatible.
|
||||
Mods mods in MineClone 2 follow a simple naming convention: Mods with the prefix “`mcl_`” are specific to MineClone 2, although they may be based on an existing standalone. Mods which lack this prefix are *usually* verbatim copies of a standalone mod. Some modifications may still have been applied, but the APIs are held compatible.
|
||||
|
||||
## Adding items
|
||||
### Special fields
|
||||
|
|
@ -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 VoxeLibre 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. 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/`
|
||||
|
||||
### Items
|
||||
* Doors: `ITEMS/mcl_doors`
|
||||
|
|
@ -41,12 +41,12 @@ A lot of things are possible by using one of the APIs in the mods. Many of them
|
|||
* Beds: `ITEMS/mcl_beds`
|
||||
* Buckets: `ITEMS/mcl_buckets`
|
||||
* Dispenser support: `ITEMS/REDSTONE/mcl_dispensers`
|
||||
* Campfires: `ITEMS/mcl_campfires`
|
||||
|
||||
### Mobs
|
||||
* Mobs: `ENTITIES/mcl_mobs`
|
||||
|
||||
VoxeLibre uses its own mobs framework, which is a fork of Mobs Redo [`mobs`] by TenPlus1.
|
||||
MineClone 2 uses its own mobs framework, called “Mobs Redo: MineClone 2 Edition” or “MRM” for short.
|
||||
This is a fork of Mobs Redo [`mobs`] by TenPlus1.
|
||||
|
||||
You can add your own mobs, spawn eggs and spawning rules with this mod.
|
||||
API documnetation is included in `ENTITIES/mcl_mobs/api.txt`.
|
||||
|
|
@ -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 VoxeLibre.
|
||||
If you have code for a mod which works fine under Mobs Redo, it should be easy to make it work in MineClone 2,
|
||||
chances are good that it works out of the box.
|
||||
|
||||
### Help
|
||||
|
|
@ -67,7 +67,6 @@ chances are good that it works out of the box.
|
|||
|
||||
### Utility APIs
|
||||
* Change player physics: `PLAYER/playerphysics`
|
||||
* Change player FOV: `PLAYER/mcl_fovapi`
|
||||
* Select random treasures: `CORE/mcl_loot`
|
||||
* Get flowing direction of liquids: `CORE/flowlib`
|
||||
* `on_walk_over` callback for nodes: `CORE/walkover`
|
||||
|
|
@ -77,7 +76,7 @@ chances are good that it works out of the box.
|
|||
* Flowers and flower pots
|
||||
|
||||
### Unstable APIs
|
||||
The following APIs may be subject to change in the future. You could already use these APIs but there will probably be breaking changes in the future, or the API is not as fleshed out as it should be. Use at your own risk!
|
||||
The following APIs may be subject to change in future. You could already use these APIs but there will probably be breaking changes in the future, or the API is not as fleshed out as it should be. Use at your own risk!
|
||||
|
||||
* Panes (like glass panes and iron bars): `ITEMS/xpanes`
|
||||
* `_on_ignite` callback: `ITEMS/mcl_fire`
|
||||
|
|
|
|||
216
CONTRIBUTING.md
216
CONTRIBUTING.md
|
|
@ -1,47 +1,49 @@
|
|||
# Contributing to VoxeLibre
|
||||
So you want to contribute to VoxeLibre?
|
||||
# Contributing to MineClone2
|
||||
So you want to contribute to MineClone2?
|
||||
Wow, thank you! :-)
|
||||
|
||||
VoxeLibre is maintained by AncientMariner and Herowl. If you have any
|
||||
problems or questions, contact us on Discord/Matrix (See Links section below).
|
||||
MineClone2 is maintained by Nicu and Cora. If you have any
|
||||
problems or questions, contact us (See Links section below).
|
||||
|
||||
You can help with VoxeLibre's development in many different ways,
|
||||
You can help with MineClone2's development in many different ways,
|
||||
whether you're a programmer or not.
|
||||
|
||||
## VoxeLibre's development target is to...
|
||||
- Create a stable, peformant, moddable, free/libre game inspired by Minecraft
|
||||
using the Minetest engine, usable in both singleplayer and multiplayer.
|
||||
- Currently, a lot of features are already implemented.
|
||||
## MineClone2's development target is to...
|
||||
- Crucially, create a stable, moddable, free/libre clone of Minecraft
|
||||
based on the Minetest engine with polished features, usable in both
|
||||
singleplayer and multiplayer. Currently, a lot of Minecraft features
|
||||
are already implemented.
|
||||
Polishing existing features is always welcome.
|
||||
|
||||
## Links
|
||||
* [Mesehub](https://git.minetest.land/VoxeLibre/VoxeLibre)
|
||||
* [Mesehub](https://git.minetest.land/MineClone2/MineClone2)
|
||||
* [Discord](https://discord.gg/xE4z8EEpDC)
|
||||
* [YouTube](https://www.youtube.com/channel/UClI_YcsXMF3KNeJtoBfnk9A)
|
||||
* [Matrix](https://app.element.io/#/room/#voxelibre:matrix.org)
|
||||
* [Reddit](https://www.reddit.com/r/VoxeLibre/)
|
||||
* [IRC](https://web.libera.chat/#mineclone2)
|
||||
* [Matrix](https://app.element.io/#/room/#mc2:matrix.org)
|
||||
* [Reddit](https://www.reddit.com/r/MineClone2/)
|
||||
* [Minetest forums](https://forum.minetest.net/viewtopic.php?f=50&t=16407)
|
||||
* [ContentDB](https://content.minetest.net/packages/wuzzy/mineclone2/)
|
||||
* [OpenCollective](https://opencollective.com/mineclone2)
|
||||
|
||||
## Using git
|
||||
VoxeLibre is developed using the version control system
|
||||
MineClone2 is developed using the version control system
|
||||
[git](https://git-scm.com/). If you want to contribute code to the
|
||||
project, it is **highly recommended** that you learn the git basics.
|
||||
For non-programmers and people who do not plan to contribute code to
|
||||
VoxeLibre, git is not required. However, git is a tool that will be
|
||||
MineClone2, git is not required. However, git is a tool that will be
|
||||
referenced frequently because of its usefulness. As such, it is valuable
|
||||
in learning how git works and its terminology. It can also help you
|
||||
keeping your game updated, and easily test pull requests.
|
||||
|
||||
Look at our wiki for some concrete guides:
|
||||
https://git.minetest.land/VoxeLibre/VoxeLibre/wiki/
|
||||
https://git.minetest.land/MineClone2/MineClone2/wiki/
|
||||
|
||||
## How you can help as a non-programmer
|
||||
As someone who does not know how to write programs in Lua or does not
|
||||
know how to use the Minetest API, you can still help us out a lot. For
|
||||
example, by opening an issue in the
|
||||
[Issue tracker](https://git.minetest.land/VoxeLibre/VoxeLibre/issues),
|
||||
[Issue tracker](https://git.minetest.land/MineClone2/MineClone2/issues),
|
||||
you can report a bug or request a feature.
|
||||
|
||||
### Rules about both bugs and feature requests
|
||||
|
|
@ -59,7 +61,8 @@ actually an issue with Minetest itself, and if it is, head to the
|
|||
[Minetest issue tracker](https://github.com/minetest/minetest/issues)
|
||||
instead.
|
||||
* If you need any help regarding creating a Mesehub account or opening
|
||||
an issue, feel free to ask on the Discord or Matrix space.
|
||||
an issue, feel free to ask on the Discord / Matrix server or the IRC
|
||||
channel.
|
||||
|
||||
The link to the mesehub registration page is: https://git.minetest.land/user/sign_up
|
||||
(It appears to sometimes get lost on the page itsself)
|
||||
|
|
@ -73,7 +76,7 @@ in singleplayer, post a screenshot of the message that Minetest showed
|
|||
when the crash happened (or copy the message into your issue). If you
|
||||
are a server admin, you can find error messages in the log file of the
|
||||
server.
|
||||
* Tell us which VoxeLibre and Minetest versions you are using (from Minetest 5.7 type /ver, for previous versions, check the game.conf or README.md file).
|
||||
* Tell us which MineClone2 and Minetest versions you are using.
|
||||
* Tell us how to reproduce the problem: What you were doing to trigger
|
||||
the bug, e.g. before the crash happened or what causes the faulty
|
||||
behavior.
|
||||
|
|
@ -82,14 +85,14 @@ behavior.
|
|||
* Ensure the requested feature fulfills our development targets and
|
||||
goals.
|
||||
* Begging or excessive attention seeking does not help us in the
|
||||
slightest, and may very well disrupt VoxeLibre development. It's better
|
||||
slightest, and may very well disrupt MineClone2 development. It's better
|
||||
to put that energy into helping or researching the feature in question.
|
||||
After all, we're just volunteers working on our spare time.
|
||||
* Ensure the requested feature has not been implemented in VoxeLibre
|
||||
* Ensure the requested feature has not been implemented in MineClone2
|
||||
latest or development versions.
|
||||
|
||||
### Testing code
|
||||
If you want to help us with speeding up VoxeLibre development and
|
||||
If you want to help us with speeding up MineClone2 development and
|
||||
making the game more stable, a great way to do that is by testing out
|
||||
new features from contributors. For most new things that get into the
|
||||
game, a pull request is created. A pull request is essentially a
|
||||
|
|
@ -101,65 +104,61 @@ tell us if the code works as expected without any issues. Ideally, you
|
|||
would report issues will pull requests similar to when you were
|
||||
reporting bugs that are the mainline (See Reporting bugs section). You
|
||||
can find currently open pull requests here:
|
||||
<https://git.minetest.land/VoxeLibre/VoxeLibre/pulls>. Note that pull
|
||||
<https://git.minetest.land/MineClone2/MineClone2/pulls>. Note that pull
|
||||
requests that start with a `WIP:` are not done yet and therefore could
|
||||
still undergo substantial change. Testing these is still helpful however
|
||||
because that is the reason developers put them up as WIP so other people
|
||||
can have a look at the PR. The wiki has an article with instructions
|
||||
on how to test Pull Requests:
|
||||
<https://git.minetest.land/VoxeLibre/VoxeLibre/wiki/Testing-Pull-Requests>.
|
||||
can have a look at the PR.
|
||||
|
||||
### Contributing assets
|
||||
Due to license problems, VoxeLibre cannot use Minecraft's assets,
|
||||
Due to license problems, MineClone2 cannot use Minecraft's assets,
|
||||
therefore we are always looking for asset contributions.
|
||||
|
||||
To contribute assets, it can be useful to learn git basics and read
|
||||
the section for Programmers of this document, however this is not required.
|
||||
It's also a good idea to join the Discord server and/or Matrix space.
|
||||
It's also a good idea to join the Discord server
|
||||
(or alternatively IRC or Matrix).
|
||||
|
||||
#### Textures
|
||||
For textures we prefer original art, but in the absence of that will accept
|
||||
Pixel Perfection texture pack contributions. Be warned many of the newer
|
||||
textures in it are copies or slight modifications of the original MC textures
|
||||
so great caution needs to be taken when using any textures coming from
|
||||
Minecraft texture packs.
|
||||
For textures we use the Pixel Perfection texture pack. For older Minecraft
|
||||
features that is mostly enough but a lot of the newer textures in it are
|
||||
copies or slight modifications of the original MC textures so great caution
|
||||
needs to be taken when using any textures coming from Minecraft texture
|
||||
packs.
|
||||
If you want to make such contributions, join our Discord server. Demands
|
||||
for textures will be communicated there.
|
||||
|
||||
#### Sounds
|
||||
VoxeLibre currently does not have a consistent way to handle sounds.
|
||||
MineClone2 currently does not have a consistent way to handle sounds.
|
||||
The sounds in the game come from different sources, like the SnowZone
|
||||
resource pack or minetest_game. Unfortunately, VoxeLibre does not play
|
||||
resource pack or minetest_game. Unfortunately, MineClone2 does not play
|
||||
a sound in every situation you would get one in Minecraft. Any help with
|
||||
sounds is greatly appreciated, however if you add new sounds you should
|
||||
probably work together with a programmer, to write the code to actually
|
||||
play these sounds in game. All sounds should be released under an open
|
||||
source license with clear information on the source, licencing and any
|
||||
changes made by the contributor. Use the README files in the mod to
|
||||
communicate this information.
|
||||
play these sounds in game.
|
||||
|
||||
#### 3D Models
|
||||
Many of the 3D Models in VoxeLibre come from
|
||||
Most of the 3D Models in MineClone2 come from
|
||||
[22i's repository](https://github.com/22i/minecraft-voxel-blender-models).
|
||||
Similar to the textures, we need people that can make 3D Models with
|
||||
Blender on demand. Many of the models have to be patched, some new
|
||||
animations have to be added etc.
|
||||
|
||||
#### Crediting
|
||||
Asset contributions will be credited in their mods and their own respective
|
||||
sections in CREDITS.md. If you have commited the results yourself, you will
|
||||
also be credited in the Contributors section.
|
||||
Asset contributions will be credited in their own respective sections in
|
||||
CREDITS.md. If you have commited the results yourself, you will also be
|
||||
credited in the Contributors section.
|
||||
|
||||
### Contributing Translations
|
||||
|
||||
#### Workflow
|
||||
To add/update support for your language to VoxeLibre, you should take
|
||||
To add/update support for your language to MineClone2, you should take
|
||||
the steps documented in the section for Programmers, add/update the
|
||||
translation files of the mods that you want to update. You can add
|
||||
support for all mods, just some of them or only one mod; you can update
|
||||
the translation file entirely or only partly; basically any effort is
|
||||
valued. If your changes are small, you can also send them to developers
|
||||
via E-Mail, Discord or Matrix - they will credit you appropriately.
|
||||
via E-Mail, Discord, IRC or Matrix - they will credit you appropriately.
|
||||
|
||||
#### Things to note
|
||||
You can use the script at `tools/check_translate_files.py` to compare
|
||||
|
|
@ -177,18 +176,13 @@ If you have commited the results yourself, you will also be credited in
|
|||
the Contributors section.
|
||||
|
||||
### Profiling
|
||||
If you own a server, a great way to help us improve VoxeLibre's code
|
||||
If you own a server, a great way to help us improve MineClone2's code
|
||||
is by giving us profiler results. Profiler results give us detailed
|
||||
information about the game's performance and let us know places to
|
||||
investigate optimization issues. This way we can make the game faster.
|
||||
|
||||
#### Using Minetest's profiler
|
||||
We frequently will use profiling to optimise our code. We recommend use of
|
||||
the JIT profiler (RIP Jude) to fully understand performance impact:
|
||||
|
||||
https://content.minetest.net/packages/jwmhjwmh/jitprofiler/
|
||||
|
||||
Minetest also has a built in profiler. Simply set `profiler.load = true` in
|
||||
Minetest has a built in profiler. Simply set `profiler.load = true` in
|
||||
your configuration file and restart the server. After running the server
|
||||
for some time, just run `/profiler save` in chat - then you will find a
|
||||
file in the world directory containing the results. Open a new issue and
|
||||
|
|
@ -202,36 +196,27 @@ decisions. Also, note that a lot of discussion takes place on the
|
|||
Discord server, so it's definitely worth checking it out.
|
||||
|
||||
### Funding
|
||||
You can help pay for our infrastructure (Mesehub) and other unforeseen
|
||||
expenses (in the last few years, only payments for Mesehub have been done)
|
||||
by donating to our OpenCollective link (See Links section).
|
||||
You can help pay for our infrastructure (Mesehub) by donating to our
|
||||
OpenCollective link (See Links section).
|
||||
|
||||
### Crediting
|
||||
If you opened or have contributed to an issue, you receive the
|
||||
`Community` role on our Discord (after asking for it).
|
||||
If you have been an author of a PR that got merged or contributed
|
||||
significantly to art that got merged into the game, you receive the
|
||||
`Contributor` role on our Discord (after asking for it).
|
||||
Please note that what counts as "significant" is decided by Maintainers.
|
||||
OpenCollective Funders are credited in their own section in
|
||||
`CREDITS.md` and receive a special role "Funder" on our discord (unless
|
||||
they have made their donation Incognito).
|
||||
|
||||
## How you can help as a programmer
|
||||
(Almost) all the VoxeLibre development is done using pull requests.
|
||||
(Almost) all the MineClone2 development is done using pull requests.
|
||||
|
||||
### Recommended workflow
|
||||
* Fork the repository (in case you have not already)
|
||||
* Do your change in a new branch
|
||||
* Create a pull request to get your changes merged into master
|
||||
* It is important that conflicts are resolved prior to merging the pull
|
||||
* Keep your pull request up to date by regularly merging upstream. It is
|
||||
imperative that conflicts are resolved prior to merging the pull
|
||||
request.
|
||||
* We update our branches via rebasing. Please avoid merging master into
|
||||
your branch unless it's the only way you can resolve a conflict. We can
|
||||
rebase branches from the GUI if the user has not merged master into the
|
||||
branch.
|
||||
* After the pull request got merged, you can delete the branch if the
|
||||
merger hasn't done this already.
|
||||
* After the pull request got merged, you can delete the branch
|
||||
|
||||
### Discuss first
|
||||
If you feel like a problem needs to fixed or you want to make a new
|
||||
|
|
@ -241,11 +226,11 @@ is no issue on the topic, open one. If there is an issue, tell us that
|
|||
you'd like to take care of it, to avoid duplicate work.
|
||||
|
||||
### Don't hesitate to ask for help
|
||||
We appreciate any contributing effort to VoxeLibre. If you are a
|
||||
relatively new programmer, you can reach us on Discord or Matrix
|
||||
for questions about git, Lua, Minetest API, VoxeLibre codebase or
|
||||
anything related to VoxeLibre. We can help you avoid writing code that
|
||||
would be deemed inadequate, or help you become familiar with VoxeLibre
|
||||
We appreciate any contributing effort to MineClone2. If you are a
|
||||
relatively new programmer, you can reach us on Discord, Matrix or IRC
|
||||
for questions about git, Lua, Minetest API, MineClone2 codebase or
|
||||
anything related to MineClone2. We can help you avoid writing code that
|
||||
would be deemed inadequate, or help you become familiar with MineClone2
|
||||
better, or assist you use development tools.
|
||||
|
||||
### Maintain your own code, even if already got merged
|
||||
|
|
@ -254,52 +239,42 @@ scenarios by testing every time before merging it, but if your merged
|
|||
work causes problems, we ask you fix the issues as soon as possible.
|
||||
|
||||
### Changing Gameplay
|
||||
Pull Requests that change gameplay are always subject to discussion.
|
||||
Opinions from the community on such PRs are valued, and Maintainer
|
||||
should approve the concept (which is usually granted) as well as
|
||||
the implementation (for which changes are often requested for either
|
||||
code quality or game design reasons).
|
||||
Pull Requests that change gameplay have to be properly researched and
|
||||
need to state their sources. These PRs also need Fleckenstein's approval
|
||||
before they are merged.
|
||||
You can use these sources:
|
||||
|
||||
* Testing things inside of Minecraft (Attach screenshots / video footage
|
||||
of the results)
|
||||
* Looking at [Minestom](https://github.com/Minestom/Minestom) code. An open source Minecraft Server implementation
|
||||
* [Official Minecraft Wiki](https://minecraft.fandom.com/wiki/Minecraft_Wiki)
|
||||
(Include a link to the specific page you used)
|
||||
|
||||
### Guidelines
|
||||
|
||||
#### Git Guidelines
|
||||
* Pushing to master is disabled - don't even try it!
|
||||
* Every change is tracked as a PR
|
||||
* All changes require at least one approval from a Developer
|
||||
* Maintainers may merge PRs without formal approval, but should also
|
||||
take others' opinions and testing into account
|
||||
* Pushing to master is disabled - don't even try it.
|
||||
* Every change is tracked as a PR.
|
||||
* All but the tiniest changes require at least one approval from a Developer
|
||||
* To update branches we use rebase not merge (so we don't end up with
|
||||
excessive git bureaucracy commits in master)
|
||||
* We use merge to add the commits from a PR/branch to master
|
||||
* Smaller PRs may be squashed before merging (especially if the commit history
|
||||
on them isn't valuable), but when in doubt prefer merging
|
||||
* Manual merging may be done by a Maintainer if there are technical problems
|
||||
with the branch, with Gitea, or the PR had been merged to from master and
|
||||
the author can't fix it for whatever reason
|
||||
* PR from a fork (usually the author has no contributor/developer privileges)
|
||||
can be retargeted and merged first into a buffer (normal new) branch on the repo
|
||||
when adopted by a Developer, and only later into master
|
||||
* Submodules should only be used if a) upstream is highly reliable and
|
||||
b) it is 100% certain that no VL specific changes to the code will be
|
||||
needed (this has never been the case before, hence VL is submodule free so far)
|
||||
* Subtrees may be used for including outside mods that don't need changes
|
||||
in the foreseeable future
|
||||
* Commit messages should be descriptive
|
||||
b) it is 100% certain that no mcl2 specific changes to the code will be
|
||||
needed (this has never been the case before, hence mcl2 is submodule free so far)
|
||||
* Commit messages should be descriptive and never contain mcl2 specific
|
||||
issueids - there are other projects who might use commits from mcl2 and
|
||||
it will confuse their issue trackers.
|
||||
* Try to group your submissions best as you can:
|
||||
* Try to keep your PRs small: In some cases things reasonably be can't
|
||||
split up but in general multiple small PRs are better than a big one
|
||||
* Similarly multiple small commits are better than a giant one. (use git commit -p)
|
||||
* Try to keep your PRs small: In some cases things reasonably be can't
|
||||
split up but in general multiple small PRs are better than a big one.
|
||||
* Similarly multiple small commits are better than a giant one. (use git commit -p)
|
||||
|
||||
#### Code Guidelines
|
||||
* Each mod must provide `mod.conf`.
|
||||
* Mod names are snake case, and newly added mods (or substantially changed mods
|
||||
that are included from the outside) start with `vl_`, e.g.
|
||||
`vl_hollow_logs`, . Keep in mind Minetest
|
||||
* Mod names are snake case, and newly added mods start with `mcl_`, e.g.
|
||||
`mcl_core`, `mcl_farming`, `mcl_monster_eggs`. Keep in mind Minetest
|
||||
does not support capital letters in mod names.
|
||||
* In the past mods were prefixed with `mcl_`, e.g.
|
||||
`mcl_core`, `mcl_farming`, `mcl_monster_eggs`. New mods should **never** use this prefix.
|
||||
* Mods included from outside with no significant changes to the API
|
||||
(especially those using git-subtree or such) aren't prefixed.
|
||||
* To export functions, store them inside a global table named like the
|
||||
mod, e.g.
|
||||
|
||||
|
|
@ -373,28 +348,18 @@ end
|
|||
|
||||
### Developer status
|
||||
Active and trusted contributors are often granted write access to the
|
||||
VoxeLibre repository as a contributor. This means that they can push
|
||||
directly to the branches of our repo (except for `master`).
|
||||
Pushing to others' branches without asking is discouraged, open a PR
|
||||
targeting that branch instead (PRs can target any branch).
|
||||
|
||||
Those that have demonstrated the right technical skills and behaviour
|
||||
may be granted developer access. These are the most trusted contributors
|
||||
who will contribute to ensure coding standards and processes are followed.
|
||||
MineClone2 repository.
|
||||
|
||||
#### Developer responsibilities
|
||||
- If you have developer/contributor privileges you can just open a new branch
|
||||
in the VL repository (which is preferred). From that you create a pull request.
|
||||
- If you have developer privileges you can just open a new branch in the
|
||||
mcl2 repository (which is preferred). From that you create a pull request.
|
||||
This way other people can review your changes and make sure they work
|
||||
before they get merged.
|
||||
- If you do not (yet) have contributor or developer privs you do your work on a branch
|
||||
- If you do not (yet) have developer privs you do your work on a branch
|
||||
on your private repository e.g. using the "fork" function on mesehub.
|
||||
- Any developer is welcome to review, test and approve PRs. A maintainer may prefer
|
||||
to merge the PR especially if it is in a similar area to what has been worked on
|
||||
and could result in merge conflicts for a larger older branch, or needs
|
||||
art/licencing reviewing. A PR needs at least one approval (by someone else other
|
||||
than the author).
|
||||
- The maintainers are usually relatively quick to react to new submissions.
|
||||
- Any developer is welcome to review, test and merge PRs. A PR needs
|
||||
at least one approval (by someone else than the author) but the maintainers
|
||||
are usually relatively quick to react to new submissions.
|
||||
|
||||
### Maintainer status
|
||||
Maintainers carry the main responsibility for the project.
|
||||
|
|
@ -410,14 +375,14 @@ merged.
|
|||
- Resolving conflicts and problems within the community
|
||||
|
||||
#### Current maintainers
|
||||
* AncientMariner - responsible for gameplay review, publishing releases
|
||||
* Herowl - responsible for gameplay review, publishing releases,
|
||||
* Cora - responsible for gameplay review, publishing releases,
|
||||
technical guidelines
|
||||
* Nicu - responsible for community related issues
|
||||
|
||||
#### Release process
|
||||
* Run `tools/generate_ingame_credits.lua` to update the ingame credits
|
||||
from `CREDITS.md` and commit the result (if anything changed)
|
||||
* Launch VoxeLibre to make sure it still runs
|
||||
* Launch MineClone2 to make sure it still runs
|
||||
* Update the version number in README.md
|
||||
* Use `git tag <version number>` to tag the latest commit with the
|
||||
version number
|
||||
|
|
@ -435,5 +400,6 @@ become part of a free/libre software.
|
|||
|
||||
### Crediting
|
||||
Contributors, Developers and Maintainers will be credited in
|
||||
`CREDITS.md`. There are also Discord roles for Contributors,
|
||||
`CREDITS.md`. If you make your first time contribution, please add
|
||||
yourself to this file. There are also Discord roles for Contributors,
|
||||
Developers and Maintainers.
|
||||
|
|
|
|||
139
CREDITS.md
139
CREDITS.md
|
|
@ -3,48 +3,41 @@
|
|||
## Creator of MineClone
|
||||
* davedevils
|
||||
|
||||
## Creator of VoxeLibre
|
||||
## Creator of MineClone2
|
||||
* Wuzzy
|
||||
|
||||
|
||||
## Maintainers
|
||||
* AncientMariner
|
||||
* Herowl
|
||||
* Nicu
|
||||
|
||||
## Previous Maintainers
|
||||
* Fleckenstein
|
||||
* jordan4ibanez
|
||||
* cora
|
||||
* Nicu
|
||||
|
||||
## Developers
|
||||
* bzoss
|
||||
* AFCMS
|
||||
* epCode
|
||||
* chmodsayshello
|
||||
* MrRar
|
||||
* FossFanatic
|
||||
* SmokeyDope
|
||||
* Faerraven / Michieal
|
||||
* Codiac
|
||||
* rudzik8
|
||||
* teknomunk
|
||||
|
||||
## Past Developers
|
||||
* jordan4ibanez
|
||||
* ryvnf
|
||||
* iliekprogrammar
|
||||
* kabou
|
||||
* kay27
|
||||
* MysticTempest
|
||||
* Rootyjr
|
||||
* aligator
|
||||
* Code-Sploit
|
||||
* NO11
|
||||
* SumianVoice
|
||||
* kabou
|
||||
* rudzik8
|
||||
* chmodsayshello
|
||||
* PrairieWind
|
||||
* RandomLegoBrick
|
||||
* SumianVoice
|
||||
* MrRar
|
||||
* talamh
|
||||
* Faerraven
|
||||
|
||||
## Contributors
|
||||
* RandomLegoBrick
|
||||
* Code-Sploit
|
||||
* aligator
|
||||
* Rootyjr
|
||||
* ryvnf
|
||||
* bzoss
|
||||
* talamh
|
||||
* Laurent Rocher
|
||||
* HimbeerserverDE
|
||||
* TechDudie
|
||||
|
|
@ -73,10 +66,6 @@
|
|||
* Marcin Serwin
|
||||
* erlehmann
|
||||
* E
|
||||
* n_to
|
||||
* debiankaios
|
||||
* Gustavo6046 / wallabra
|
||||
* CableGuy67
|
||||
* Benjamin Schötz
|
||||
* Doloment
|
||||
* Sydney Gems
|
||||
|
|
@ -91,12 +80,15 @@
|
|||
* aldum
|
||||
* Dieter44
|
||||
* Pepebotella
|
||||
* MrRar
|
||||
* Lazerbeak12345
|
||||
* mrminer
|
||||
* Thunder1035
|
||||
* opfromthestart
|
||||
* snowyu
|
||||
* FaceDeer
|
||||
* Faerraven / Michieal
|
||||
* FossFanatic
|
||||
* Herbert West
|
||||
* GuyLiner
|
||||
* 3raven
|
||||
|
|
@ -104,49 +96,25 @@
|
|||
* TheOnlyJoeEnderman
|
||||
* Ranko Saotome
|
||||
* Gregor Parzefall
|
||||
* Wbjitscool
|
||||
* b3nderman
|
||||
* CyberMango
|
||||
* gldrk
|
||||
* atomdmac
|
||||
* emptyshore
|
||||
* FlamingRCCars
|
||||
* uqers
|
||||
* Niterux
|
||||
* appgurueu
|
||||
* seventeenthShulker
|
||||
* DinoNuggies4665
|
||||
* basxto
|
||||
* Morik666
|
||||
* Eliy21
|
||||
* mdk
|
||||
* Alessandra Lozoya
|
||||
* VanicGame
|
||||
* ThePython10110
|
||||
* Araca
|
||||
* Montandalar
|
||||
* mim
|
||||
* Dark
|
||||
* Bakawun
|
||||
* JoseDouglas26
|
||||
* Zasco
|
||||
* PrWalterB
|
||||
* michaljmalinowski
|
||||
* nixnoxus
|
||||
* Potiron
|
||||
* Tuxilio
|
||||
* Impulse
|
||||
* Doods
|
||||
* SOS-Games
|
||||
* Bram
|
||||
* qoheniac
|
||||
|
||||
## 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 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)
|
||||
## MineClone5
|
||||
* kay27
|
||||
* Debiankaios
|
||||
* epCode
|
||||
* NO11
|
||||
* j45
|
||||
* chmodsayshello
|
||||
* 3raven
|
||||
* PrairieWind
|
||||
* Gustavo6046 / wallabra
|
||||
* CableGuy67
|
||||
* MrRar
|
||||
|
||||
## Mineclonia
|
||||
* erlehmann
|
||||
* Li0n
|
||||
* E
|
||||
* n_to
|
||||
|
||||
## Original Mod Authors
|
||||
* Wuzzy
|
||||
|
|
@ -178,20 +146,12 @@
|
|||
* 4Evergreen4
|
||||
* jordan4ibanez
|
||||
* paramat
|
||||
* debian044 / debian44
|
||||
* chmodsayshello
|
||||
* cora
|
||||
* Faerraven / Michieal
|
||||
* PrairieWind
|
||||
* ChrisPHP
|
||||
|
||||
## 3D Models
|
||||
* 22i
|
||||
* tobyplowy
|
||||
* epCode
|
||||
* Faerraven / Michieal
|
||||
* SumianVoice
|
||||
* thunder1035
|
||||
|
||||
## Textures
|
||||
* XSSheep
|
||||
|
|
@ -206,13 +166,6 @@
|
|||
* RandomLegoBrick
|
||||
* cora
|
||||
* Faerraven / Michieal
|
||||
* Nicu
|
||||
* Exhale
|
||||
* Aeonix_Aeon
|
||||
* Wbjitscool
|
||||
* SmokeyDope
|
||||
* thunder1035
|
||||
* Herowl
|
||||
|
||||
## Translations
|
||||
* Wuzzy
|
||||
|
|
@ -227,22 +180,14 @@
|
|||
* snowyu
|
||||
* 3raven
|
||||
* SakuraRiu
|
||||
* anarquimico
|
||||
* syl
|
||||
* Temak
|
||||
* megustanlosfrijoles
|
||||
* kbundg
|
||||
* Isaac Dennis
|
||||
* ADLON
|
||||
* Sab Pyrope
|
||||
* JoseDouglas26
|
||||
|
||||
## Funders
|
||||
* 40W
|
||||
* bauknecht
|
||||
* Cora
|
||||
|
||||
## Special thanks
|
||||
* The Minetest team for making and supporting an engine, and distribution infrastructure that makes this all possible
|
||||
* celeron55 for creating Minetest
|
||||
* Jordach for the jukebox music compilation from Big Freaking Dig
|
||||
* wsor for working tirelessly in the shadows for the good of all of us, particularly helping with solving contentDB and copyright issues.
|
||||
* The workaholics who spent way too much time writing for the Minecraft Wiki. It's an invaluable resource for creating this game
|
||||
* Notch and Jeb for being the major forces behind Minecraft
|
||||
* Dark Reaven Music (https://soundcloud.com/dark-reaven-music) for the main menu theme (Calmed Cube), which is licensed under https://creativecommons.org/licenses/by-sa/3.0/
|
||||
|
|
|
|||
16
GROUPS.md
16
GROUPS.md
|
|
@ -25,7 +25,7 @@ The basic digging time groups determine by which tools a node can be dug.
|
|||
* `handy=1`: Breakable by hand and this node gives it useful drop when dug by hand. All nodes which are breakable by pickaxe, axe, shovel, sword or shears are also automatically breakable by hand, but not neccess
|
||||
* `creative_breakable=1`: Block is breakable by hand in creative mode. This group is implied if the node belongs to any other digging group
|
||||
|
||||
Please read <http://minecraft.gamepedia.com/Breaking> to learn how digging times work in Minecraft, as VoxeLibre is based on the same system.
|
||||
Please read <http://minecraft.gamepedia.com/Breaking> to learn how digging times work in Minecraft, as MineClone 2 is based on the same system.
|
||||
|
||||
### Groups for interactions
|
||||
|
||||
|
|
@ -117,7 +117,7 @@ These groups correspond to the Minecraft materials. They classify the block into
|
|||
* `material_glass=1`: Glass
|
||||
|
||||
Currently, these groups are used for the note block.
|
||||
Note that not all Minecraft materials are used so far. More Minecraft materials will likely only be added when they are needed for a concrete use case.
|
||||
Note that not all Minecraft materials are used so far. More Minecraft materials will lilely only be added when they are needed for a concrete use case.
|
||||
|
||||
### Declarative groups
|
||||
These groups are used mostly for informational purposes
|
||||
|
|
@ -170,8 +170,16 @@ These groups are used mostly for informational purposes
|
|||
* `ammo_bow=1`: Item is used as ammo for bows
|
||||
* `non_combat_armor=1`: Item can be equipped as armor, but is not made for combat (e.g. zombie head, pumpkin)
|
||||
* `container`: Node is a container which physically stores items within and has at least 1 inventory
|
||||
* `container=1`: Container type, which does not allow hoppers to transfer items
|
||||
* `container=2`: Items can be placed and taken freely. Can have inventory with list name `"main"` or define `_mcl_hoppers_on_try_pull`, `_mcl_hoppers_on_try_push`, `_mcl_hoppers_on_after_pull`, `_mcl_hoppers_on_after_push` to play along hoppers nicely.
|
||||
* `container=2`: Has one inventory with list name `"main"`. Items can be placed and taken freely
|
||||
* `container=3`: Same as `container=2`, but shulker boxes can not be inserted
|
||||
* `container=4`: Furnace-like, has lists `"src"`, `"fuel"` and `"dst"`.
|
||||
It is expected that this also reacts on `on_timer`;
|
||||
the node timer must be started from other mods when they add into `"src"` or `"fuel"`
|
||||
* `container=5`: Left part of a 2-part horizontal connected container. Both parts have a `"main"` inventory
|
||||
list. Both inventories are considered to belong together. This is used for large chests.
|
||||
* `container=6`: Same as above, but for the right part.
|
||||
* `container=7`: Has inventory list "`main`", no movement allowed
|
||||
* `container=1`: Other/unspecified container type
|
||||
* `spawn_egg=1`: Spawn egg
|
||||
|
||||
* `pressure_plate=1`: Pressure plate (off)
|
||||
|
|
|
|||
|
|
@ -1,23 +0,0 @@
|
|||
Survive, farm, build, explore, play with friends, and do much more. Inspired by a well-known block game, pushing beyond.
|
||||
|
||||
How to play:
|
||||
|
||||
#### Download Minetest
|
||||
- Navigate to https://www.minetest.net/ to download the client.
|
||||
- Once installed, open and select the "Content" tab
|
||||
|
||||
#### Install VoxeLibre from ContentDB
|
||||
- Click "Browse Online Content" and filter by Games (select "Games" from the dropdown box)
|
||||
- Find "VoxeLibre" (should be first on the list or on the first page)
|
||||
- Click the [+] button next to VoxeLibre and wait for download to finish
|
||||
- Click "Back to Main Menu"
|
||||
|
||||
#### Create new world and play
|
||||
- Click "Start Game" tab
|
||||
- At the bottom click the VoxeLibre icon (the stone & sandstone ball with the letters VL)
|
||||
- Click "New", give your world a name
|
||||
- You can leave seed blank or put in a word of your choice
|
||||
- Pick a mapgen or leave the default (v7, valleys or carpathian mapgens are recommended)
|
||||
- Pick mapgen options on the right (enabling everything is recommended)
|
||||
- Select your new world
|
||||
- Click "Play Game" and enjoy!
|
||||
22
LEGAL.md
22
LEGAL.md
|
|
@ -1,14 +1,14 @@
|
|||
# Legal information
|
||||
This is a game inspired by Minecraft with unique content.
|
||||
This is a fan game, not developed or endorsed by Mojang AB.
|
||||
|
||||
Copying is an act of love. Please copy and share! <3
|
||||
Here's the detailed legalese for those who need it:
|
||||
|
||||
## License of source code
|
||||
VoxeLibre (by Lizzy Fleckenstein, Wuzzy, davedevils and countless others)
|
||||
is inspired by Minecraft.
|
||||
MineClone 2 (by kay27, EliasFleckenstein, Wuzzy, davedevils and countless others)
|
||||
is an imitation of Minecraft.
|
||||
|
||||
VoxeLibre is free software: you can redistribute it and/or modify
|
||||
MineClone 2 is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
|
@ -22,15 +22,15 @@ details.
|
|||
In the mods you might find in the read-me or license
|
||||
text files a different license. This counts as dual-licensing.
|
||||
You can choose which license applies to you: Either the
|
||||
license of VoxeLibre (GNU GPLv3) or the mod's license.
|
||||
license of MineClone 2 (GNU GPLv3) or the mod's license.
|
||||
|
||||
VoxeLibre is a direct continuation of the discontinued MineClone
|
||||
MineClone 2 is a direct continuation of the discontinued MineClone
|
||||
project by davedevils.
|
||||
|
||||
Mod credits:
|
||||
See `README.txt` or `README.md` in each mod directory for information about other authors.
|
||||
For mods that do not have such a file, the license is the source code license
|
||||
of VoxeLibre and the author is Wuzzy.
|
||||
of MineClone 2 and the author is Wuzzy.
|
||||
|
||||
## License of media (textures and sounds)
|
||||
No non-free licenses are used anywhere.
|
||||
|
|
@ -38,15 +38,11 @@ No non-free licenses are used anywhere.
|
|||
The textures, unless otherwise noted, are based on the Pixel Perfection resource pack for Minecraft 1.11,
|
||||
authored by XSSheep. Most textures are verbatim copies, while some textures have been changed or redone
|
||||
from scratch.
|
||||
The glazed terracotta textures have been created by [MysticTempest](https://github.com/MysticTempest).
|
||||
The glazed terracotta textures have been created by (MysticTempest)[https://github.com/MysticTempest].
|
||||
Source: <https://www.planetminecraft.com/texture_pack/131pixel-perfection/>
|
||||
License: [CC BY-SA 4.0](http://creativecommons.org/licenses/by-sa/4.0/)
|
||||
|
||||
Armor trim models were created by Aeonix_Aeon
|
||||
Source: <https://www.curseforge.com/minecraft/texture-packs/ozocraft-remix>
|
||||
License: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
|
||||
|
||||
The main menu images are released under: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
|
||||
The main menu images are release under: [CC0](https://creativecommons.org/publicdomain/zero/1.0/)
|
||||
|
||||
All other files, unless mentioned otherwise, fall under:
|
||||
Creative Commons Attribution-ShareAlike 3.0 Unported (CC BY-SA 3.0)
|
||||
|
|
|
|||
75
MODELS.md
75
MODELS.md
|
|
@ -1,75 +0,0 @@
|
|||
# Models in Minetest/VoxeLibre
|
||||
|
||||
Models are an important part of all entities & unique nodes in VoxeLibre. They provide a 3 dimensional map of an object for which textures are then applied to. This document is for modders, it quickly highlights some important information for the software needed to open models in VoxeLibre.
|
||||
|
||||
## Minetest Wiki
|
||||
|
||||
For more detailed information on actually using blender to create and modify models for Minetest/VoxeLibre, please visit the Minetest wiki's page on using Blender [Here](https://wiki.minetest.net/Using_Blender)
|
||||
|
||||
## Recommended software
|
||||
|
||||
### Blender
|
||||
|
||||
Blender is a very popular and free modeling software supported on Windows, MacOS, and most Linux distributions. It is recommended to use Blender to create and modify 3D models within the minetest engine.
|
||||
|
||||
Download blender [Here](https://www.blender.org/download/)
|
||||
|
||||
### .b3d addon for blender
|
||||
|
||||
Blitz 3D (.b3d) Is one of the main animated model formats used for entities in the minetest engine. It cannot be imported to blender without a plugin called "Import-Export:Bitz 3D format (.b3d)".
|
||||
|
||||
The most up to date version of this Blender plugin can be downloaded [Here](https://github.com/GreenXenith/io_scene_b3d/releases/tag/f189786)
|
||||
|
||||
## Types of model formats
|
||||
|
||||
### Animated, skinned models
|
||||
|
||||
* Blitz 3D files (.b3d)
|
||||
|
||||
* Microsoft DirectX (.x) (binary & text, compression is not supported)
|
||||
|
||||
### Static meshes
|
||||
|
||||
* Wavefront OBJ (.obj)
|
||||
|
||||
Note: The sometimes accompanying .mtl files are not supported and can safely be deleted.
|
||||
|
||||
Note: Do not use .b3d and .x files for static meshes at the moment, Minetest currently spawns animated mesh scene nodes for these, which may result in reduced performance.
|
||||
|
||||
### Supported texture formats
|
||||
|
||||
* .png
|
||||
|
||||
* .jpg
|
||||
|
||||
* .bmp (depreciated, please use .png or .jpg)
|
||||
|
||||
* .tga (depreciated, please use .png or .jpg)
|
||||
|
||||
Note: Any formats not mentioned above but known to work in the past were removed in 5.5.0 and aren't supported anymore.
|
||||
|
||||
## Pros & Cons of .b3d vs .x
|
||||
|
||||
### B3D
|
||||
|
||||
* [+] Binary format means a small size
|
||||
|
||||
* [-] Difficult to postprocess after exporting
|
||||
|
||||
* [-] Difficult to debug problems
|
||||
|
||||
### X (text version)
|
||||
|
||||
* [+] Can be parsed easily with lua scripts
|
||||
|
||||
* [+] Can be easily generated by scripts
|
||||
|
||||
* [+] Easy to debug issues (you can just read it)
|
||||
|
||||
* [+] Can be optimized by quantizing some data
|
||||
|
||||
* [-] Blender exporter is kinda buggy and inefficient
|
||||
|
||||
* [-] Probably still bigger than an equivalent .b3d
|
||||
|
||||
Note: Avoid using the binary X format! It's actually just a tokenized version of the ASCII representation, and may actually be less efficient than a sufficiently optimized text .x file!
|
||||
78
README.md
78
README.md
|
|
@ -1,11 +1,8 @@
|
|||
# Erinfest
|
||||
This is simply a testing fork of the VoxelLibre game for minetest for practicing programing for minetest and possibly developing mods.
|
||||
# MineClone2
|
||||
An unofficial Minecraft-like game for Minetest. Forked from MineClone by davedevils.
|
||||
Developed by many people. Not developed or endorsed by Mojang AB.
|
||||
|
||||
|
||||
# Original Readme
|
||||
## VoxeLibre
|
||||
A game inspired by Minecraft for Minetest. Forked from MineClone by davedevils.
|
||||
Developed by many people, see CREDITS.md for a complete list.
|
||||
Version: 0.82 (in development)
|
||||
|
||||
### Gameplay
|
||||
You start in a randomly-generated world made entirely of cubes. You can explore
|
||||
|
|
@ -32,7 +29,7 @@ Or you can play in “creative mode” in which you can build almost anything in
|
|||
## How to play (quick start)
|
||||
### Getting started
|
||||
* **Punch a tree** trunk until it breaks and collect wood
|
||||
* Place the **wood into the 2×2 grid** (your “crafting grid” in your inventory menu) and craft 4 wood planks
|
||||
* Place the **wood into the 2×2 grid** (your “crafting grid” in your inventory menu and craft 4 wood planks
|
||||
* Place the 4 wood planks in a 2×2 shape in the crafting grid to **make a crafting table**
|
||||
* **Rightclick the crafting table** for a 3×3 crafting grid to craft more complex things
|
||||
* Use the **crafting guide** (book icon) to learn all the possible crafting recipes
|
||||
|
|
@ -42,15 +39,15 @@ Or you can play in “creative mode” in which you can build almost anything in
|
|||
|
||||
### Farming
|
||||
* Find seeds
|
||||
* Craft a hoe
|
||||
* Rightclick dirt or a similar block with a hoe to create farmland
|
||||
* Craft hoe
|
||||
* Rightclick dirt or similar block with hoe to create farmland
|
||||
* Place seeds on farmland and watch them grow
|
||||
* Collect plants when fully grown
|
||||
* Collect plant when fully grown
|
||||
* If near water, farmland becomes wet and speeds up growth
|
||||
|
||||
### Furnace
|
||||
* Craft a furnace
|
||||
* The furnace allows you to obtain more items
|
||||
* Craft furnace
|
||||
* Furnace allows you to obtain more items
|
||||
* Upper slot must contain a smeltable item (example: iron ore)
|
||||
* Lower slot must contain a fuel item (example: coal)
|
||||
* See tooltips in crafting guide to learn about fuels and smeltable items
|
||||
|
|
@ -69,44 +66,49 @@ Use the `/giveme` chat command to obtain them. See the in-game help for
|
|||
an explanation.
|
||||
|
||||
## Installation
|
||||
To run the game with the best performance and support, we recommend the latest
|
||||
stable version of [Minetest](http://minetest.net), be we always make an effort
|
||||
to support one version behind the latest stable version. In some cases, older
|
||||
versions might still be good enough but you would be missing out on important
|
||||
Minetest features that enable important features for our game.
|
||||
This game requires [Minetest](http://minetest.net) to run (version 5.4.1 or
|
||||
later). So you need to install Minetest first. Only stable versions of Minetest
|
||||
are officially supported.
|
||||
There is no support for running MineClone2 in development versions of Minetest.
|
||||
|
||||
There is no support for running VoxeLibre in development versions of Minetest.
|
||||
|
||||
To install VoxeLibre (if you haven't already), move this directory into the
|
||||
To install MineClone2 (if you haven't already), move this directory into the
|
||||
“games” directory of your Minetest data directory. Consult the help of
|
||||
Minetest to learn more.
|
||||
|
||||
## Useful links
|
||||
The VoxeLibre repository is hosted at Mesehub. To contribute or report issues, head there.
|
||||
The MineClone2 repository is hosted at Mesehub. To contribute or report issues, head there.
|
||||
|
||||
* Mesehub: <https://git.minetest.land/VoxeLibre/VoxeLibre>
|
||||
* Mesehub: <https://git.minetest.land/MineClone2/MineClone2>
|
||||
* Discord: <https://discord.gg/xE4z8EEpDC>
|
||||
* YouTube: <https://www.youtube.com/channel/UClI_YcsXMF3KNeJtoBfnk9A>
|
||||
* YouTube <https://www.youtube.com/channel/UClI_YcsXMF3KNeJtoBfnk9A>
|
||||
* IRC: <https://web.libera.chat/#mineclone2>
|
||||
* Matrix: <https://app.element.io/#/room/#mc2:matrix.org>
|
||||
* Reddit: <https://www.reddit.com/r/MineClone2/>
|
||||
* Minetest forums: <https://forum.minetest.net/viewtopic.php?f=50&t=16407>
|
||||
* ContentDB: <https://content.minetest.net/packages/wuzzy/mineclone2/>
|
||||
* OpenCollective: <https://opencollective.com/mineclone2>
|
||||
* Mastodon: <https://fosstodon.org/@VoxeLibre>
|
||||
* Lemmy: <https://lemm.ee/c/voxelibre>
|
||||
* Matrix space: <https://app.element.io/#/room/#voxelibre:matrix.org>
|
||||
* Minetest forums: <https://forum.minetest.net/viewtopic.php?f=50&t=16407>
|
||||
* Reddit: <https://www.reddit.com/r/VoxeLibre/>
|
||||
* IRC (barely used): <https://web.libera.chat/#mineclone2>
|
||||
|
||||
## Target
|
||||
- Create a stable, peformant, moddable, free/libre game inspired by Minecraft
|
||||
using the Minetest engine, usable in both singleplayer and multiplayer.
|
||||
- Currently, a lot of features are already implemented.
|
||||
Polishing existing features is always welcome.
|
||||
- Crucially, create a stable, moddable, free/libre clone of Minecraft
|
||||
based on the Minetest engine with polished features, usable in both
|
||||
singleplayer and multiplayer. Currently, a lot of **Minecraft Java
|
||||
Edition** features are already implemented and polishing existing
|
||||
features are prioritized over new feature requests.
|
||||
- With lessened priority yet strictly, implement features targetting
|
||||
**Current Minecraft versions + OptiFine** (OptiFine only as far as supported
|
||||
by the Minetest Engine). This means features in parity with the listed
|
||||
Minecraft experiences are prioritized over those that don't fulfill this
|
||||
scope.
|
||||
- Optionally, create a performant experience that will run relatively
|
||||
well on really low spec computers. Unfortunately, due to Minecraft's
|
||||
mechanisms and Minetest engine's limitations along with a very small
|
||||
playerbase on low spec computers, optimizations are hard to investigate.
|
||||
|
||||
## Completion status
|
||||
This game is currently in **beta** stage.
|
||||
It is playable, but not yet feature-complete.
|
||||
Backwards-compability is not entirely guaranteed, updating your world might cause small bugs.
|
||||
If you want to use the development version of VoxeLibre in production, the master branch is usually relatively stable.
|
||||
If you want to use the development version of MineClone2 in production, the master branch is usually relatively stable. The testing branch often features some experimental PRs and should be considered less stable.
|
||||
|
||||
The following main features are available:
|
||||
|
||||
|
|
@ -156,7 +158,7 @@ The following features are incomplete:
|
|||
|
||||
* Some monsters and animals
|
||||
* Redstone-related things
|
||||
* Some special minecarts (hopper and chest minecarts work)
|
||||
* Special minecarts
|
||||
* A couple of non-trivial blocks and items
|
||||
|
||||
Bonus features (not found in Minecraft):
|
||||
|
|
@ -164,7 +166,7 @@ Bonus features (not found in Minecraft):
|
|||
* Built-in crafting guide which shows you crafting and smelting recipes
|
||||
* In-game help system containing extensive help about gameplay basics, blocks, items and more
|
||||
* Temporary crafting recipes. They only exist to make some otherwise unaccessible items available when you're not in creative mode. These recipes will be removed as development goes on an more features become available
|
||||
* Saplings in chests in [mapgen v6](https://wiki.minetest.net/Map_generator#v6)
|
||||
* Saplings in chests in mapgen v6
|
||||
* Fully moddable (thanks to Minetest's powerful Lua API)
|
||||
* New blocks and items:
|
||||
* Lookup tool, shows you the help for whatever it touches
|
||||
|
|
@ -189,7 +191,7 @@ Technical differences from Minecraft:
|
|||
* Different engine (Minetest)
|
||||
* Different easter eggs
|
||||
|
||||
… and finally, VoxeLibre is free software (“free” as in “freedom”)!
|
||||
… and finally, MineClone2 is free software (“free” as in “freedom”)!
|
||||
|
||||
## Other readme files
|
||||
|
||||
|
|
|
|||
|
|
@ -1,53 +1,55 @@
|
|||
# VoxeLibre
|
||||
Un jeu inspiré de Minecraft pour Minetest. Forké depuis Mineclone par davedevils.
|
||||
Développé par de nombreuses personnes, voir CREDITS.md pour une liste complète.
|
||||
# MineClone2
|
||||
Un jeu non-officiel similaire à Minecraft pour Minetest. Forké depuis Mineclone par davedevils. Développé par de nombreuses personnes. Ni développé ou supporté par Mojang AB.
|
||||
|
||||
Version: 0.79 (en dévelopment)
|
||||
|
||||
### Gameplay
|
||||
|
||||
### Gameplay
|
||||
Vous atterissez dans un monde fait entièrement de cubes et généré aléatoirement. Vous pouvez explorer le monde, miner et construire presque n'importe quel bloc pour créer de nouvelles structures. Vous pouvez choisir de jouer en "mode survie" dans lequel vous devez combattre des monstres et la faim et progresser lentement dans différents aspects du jeu, comme l'extraction de minerai, l'agriculture, la construction de machines et ainsi de suite. Ou alors vous pouvez jouer en "mode créatif" où vous pouvez construire à peu près n'importe quoi instantanément.
|
||||
|
||||
### Résumé du Gameplay
|
||||
|
||||
* Jeu de type bac-à-sable, sans objetifs
|
||||
* Survie : combattez des monstres hostiles et la faim
|
||||
* Creusez pour du minerai et d'autres trésors
|
||||
* Magie : gagnez de l'expérience et enchantez les outils
|
||||
* Utilisez les blocs ramassés pour construire de magnifiques bâtiments, votre imagination est la seule limite
|
||||
* Ramassez des fleurs (et d'autres sources de teinture) et colorez votre monde
|
||||
* Survie : combattre des monstres hostiles et la faim
|
||||
* Creuser pour du minerai et d'autres trésors
|
||||
* Magie : gagner de l'expérience et enchanter les outils
|
||||
* Utiliser les blocs ramassés pour construire de magnifiques bâtiments, votre imagination est la limite
|
||||
* Ramasser des fleurs (et d'autres sources de teinture) et colorez votre monde
|
||||
* Trouvez des graines et commencez à cultiver
|
||||
* Trouvez ou fabriquez des centaines d'objets
|
||||
* Construisez un réseau ferroviaire complexe et amusez-vous avec les wagonnets
|
||||
* Construisez un réseau ferroviaire complexe et amusez vous avec les wagonnets
|
||||
* En mode créatif vous pouvez construire presque n'importe quoi gratuitement et sans limite
|
||||
|
||||
## Comment jouer (démarrer rapidement)
|
||||
### Commencer
|
||||
* **Frappez un arbre** jusqu'à ce qu'il casse et donne du bois
|
||||
* Placez le **bois dans la grille 2x2** (la "grille de fabrication" de votre menu d'inventaire) et fabriquez 4 planches de bois
|
||||
* Placez les 4 planches de bois dans la grille 2x2 et **fabriquez un établi**
|
||||
* **Faites un clic droit sur l'établi** (icone livre) pour apprendre toutes les recettes possibles
|
||||
* Placer les 4 planches de bois dans la grille 2x2 et **fabriquez une table d'artisanat**
|
||||
* **Cliquez droit la table d'artisanat** (icone livre) pour apprendre toutes les recettes possibles
|
||||
* **Fabriquez une pioche de bois** pour miner la pierre
|
||||
* Différents outils minent différentes sortes de blocs. Essayez-les !
|
||||
* Continuez à jouer comme vous voulez. Amusez-vous !
|
||||
* Différents outils minent différentes sortes de blocs. Essayez les !
|
||||
* Continuez à jouer comme vous voulez. Amusez vous !
|
||||
|
||||
### Agriculture
|
||||
* Trouvez des graines
|
||||
* Fabriquez une houe
|
||||
* Faites un clic droit sur la terre ou un bloc similaire avec la houe pour créer des terres agricoles
|
||||
* Placez des graines sur des terres agricoles et regardez les pousser
|
||||
* Cliquez droit la terre ou des blocs similaires avec la houe pour créer des terres agricoles
|
||||
* Placer des graines sur des terres agricoles et regardez les pousser
|
||||
* Récoltez les plantes une fois matûres
|
||||
* Les terres agricoles proches de l'eau deviennent humides et accélèrent la croissance
|
||||
* Les terres agricoles proche de l'eau deviennent humides et accélèrent la croissance
|
||||
|
||||
### Four
|
||||
* Fabriquez un four
|
||||
* Fabriquer un Four
|
||||
* Le four permet d'obtenir plus d'objets
|
||||
* L'emplacement du haut doit contenir un objet fondable (par ex : minerai de fer)
|
||||
* L'emplacement du bas doit contenir un objet combustible (par ex : charbon)
|
||||
* L'emplacement du haut doit contienir un objet fondable (par ex : minerai de fer)
|
||||
* L'emplacement du bas doit contienir un objet combustible (par ex : charbon)
|
||||
* Voir le guide d'artisanat pour en apprendre plus sur les objets fondables et combustibles
|
||||
|
||||
### Aide supplémentaire
|
||||
Plus d'aide à propos du jeu, des blocs, objets et plus encore peuvent être trouvés dans le jeu. Vous pouvez accéder à l'aide depuis le menu inventaire.
|
||||
|
||||
### Objets spéciaux
|
||||
Les objets suivants sont intéressants pour le mode Créatif et pour les constructeurs de cartes d'aventure. Ils ne peuvent être obtenus dans le jeu ou dans l'inventaire créatif.
|
||||
Les objets suivants sont intéressants pour le mode Créatif et pour les constructeurs de cartes d'aventure. Ils ne peuvent être obtenus dans le jeu ou dans l'inventaire créatif.
|
||||
|
||||
* Barrière : `mcl_core:barrier`
|
||||
|
||||
|
|
@ -55,50 +57,48 @@ Utilisez la commande de chat `/giveme` pour les obtenir. Voir l'aide interne au
|
|||
|
||||
## Installation
|
||||
Ce jeu nécessite [Minetest](http://minetest.net) pour fonctionner (version 5.4.1 ou plus). Vous devez donc installer Minetest d'abord. Seules les versions stables de Minetest sont officielement supportées.
|
||||
Il n'y a pas de support de VoxeLibre dans les versions développement de Minetest.
|
||||
Il n'y a pas de support de MineClone2 dans les versions développement de Minetest.
|
||||
|
||||
Pour installer VoxeLibre (si ce n'est pas déjà fait), déplacez ce dossier dans le dossier “games” de Minetest. Consultez l'aide de Minetest pour en apprendre plus.
|
||||
Pour installer MineClone2 (si ce n'est pas déjà fait), déplacez ce dossier dans le dossier “games” de Minetest. Consultez l'aide de Minetest pour en apprendre plus.
|
||||
|
||||
## Liens utiles
|
||||
Le dépôt de VoxeLibre est hébergé sur Mesehub. Pour contribuer ou signaler des problèmes, allez là-bas.
|
||||
## Liens utiles
|
||||
Le dépôt de MineClone2 est hébergé sur Mesehub. Pour contribuer ou rapporter des problèmes, aller là-bas.
|
||||
|
||||
* Mesehub : <https://git.minetest.land/VoxeLibre/VoxeLibre>
|
||||
* Discord : <https://discord.gg/xE4z8EEpDC>
|
||||
* YouTube : <https://www.youtube.com/channel/UClI_YcsXMF3KNeJtoBfnk9A>
|
||||
* ContentDB : <https://content.minetest.net/packages/wuzzy/mineclone2/>
|
||||
* OpenCollective : <https://opencollective.com/mineclone2>
|
||||
* Mastodon : <https://fosstodon.org/@VoxeLibre>
|
||||
* Lemmy : <https://lemm.ee/c/voxelibre>
|
||||
* Espace Matrix : <https://app.element.io/#/room/#voxelibre:matrix.org>
|
||||
* Forums Minetest : <https://forum.minetest.net/viewtopic.php?f=50&t=16407>
|
||||
* Reddit : <https://www.reddit.com/r/VoxeLibre/>
|
||||
* IRC (peu utilisé) : <https://web.libera.chat/#mineclone2>
|
||||
* Mesehub: <https://git.minetest.land/MineClone2/MineClone2>
|
||||
* Discord: <https://discord.gg/xE4z8EEpDC>
|
||||
* YouTube <https://www.youtube.com/channel/UClI_YcsXMF3KNeJtoBfnk9A>
|
||||
* IRC: <https://web.libera.chat/#mineclone2>
|
||||
* Matrix: <https://app.element.io/#/room/#mc2:matrix.org>
|
||||
* Reddit: <https://www.reddit.com/r/MineClone2/>
|
||||
* Minetest forums: <https://forum.minetest.net/viewtopic.php?f=50&t=16407>
|
||||
* ContentDB: <https://content.minetest.net/packages/wuzzy/mineclone2/>
|
||||
* OpenCollective: <https://opencollective.com/mineclone2>
|
||||
|
||||
## Objectif
|
||||
* Créer un jeu stable, performant, moddable et libre inspiré de Minecraft en utilisant le moteur de jeu Minetest, utilisable à la fois en mode solo et multijoueur.
|
||||
* Actuellement, un grand nombre de fonctionnalités sont déjà implémentées.
|
||||
L'amélioration des fonctionnalités existantes est toujours la bienvenue.
|
||||
* Créer un clone stable, moddable, libre et gratuit basé sur le moteur de jeu Minetest avec des fonctionalités abouties, utilisable à la fois en mode solo et multijoueur. Actuellement, beaucoup des fonctionalités de **Minecraft Java Edition** sont déjà implémentées et leur amélioration est prioritaire sur les nouvelles demandes.
|
||||
* Avec une priorité moindre, implémenter les fonctionalités des versions **Minecraft + OptiFine** (OtiFine autant que supporté par le moteur Minetest). Cela signifie que les fonctionalités présentes dans les versions listées sont priorisées.
|
||||
* Dans l'idéal, créer une expérience performante qui tourne bien sur des ordinateurs à basse performance. Malheureusement, en raison des mécanismes de Minecraft et des limitations du moteur Minetest ainsi que de la petite taille de la communauté de joueurs sur des ordinateurs à basse performances, les optimisations sont difficiles à explorer.
|
||||
|
||||
## Statut de complétion
|
||||
Ce jeu est actuellement au stade **beta**.
|
||||
Il est jouable mais incomplet en fonctionnalités.
|
||||
Il est jouable mais incomplet en fonctionalités.
|
||||
La rétro-compatibilité n'est pas entièrement garantie, mettre votre monde à jour peut causer de petits bugs.
|
||||
Si vous voulez utiliser la version de développement de VoxeLibre en production, la branche master est habituellement relativement stable.
|
||||
Si vous voulez utiliser la version de développement de MineClone2 en production, la branche master est habituellement relativement stable. Les branches de test fusionnent souvent des pull requests expérimentales et doivent être considérées comme moins stable.
|
||||
|
||||
Les principales fonctionnalités suivantes sont disponibles :
|
||||
Les principales fonctionalités suivantes sont disponibles :
|
||||
|
||||
* Outils, armes
|
||||
* Armure
|
||||
* Système de fabrication : grille 2x2, établi (grille 3x3), four, incluant un guide de fabrication
|
||||
* Coffres, grands coffres, coffre ender, boites de Shulker
|
||||
* Système de fabrication : grille 2x2, table d'artisanat (grille 3x3), four, incluant un guide de fabrication
|
||||
* Coffres, grands coffres, coffre ender, boite de shulker
|
||||
* Fours, entonnoirs
|
||||
* Faim
|
||||
* La plupart des monstres et animaux
|
||||
* Tous les minerais de Minecraft
|
||||
* Tout les minerais de Minecraft
|
||||
* La plupart des blocs de l'overworld
|
||||
* Eau et lave
|
||||
* Météo
|
||||
* 28 biomes + 5 biomes du Nether
|
||||
* 28 biomes + 5 biomes du nether
|
||||
* Le Nether, monde souterrain brûlant dans une autre dimension
|
||||
* Circuits Redstone (partiel)
|
||||
* Effets de Statut (partiel)
|
||||
|
|
@ -107,41 +107,37 @@ Les principales fonctionnalités suivantes sont disponibles :
|
|||
* Brassage, potions, flèches trempées (partiel)
|
||||
* Bâteaux
|
||||
* Feu
|
||||
* Blocs de construction : escaliers, dalles, portes, trappes, barrières, portillons, murets
|
||||
* Blocs de construction : escaliers, dalles, portes, trappes, barrière, portillon, muret
|
||||
* Horloge
|
||||
* Boussole
|
||||
* Éponge
|
||||
* Bloc de slime
|
||||
* Eponge
|
||||
* Bloc de slime
|
||||
* Petites plantes et pousses
|
||||
* Teintures
|
||||
* Bannières
|
||||
* Blocs de décoration : verre, verre teinté, vitres, barres de fer, terre cuites (et couleurs), têtes et plus
|
||||
* Cadres d'objets
|
||||
* Cadres d'objets
|
||||
* Juke-boxes
|
||||
* Lits
|
||||
* Menu d'inventaire
|
||||
* Inventaire créatif
|
||||
* Agriculture
|
||||
* Livres pour écrire
|
||||
* Commandes
|
||||
* Villages
|
||||
* L'End
|
||||
* L'End
|
||||
* et plus !
|
||||
|
||||
Les fonctionnalités suivantes sont incomplètes :
|
||||
Les fonctionalités suivantes sont incomplètes :
|
||||
|
||||
* Certains monstres et animaux
|
||||
* Certains composants de Redstone
|
||||
* certains monstres et animaux
|
||||
* certains composants de Redstone
|
||||
* Wagonnets spéciaux
|
||||
* Quelques blocs et objets non-triviaux
|
||||
* quelques blocs et objets non-triviaux
|
||||
|
||||
Fonctionnalités bonus (absentes de Minecraft) :
|
||||
Fonctionalités bonus (absentes de Minecraft) :
|
||||
|
||||
* Guide d'artisanat intégré au jeu qui montre les recettes d'artisanat et de cuisson
|
||||
* Système d'aide intégré au jeu contenant des informations à propos des techniques de base, blocs, objets et plus
|
||||
* Recettes d'artisanat temporaires. Elles existent uniquement pour rendre des objets accessibles qui ne le seraient pas autrement sauf en mode créatif. Elles seront retirées au cours de l'avancement du développement et de l'ajout de nouvelles fonctionnalités.
|
||||
* Pousses dans les coffres en [mapgen v6](https://wiki.minetest.net/Map_generator#v6)
|
||||
* Entièrement moddable (grâce la puissante API Lua de Minetest)
|
||||
* Recettes d'artisanat temporaires. Elles existent uniquement pour rendre des objets accessibles qui ne le seraient pas autrement sauf en mode créatif. Elles seront retirées au cours de l'avancement du développement et de l'ajout de nouvelles fonctionalités.
|
||||
* Pousses dans les coffres en mapgen v6
|
||||
* Entièrement moddable (grâce la puissante API lua de Minetest)
|
||||
* Nouveaux blocs et objets :
|
||||
* Outil de recherche, montre l'aide de ce qu'il touche
|
||||
* Plus de dalles et d'escaliers
|
||||
|
|
@ -153,24 +149,22 @@ Fonctionnalités bonus (absentes de Minecraft) :
|
|||
* Avant-poste du Nether (Forteresse)
|
||||
|
||||
Différences techniques avec Minecraft :
|
||||
|
||||
* Limite en hauteur de 31000 blocs (bien plus grand que Minecraft)
|
||||
* Taille horizontale du monde 62000×62000 blocs (bien plus petit que Minecraft mais toujours très grand)
|
||||
* Toujours assez incomplet et buggé
|
||||
* Des blocs, objets, ennemis et fonctionnalités manquent
|
||||
* Des blocs, objets, ennemis et fonctionalités manquent
|
||||
* Quelques objets ont des noms légèrement différents pour être plus faciles à distinguer
|
||||
* Des musiques différentes pour le juke-boxe
|
||||
* Des textures différentes (Pixel Perfection)
|
||||
* Des sons différents (sources diverses)
|
||||
* Un moteur de jeu différent (Minetest)
|
||||
* Des bonus cachés différents
|
||||
|
||||
...et enfin VoxeLibre est un logiciel libre !
|
||||
...et enfin MineClone2 est un logiciel libre !
|
||||
|
||||
## Autres fichiers readme
|
||||
|
||||
* `LICENSE.txt` : Le texte de la licence GPLv3
|
||||
* `CONTRIBUTING.md` : Information pour ceux qui veulent contribuer
|
||||
* `API.md` : Pour les modders Minetest qui veulent modder ce jeu
|
||||
* `LEGAL.md` : Information légale
|
||||
* `CREDITS.md` : Liste de toutes les personnes qui ont contribué
|
||||
* `LICENSE.txt`: Le texte de la license GPLv3
|
||||
* `CONTRIBUTING.md`: Information pour ceux qui veulent contribuer
|
||||
* `API.md`: Pour les modders Minetest qui veulent modder ce jeu
|
||||
* `LEGAL.md`: Information légale
|
||||
* `CREDITS.md`: Liste des contributeurs
|
||||
|
|
@ -1,193 +0,0 @@
|
|||
# VoxeLibre
|
||||
Неофициальная игра в стиле Minecraft для Minetest. Форк MineClone от davedevils.
|
||||
Разработана многими людьми. Не разработана и не одобрена Mojang AB.
|
||||
|
||||
### Игровой процесс
|
||||
Вы начинаете в случайно сгенерированном мире созданном целиком из кубов. Вы можете
|
||||
исследовать мир, выкопать и поставить почти каждый блок в мире, чтобы создавать новые
|
||||
структуры. Вы можете играть в “режиме выживания” в котором вам придется бороться с
|
||||
монстрами и голодом за выживание и медленно проходить через различные аспекты игры,
|
||||
такие как копание, фермерство, постройка механизмов и так далее. Или вы можете играть
|
||||
в “творческом режиме” в котором вы сразу можете строить что угодно.
|
||||
|
||||
#### Итоги геймплея
|
||||
|
||||
* Геймплей в стиле песочницы, без целей
|
||||
* Выживайте: сражайтесь с враждебными монстрами и голодом
|
||||
* Добывайте руды и прочие ценные предметы
|
||||
* Магия: получайте опыт и зачаруйте ваше снаряжение
|
||||
* Создавайте из собранных блоков величественные постройки ограниченные только воображением
|
||||
* Собирайте цветы и другие красители, чтобы раскрасить ваш мир
|
||||
* Найдите семена и заведите ферму
|
||||
* Найдите или создайте один из сотен предметов
|
||||
* Проложите рельсы и повеселитесь с вагонетками
|
||||
* Постройте сложные механизмы со схемами из редстоуна
|
||||
* В творческом режиме вы можете свободно строить всё без лимитов
|
||||
|
||||
## Как играть (быстрый старт)
|
||||
### Начнем
|
||||
|
||||
* **Бейте по стволу дерева** пока оно не сломается и соберите древесину
|
||||
* Поставьте **древесину в сетку 2×2** (“сетка крафта” в вашем инвентаре) и скрафтите 4 доски
|
||||
* Разложите 4 доски в форме 2×2 в сетке крафта, чтобы **сделать верстак**
|
||||
* **Правым кликом по верстаку**, чтобы открыть сетку крафта 3×3 для более сложных предметов
|
||||
* Используйте **книгу рецептов** (иконка книги), чтобы узнать все возможные рецепты крафтов
|
||||
* **Скрафтите деревянную кирку**, чтобы вы могли копать камень
|
||||
* Разные инструменты добывают разные виды блоков. Опробуйте их все!
|
||||
* Продолжайте играть как пожелаете. Повеселитесь!
|
||||
|
||||
### Фермерство
|
||||
* Найдите семена
|
||||
* Скрафтите мотыгу
|
||||
* Правой кнопкой мотыгой по земле или похожему блоку, чтобы создать грядку
|
||||
* Посадите семена на грядку и ждите пока они вырастут
|
||||
* Соберите растение когда оно полностью созреет
|
||||
* Рядом с водой грядка становится влажной и растения растут быстрее
|
||||
|
||||
### Переплавка
|
||||
* Скрафтите печь
|
||||
* Печь позволит вам получить больше предметов
|
||||
* Верхний слот должен содержать переплавляемый предмет (например: железную руду)
|
||||
* Нижний слот должен содержать топливо (например: уголь)
|
||||
* Смотрите книгу рецептов, чтобы узнать о других переплавляемых предметах и топливе
|
||||
|
||||
### Дополнительная помощь
|
||||
Больше информации о геймплее, блоках, предметах и многое другое можно найти во
|
||||
внутриигровой справке. Вы можете перейти в неё через ваш инвентарь.
|
||||
|
||||
### Особые предметы
|
||||
Следующие предметы интересны для творческого режима и для строителей приключенческих
|
||||
карт. Их нельзя получить в игре или через творческий инвентарь.
|
||||
|
||||
* Барьер: `mcl_core:barrier`
|
||||
|
||||
Используйте чат-команду `/giveme`, чтобы получить их.
|
||||
Смотрите справку для дальнейшей информации.
|
||||
|
||||
## Установка
|
||||
Эта игра требует [Minetest](http://minetest.net) для запуска (версия 5.4.1 или
|
||||
выше). Вам нужно сперва установить Minetest. Только стабильные версии поддерживаются
|
||||
официально. Не поддерживается запуск VoxeLibre на разрабатываемых версиях Minetest.
|
||||
|
||||
Чтобы установить VoxeLibre (если вы этого еще не сделали), переместите эту папку в
|
||||
“games” в папке данных Minetest. Смотрите справку Minetest, чтобы узнать больше.
|
||||
|
||||
## Полезные ссылки
|
||||
Репозиторий VoxeLibre хранится на Mesehub. Зайдите туда, чтобы оставить запрос или
|
||||
поучаствовать в разработке.
|
||||
|
||||
* Mesehub: <https://git.minetest.land/MineClone2/MineClone2>
|
||||
* Discord: <https://discord.gg/xE4z8EEpDC>
|
||||
* YouTube: <https://www.youtube.com/channel/UClI_YcsXMF3KNeJtoBfnk9A>
|
||||
* ContentDB: <https://content.minetest.net/packages/wuzzy/mineclone2/>
|
||||
* OpenCollective: <https://opencollective.com/mineclone2>
|
||||
* Mastodon: <https://fosstodon.org/@MineClone2>
|
||||
* Lemmy: <https://lemmy.world/c/mineclone2>
|
||||
* Matrix space: <https://app.element.io/#/room/#mcl2:matrix.org>
|
||||
* Форум Minetest: <https://forum.minetest.net/viewtopic.php?f=50&t=16407>
|
||||
* Reddit: <https://www.reddit.com/r/MineClone2/>
|
||||
* IRC (едва используется): <https://web.libera.chat/#mineclone2>
|
||||
|
||||
## Цели
|
||||
- Создать стабильную, модифицируемую, бесплатную и свободную игру основанную на
|
||||
Minecraft на движке Minetest с проработанными возможностями для одиночной игры и
|
||||
для мультиплеера. На данный момент множество возможностей **Minecraft Java
|
||||
Edition** уже реализовано и доработка имеющегося контента в приоритете над
|
||||
добавлением нового.
|
||||
- Реализовать возможности на уровне **текущей версии Minecraft + OptiFine** (OptiFine
|
||||
настолько, насколько это поддерживается движком Minetest).
|
||||
- Добиться производительности для запуска на действительно слабых компьютерах.
|
||||
|
||||
## Готовность
|
||||
Игра сейчас на стадии **бета**. Она играбельна, но еще не имеет всех возможностей.
|
||||
Обратная совместимость целиком не гарантируется, обновление вашего мира может повлечь
|
||||
за собой небольшие ошибки. Если вы хотите использовать разрабатываемую версию
|
||||
VoxeLibre, то ветка master обычно относительно стабильна.
|
||||
|
||||
Следущие возможности уже доступны:
|
||||
|
||||
* Инструменты, оружие, броня
|
||||
* Система крафта: сетка 2×2, верстак (сетка 3×3) и книга рецептов
|
||||
* Сундуки, большие сундуки, эндер-сундуки, ящики шалкера
|
||||
* Печи и воронки
|
||||
* Система голода
|
||||
* Большинство монстров и животных
|
||||
* Все руды из Minecraft
|
||||
* Большинство блоков из Верхнего мира
|
||||
* Вода и лава
|
||||
* Погода
|
||||
* 28 биомов + 5 биомов в Незере
|
||||
* Незер, пылающий подземный мир в другом измерении
|
||||
* Схемы из редстоуна (частично)
|
||||
* Вагонетки (частично)
|
||||
* Статусные эффекты (частично)
|
||||
* Опыт
|
||||
* Зачарование
|
||||
* Зельеварение, зелья, смоченные стрелы (частично)
|
||||
* Лодки
|
||||
* Огонь
|
||||
* Строительные блоки: ступени, плиты, двери, люки, заборы, калитки, стены
|
||||
* Часы
|
||||
* Компас
|
||||
* Губки
|
||||
* Блоки слизи
|
||||
* Растения и саженцы
|
||||
* Красители
|
||||
* Флаги
|
||||
* Декоративные блоки: стекло, окрашенное стекло, стеклянные панели, железные решетки, цветная керамика, головы и многое другое
|
||||
* Рамки для предметов
|
||||
* Прогрыватели
|
||||
* Кровати
|
||||
* Меню инвентаря
|
||||
* Творческий инвентарь
|
||||
* Фермерство
|
||||
* Книги с пером
|
||||
* Команды
|
||||
* Деревни
|
||||
* Измерение Края
|
||||
* И многое другое!
|
||||
|
||||
Следующие возможности еще не завершены:
|
||||
|
||||
* Некоторые монстры и животные
|
||||
* Предметы связанные с редстоуном
|
||||
* Некоторые вагонетки (с сундуком и с воронкой уже работают)
|
||||
* Пара нетривиальных блоков и предметов
|
||||
|
||||
Бонусные возможности (нет в Minecraft-е):
|
||||
|
||||
* Встроенный гайд для крафта покажет вам рецепты крафта и переплавки
|
||||
* Внутриигровая справка содержит всестороннюю информацию об основах игры, блоках, предметах и прочее
|
||||
* Временные рецепты крафта. Они существуют, чтобы получить доступ к ранее недоступным предметам вне творческого режима. Они будут удалены как только разработка позволит им стать доступными
|
||||
* Саженцы в сундуках в [mapgen v6](https://wiki.minetest.net/Map_generator#v6)
|
||||
* Полностью модифицируема (благодаря мощному Lua API в Minetest)
|
||||
* Новые блоки и предметы:
|
||||
* Инструмент просмотра покажет справку о том чего коснется
|
||||
* Больше ступеней и плит
|
||||
* Калитки и заборы из адских кирпичей
|
||||
* Замены структур - малые верии структур из Minecraft пока большие структуры не будут сделаны:
|
||||
* Лесная хижина (Особняк)
|
||||
* Форт Незера (Крепости)
|
||||
|
||||
Технические отличия от Minecraft:
|
||||
|
||||
* Лимит высоты - 31000 блоков (намного больше чем в Minecraft)
|
||||
* Горизонтальный размер мира - 62000×62000 блоков (намного меньше чем в Minecraft, но всё еще очень большой)
|
||||
* Всё еще не завершен и содержит много багов
|
||||
* Недостающие блоки, предметы, мобы
|
||||
* Некоторые предметы с другими названиями, чтобы лучше их различать
|
||||
* Другая музыка для проигрывателей
|
||||
* Другие текстуры (Pixel Perfection)
|
||||
* Другие звуки (разные источники)
|
||||
* Другой движок (Minetest)
|
||||
* Другие пасхалки
|
||||
|
||||
… и наконец, VoxeLibre это свободное программное обеспечение!
|
||||
|
||||
## Другие readme файлы
|
||||
|
||||
* `LICENSE.txt`: текст лицензии GPLv3
|
||||
* `CONTRIBUTING.md`: информация для тех кто хочет поучаствовать в разработке
|
||||
* `API.md`: для моддеров Minetest кто хочет изменить эту игру
|
||||
* `LEGAL.md`: юридическая информация
|
||||
* `CREDITS.md`: список участников проекта
|
||||
|
|
@ -1,6 +1,4 @@
|
|||
This file is severely out of date. If you can help updating this translation, please reach out to us (contact in README.md - the English version).
|
||||
|
||||
# VoxeLibre
|
||||
# MineClone 2
|
||||
一個非官方的Minetest遊戲，遊玩方式和Minecraft類似。由davedevils從MineClone分拆。
|
||||
由許多人開發。並非由Mojang Studios開發。<!-- "Mojang AB"'s Name changed at 2020/05, main README should change too -->
|
||||
|
||||
|
|
@ -85,11 +83,11 @@ Minetest to learn more.
|
|||
The main goal of **MineClone 2** is to be a clone of Minecraft and to be released as free software.
|
||||
|
||||
* **開發目標：我的世界, Java版, 版本 1.12**
|
||||
* VoxeLibre還包括Minetest支持的Optifine功能。
|
||||
* MineClone2還包括Minetest支持的Optifine功能。
|
||||
* 後期Minecraft版本的功能可能會偷偷加入，但它們的優先級較低。
|
||||
* 總的來說，Minecraft的目標是在Minetest目前允許的情況下進行克隆。
|
||||
* 克隆Minecraft是最優先的。
|
||||
* VoxeLibre將使用不同的圖形和聲音，但風格相似。
|
||||
* MineClone2將使用不同的圖形和聲音，但風格相似。
|
||||
* 克隆界面沒有優先權。只會被粗略地模仿。
|
||||
* 在Minetest中發現的局限性將在開發過程中被記錄和報告。
|
||||
|
||||
|
|
@ -175,7 +173,7 @@ The main goal of **MineClone 2** is to be a clone of Minecraft and to be release
|
|||
* 不同的聲音（各種來源）
|
||||
* 不同的引擎（Minetest）
|
||||
|
||||
...最後，VoxeLibre是自由軟件！
|
||||
...最後，MineClone2是自由軟件！
|
||||
|
||||
## 錯誤報告
|
||||
請在此處報告所有錯誤和缺少的功能：
|
||||
|
|
@ -192,7 +190,7 @@ The main goal of **MineClone 2** is to be a clone of Minecraft and to be release
|
|||
|
||||
* `LICENSE.txt`：GPLv3許可文本
|
||||
* `CONTRIBUTING.md`: 為那些想參與貢獻的人提供資訊
|
||||
* `MISSING_ENGINE_FEATURES.md`: VoxeLibre需要改进，Minetest中缺失的功能列表。
|
||||
* `MISSING_ENGINE_FEATURES.md`: MineClone2需要改进，Minetest中缺失的功能列表。
|
||||
* `API.md`: 關於MineClone2的API
|
||||
|
||||
## 參與者
|
||||
|
|
@ -237,7 +235,7 @@ The main goal of **MineClone 2** is to be a clone of Minecraft and to be release
|
|||
* [kingoscargames](https://github.com/kingoscargames)：現有材質的各種編輯和添加
|
||||
* [leorockway](https://github.com/leorockway)：怪物紋理的一些編輯
|
||||
* [xMrVizzy](https://minecraft.curseforge.com/members/xMrVizzy)：釉陶（材質以後會被替換）
|
||||
* yutyo <tanakinci2002@gmail.com>：VoxeLibre標志
|
||||
* yutyo <tanakinci2002@gmail.com>：MineClone2標志
|
||||
* 其他：GUI圖片
|
||||
|
||||
### 翻譯
|
||||
|
|
@ -256,7 +254,7 @@ The main goal of **MineClone 2** is to be a clone of Minecraft and to be release
|
|||
|
||||
### 特殊感謝
|
||||
|
||||
* Wuzzy，感謝他啟動和維護VoxeLibre多年。
|
||||
* Wuzzy，感謝他啟動和維護MineClone2多年。
|
||||
* celeron55，創建Minetest。
|
||||
* Minetest的社區提供了大量的mods選擇，其中一些最終被納入MineClone 2。
|
||||
* Jordach，為《Big Freaking Dig》的唱片機音樂合輯而來
|
||||
|
|
|
|||
168
RELEASE.md
168
RELEASE.md
|
|
@ -1,167 +1,19 @@
|
|||
## Standard Release
|
||||
#File to document release steps with a view to evolving into a script
|
||||
|
||||
### Before releasing
|
||||
#Update CREDITS.md
|
||||
#Update version in README.md (soon to be game.conf from of 0.82.0)
|
||||
|
||||
Make sure all PRs in the release milestone are merged and you are working on a clean branch based on the master branch, up-to-date with the one on the repo.
|
||||
|
||||
### Release process
|
||||
|
||||
1. Update CREDITS.md
|
||||
2. Update version in game.conf
|
||||
3. Run the script:
|
||||
```
|
||||
lua tools/generate_ingame_credits.lua
|
||||
```
|
||||
4. Make a commit for the above:
|
||||
```
|
||||
|
||||
git add CREDITS.md
|
||||
git add mods/HUD/mcl_credits/people.lua
|
||||
git add game.conf
|
||||
git commit -m "Updated release credits and set version for v0.87"
|
||||
```
|
||||
5. Add release notes to the `releasenotes` folder, named like
|
||||
```
|
||||
0_87-the_prismatic_release.md
|
||||
```
|
||||
6. Make a commit for the release notes:
|
||||
```
|
||||
git add releasenotes/0_87-the_prismatic_release.md
|
||||
git commit -m "Add release notes for v0.87"
|
||||
```
|
||||
7. **Tag and push to the tag:**
|
||||
```
|
||||
git tag 0.87.0
|
||||
git push origin 0.87.0
|
||||
```
|
||||
8. Update version in game.conf to the next version with -SNAPSHOT suffix:
|
||||
```
|
||||
git commit -m "Post-release set version 0.88.0-SNAPSHOT"
|
||||
```
|
||||
9. Push the above to a new branch, and make the release PR. Merge to finalize release process.
|
||||
|
||||
### Release via ContentDB
|
||||
git add README.md
|
||||
# To uncomment when applicable
|
||||
#git add game.conf
|
||||
|
||||
1. Go to VoxeLibre page (https://content.minetest.net/packages/Wuzzy/mineclone2/)
|
||||
2. Click [+Release] button
|
||||
3. Enter the release tag number in the title and Git reference box. For example (without quotes): "0.87.0"
|
||||
4. In the minimum minetest version, put the oldest supported version (as of 19/05/2024 it is 5.6), leave the Maximum minetest version blank
|
||||
5. Click save. Release is now live.
|
||||
git commit -m "Pre-release update credits and set version 0.81.1"
|
||||
|
||||
### After releasing
|
||||
git tag 0.81.1
|
||||
|
||||
...inform people.
|
||||
|
||||
* Open a release meta issue on the tracker, unpin and close the issue for the previous release, pin the new one.
|
||||
* Upload video to YouTube.
|
||||
* Add a comment to the forum post with the release number and change log. Maintainer will update the main post with code link.
|
||||
* Add a Discord announcement post and @everyone with link to the release issue, release notes and other content, like video and forum post.
|
||||
* Add a Matrix announcement post and @room with links like above.
|
||||
* Share the news on reddit + Lemmy. Good subs to share with:
|
||||
* r/linux_gaming
|
||||
* r/opensourcegames
|
||||
* r/opensource
|
||||
* r/freesoftware
|
||||
* r/linuxmasterrace
|
||||
* r/VoxeLibre
|
||||
* r/MineClone2 (*for now*)
|
||||
|
||||
|
||||
## Hotfix Release
|
||||
|
||||
### Before releasing
|
||||
|
||||
First, determine if the current state of the master branch is fine for the Hotfix.
|
||||
In general, Hotfixes shouldn't contain new features to minimize the risk of regressions.
|
||||
|
||||
* If it hasn't been long since the release, and the only PRs merged so far are bugfixes and/or documentation changes,
|
||||
it is certainly fine to use it as a base for the release.
|
||||
* If there are some features merged, but they are aimed at fixing/alleviating important issues with the last released version, it may still be fine.
|
||||
* If there are some simple QoL features merged that are irrelevant to the last release, it may still be fine to use it as a base for the Hotfix.
|
||||
* If there are major features or large overhauls merged, it *most probably* is **not** fine to use as a base for the Hotfix.
|
||||
|
||||
If you decided that the current state of the master branch can be used as the Hotfix version, make sure that all the PRs merged since the last release
|
||||
are in the Hotfix milestone and you are working on a clean branch based on the master branch, up-to-date with the one on the repo.
|
||||
In this case, **skip** the following section.
|
||||
|
||||
### Prepare release branch
|
||||
|
||||
If you decided that the current state of the master branch shouldn't be used as the Hotfix version, you must prepare a release branch.
|
||||
|
||||
1. Create release branch from the last release tag, push it:
|
||||
```
|
||||
git checkout -b release/0.82.1 0.82.0
|
||||
git push origin release/0.82.1
|
||||
```
|
||||
2. Cherry-pick the relevant commits from the master branch, or merge them from other (PR) branches.
|
||||
3. Make sure your local copy of the branch contains all the relevant changes, **do not rebase**.
|
||||
|
||||
### Release process
|
||||
|
||||
1. Update CREDITS.md if it is needed
|
||||
2. Update version in game.conf
|
||||
3. If you've changed CREDITS.md, run the script:
|
||||
```
|
||||
lua tools/generate_ingame_credits.lua
|
||||
```
|
||||
4. Make a commit for the above:
|
||||
```
|
||||
git add game.conf
|
||||
git commit -m "Set version for hotfix v0.87.1"
|
||||
```
|
||||
or, if credits got updated:
|
||||
```
|
||||
git add CREDITS.md
|
||||
git add mods/HUD/mcl_credits/people.lua
|
||||
git add game.conf
|
||||
git commit -m "Updated release credits and set version for hotfix v0.87.1"
|
||||
```
|
||||
5. Add a section in the last releasnotes, like this:
|
||||
```
|
||||
## 0.87.1 hotfix
|
||||
```
|
||||
and describe the changes there
|
||||
|
||||
6. Make a commit for the releasenotes changes:
|
||||
```
|
||||
git add releasenotes/0_87-the_prismatic_release.md
|
||||
git commit -m "Update release notes for hotfix v0.87.1"
|
||||
```
|
||||
7. **Tag and push to the tag:**
|
||||
```
|
||||
git tag 0.87.1
|
||||
git push origin 0.87.1
|
||||
```
|
||||
8. If you are skipping some changes from the master branch (and thus are using a prepared master branch from the previous section),
|
||||
push to the remote and skip the next two steps:
|
||||
```
|
||||
git push origin release/0.82.1
|
||||
```
|
||||
9. If you're releasing master branch, update version in game.conf to the next version with -SNAPSHOT suffix:
|
||||
```
|
||||
git commit -m "Post-hotfix reset version 0.88.0-SNAPSHOT"
|
||||
```
|
||||
10. If you're releasing master branch, push the above to a new branch, and make the release PR. Merge to finalize release process.
|
||||
|
||||
### Release via ContentDB
|
||||
|
||||
1. Go to VoxeLibre page (https://content.minetest.net/packages/Wuzzy/mineclone2/)
|
||||
2. Click [+Release] button
|
||||
3. Enter the release tag number in the title and Git reference box. For example (without quotes): "0.87.1"
|
||||
4. In the minimum minetest version, put the oldest supported version (as of 19/05/2024 it is 5.6), leave the Maximum minetest version blank
|
||||
5. Click save. Hotfix is now live.
|
||||
|
||||
### After releasing
|
||||
|
||||
...inform people.
|
||||
|
||||
* Add a comment to the forum post with the release number and change log. Maintainer will update the main post with code link.
|
||||
* Add a Discord announcement post and @everyone with link to the release issue and release notes, and describe briefly what the hotfix does.
|
||||
* Add a Matrix announcement post and @room with content like above.
|
||||
* Share the news on reddit + Lemmy. Good subs to share with:
|
||||
* r/linux_gaming
|
||||
* r/opensourcegames
|
||||
* r/opensource
|
||||
* r/freesoftware
|
||||
* r/linuxmasterrace
|
||||
* r/VoxeLibre
|
||||
* r/MineClone2 (*for now*)
|
||||
git push origin 0.81.1
|
||||
57
TEXTURES.md
57
TEXTURES.md
|
|
@ -1,57 +0,0 @@
|
|||
# Making Textures In VoxeLibre
|
||||
|
||||
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/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
|
||||
|
||||
## Recommended Software
|
||||
|
||||
### GIMP
|
||||
|
||||
GIMP (GNU Image Manipulation Program) is a very popular and free image editing software supported on Windows, MacOS, and most Linux distributions. It is recommended to use GIMP to create and modify textures within the minetest engine.
|
||||
|
||||
Download GIMP [here](http://gimp.org/)
|
||||
|
||||
# Getting Started
|
||||
## Creating a new file
|
||||
the first thing to do is open GIMP and create a new file to work in by opening the File menu and choosing "New".
|
||||
|
||||
Choose width of 16 and height of 16 for the image size. While higher resolution textures are possible, The default size is 16x16. It is recommended you use this size as well, as it is universally supported on all systems.
|
||||
|
||||
## Zoom In
|
||||
Next, you'll want to zoom in as the canvas is very small at the default zoom level. To do this either use CTRL + mousewheel, +/-, or navigate to the View menu > zoom > zoom in
|
||||
|
||||
## Configure Grid
|
||||
Now, we'll want to turn on the grid. Open the edit menu and enable the 'show grid' option.
|
||||
|
||||
The default grid size is 10 pixels, we want to change it to a 1 pixel grid. Go to the Image menu and choose 'configure grid.
|
||||
|
||||
In the Spacing section, change both the Horizontal and Vertical pixel settings to 1.00 then click ok and the grid will update.
|
||||
|
||||
## Pencil Tool & Color Picking
|
||||
The most useful brush type for pixel art is the Pencil tool. Its nested under the paintbrush tool in the toolbox, or you can use the keyboard shortcut 'N'.
|
||||
|
||||
Once the pencil tool is selected, navigate to the sliders on the left side of the canvas and change brush size to 1 pixel.
|
||||
|
||||
Now choose a color! You can do this by clicking on the two colored squares under the toolbox. The Color Picker tool is also a good option if you already have a reference image for color palette.
|
||||
|
||||
## How to export optimally
|
||||
|
||||
Once you have finished up a texture and are ready to export it, navigate to the file menu > export as... and make sure the file name extention is .png
|
||||
|
||||
After clicking 'Export', a menu will appear with a bunch of options checked. Make sure to uncheck all of these options!!! This will drastically reduce the file size from multiple kilobytes to a couple of hundred bytes. Finally click 'Export' one more time.
|
||||
|
||||
### Further optimization with OptiPNG
|
||||
For those running a GNU/linux distribution, you most likely have the 'optipng' command available to you. If it does not come with your system by default, the software homepage can be found [here](https://optipng.sourceforge.net/) where you can download and install from source.
|
||||
|
||||
First, Open up the terminal in the directory where your exported texture is located (or navigate to the directory with the 'cd your/directory/path/to/textures'), then run this command
|
||||
```
|
||||
optipng -o7 -zm1-9 -nc -clobber -strip all *.png
|
||||
```
|
||||
This will further optimize all the textures in the directory.
|
||||
|
||||
NOTE: If you would like to further edit a texture that has been optipng'd in GIMP, you must manually set the color palette back to RBG after opening. Navigate to Image menu > Mode > select RGB
|
||||
|
|
@ -1 +1 @@
|
|||
A survival sandbox game. Survive, gather, hunt, mine, build, explore, and do much more.
|
||||
A survival sandbox game. Survive, gather, hunt, mine, build, explore, and do much more. Faithful clone of Minecraft 1.12. This is a work in progress! Expect bugs!
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
title = VoxeLibre
|
||||
title = MineClone 2
|
||||
description = A survival sandbox game. Survive, gather, hunt, build, explore, and do much more.
|
||||
disallowed_mapgens = v6
|
||||
version=0.88.0-SNAPSHOT
|
||||
version=MCL2-0.82-indev
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 151 KiB After Width: | Height: | Size: 83 KiB |
BIN
menu/footer.png
BIN
menu/footer.png
Binary file not shown.
|
Before Width: | Height: | Size: 1.3 KiB After Width: | Height: | Size: 1.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 82 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 81 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 82 KiB |
BIN
menu/header.png
BIN
menu/header.png
Binary file not shown.
|
Before Width: | Height: | Size: 113 KiB After Width: | Height: | Size: 82 KiB |
BIN
menu/icon.png
BIN
menu/icon.png
Binary file not shown.
|
Before Width: | Height: | Size: 19 KiB After Width: | Height: | Size: 51 KiB |
|
|
@ -16,7 +16,7 @@ information.
|
|||
How the mod is used
|
||||
===================
|
||||
|
||||
In VoxeLibre, all diggable nodes have the hardness set in the custom field
|
||||
In MineClone 2, 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:
|
||||
|
|
@ -204,7 +204,7 @@ end
|
|||
|
||||
-- Checks if the given node would drop its useful drop if dug by a given tool.
|
||||
-- Returns true if it will yield its useful drop, false otherwise.
|
||||
function mcl_autogroup.can_harvest(nodename, toolname, player)
|
||||
function mcl_autogroup.can_harvest(nodename, toolname)
|
||||
local ndef = minetest.registered_nodes[nodename]
|
||||
|
||||
if not ndef then
|
||||
|
|
@ -215,10 +215,6 @@ function mcl_autogroup.can_harvest(nodename, toolname, player)
|
|||
return true
|
||||
end
|
||||
|
||||
if minetest.get_item_group(nodename, "dig_immediate_piston") >= 1 then
|
||||
return true
|
||||
end
|
||||
|
||||
-- Check if it can be dug by tool
|
||||
local tdef = minetest.registered_tools[toolname]
|
||||
if tdef and tdef._mcl_diggroups then
|
||||
|
|
@ -232,9 +228,7 @@ function mcl_autogroup.can_harvest(nodename, toolname, player)
|
|||
end
|
||||
|
||||
-- Check if it can be dug by hand
|
||||
if not player or not player:is_player() then return false end
|
||||
local name = player:get_inventory():get_stack("hand", 1):get_name()
|
||||
local tdef = minetest.registered_items[name]
|
||||
local tdef = minetest.registered_tools[""]
|
||||
if tdef then
|
||||
for g, gdef in pairs(tdef._mcl_diggroups) do
|
||||
if ndef.groups[g] then
|
||||
|
|
@ -266,7 +260,7 @@ local function get_tool_capabilities(tdef)
|
|||
|
||||
-- If the damage group and punch interval from hand is not included,
|
||||
-- then the user will not be able to attack with the tool.
|
||||
local hand_toolcaps = mcl_meshhand.survival_hand_tool_caps
|
||||
local hand_toolcaps = minetest.registered_tools[""].tool_capabilities
|
||||
return {
|
||||
full_punch_interval = hand_toolcaps.full_punch_interval,
|
||||
damage_groups = hand_toolcaps.damage_groups
|
||||
|
|
@ -286,7 +280,7 @@ end
|
|||
-- would have to add _mcl_autogroup as a dependency which would break the mod
|
||||
-- loading order.
|
||||
function mcl_autogroup.get_groupcaps(toolname, efficiency)
|
||||
local tdef = minetest.registered_items[toolname]
|
||||
local tdef = minetest.registered_tools[toolname]
|
||||
local groupcaps = table.copy(get_tool_capabilities(tdef).groupcaps or {})
|
||||
add_groupcaps(toolname, groupcaps, tdef._mcl_diggroups, efficiency)
|
||||
return groupcaps
|
||||
|
|
@ -304,10 +298,6 @@ end
|
|||
-- loading order.
|
||||
function mcl_autogroup.get_wear(toolname, diggroup)
|
||||
local tdef = minetest.registered_tools[toolname]
|
||||
if not tdef then
|
||||
minetest.log("warning", "Adding wear for tool: " .. tostring(toolname) .. " failed with diggroup: " .. tostring(diggroup))
|
||||
return nil
|
||||
end
|
||||
local uses = tdef._mcl_diggroups[diggroup].uses
|
||||
return math.ceil(65535 / uses)
|
||||
end
|
||||
|
|
@ -360,7 +350,7 @@ local function overwrite()
|
|||
end
|
||||
end
|
||||
|
||||
for tname, tdef in pairs(minetest.registered_items) do
|
||||
for tname, tdef in pairs(minetest.registered_tools) do
|
||||
-- Assign groupcaps for digging the registered digging groups
|
||||
-- depending on the _mcl_diggroups in the tool definition
|
||||
if tdef._mcl_diggroups then
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
name = _mcl_autogroup
|
||||
author = ryvnf
|
||||
description = VoxeLibre core mod which automatically adds groups to all items. Very important for digging times.
|
||||
description = MineClone 2 core mod which automatically adds groups to all items. Very important for digging times.
|
||||
|
|
|
|||
|
|
@ -31,7 +31,6 @@ local known_controls = {
|
|||
aux1 = true,
|
||||
down = true,
|
||||
up = true,
|
||||
zoom = true,
|
||||
}
|
||||
|
||||
minetest.register_on_joinplayer(function(player)
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
-- Overrides the builtin minetest.check_single_for_falling.
|
||||
-- We need to do this in order to handle nodes in VoxeLibre specific groups
|
||||
-- We need to do this in order to handle nodes in mineclone specific groups
|
||||
-- "supported_node" and "attached_node_facedir".
|
||||
--
|
||||
-- Nodes in group "supported_node" can be placed on any node that does not
|
||||
|
|
@ -94,16 +94,5 @@ function minetest.check_single_for_falling(pos)
|
|||
end
|
||||
end
|
||||
|
||||
if get_item_group(node.name, "supported_node_facedir") ~= 0 then
|
||||
local dir = facedir_to_dir(node.param2)
|
||||
if dir then
|
||||
local def = registered_nodes[get_node(vector.add(pos, dir)).name]
|
||||
if def and def.drawtype == "airlike" then
|
||||
drop_attached_node(pos)
|
||||
return true
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
return false
|
||||
end
|
||||
|
|
|
|||
|
|
@ -1,11 +1,10 @@
|
|||
# mcl_autogroup
|
||||
This mod emulate digging times from mc.
|
||||
|
||||
## mcl_autogroup.can_harvest(nodename, toolname, player)
|
||||
Return true if <nodename> can be dig with <toolname> by <player>.
|
||||
## mcl_autogroup.can_harvest(nodename, toolname)
|
||||
Return true if <nodename> can be dig with <toolname>.
|
||||
* nodename: string, valid nodename
|
||||
* toolname: (optional) string, valid toolname
|
||||
* player: (optinal) ObjectRef, valid player
|
||||
|
||||
## mcl_autogroup.get_groupcaps(toolname, efficiency)
|
||||
This function is used to calculate diggroups for tools.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
name = mcl_autogroup
|
||||
author = ryvnf
|
||||
description = VoxeLibre core mod which automatically adds groups to all items. Very important for digging times.
|
||||
description = MineClone 2 core mod which automatically adds groups to all items. Very important for digging times.
|
||||
|
|
|
|||
|
|
@ -96,8 +96,8 @@ function mcl_damage.finish_reason(mcl_reason)
|
|||
end
|
||||
|
||||
function mcl_damage.from_mt(mt_reason)
|
||||
if mt_reason._mcl_cached_reason then
|
||||
return mt_reason._mcl_cached_reason
|
||||
if mt_reason._mcl_chached_reason then
|
||||
return mt_reason._mcl_chached_reason
|
||||
end
|
||||
|
||||
local mcl_reason
|
||||
|
|
@ -155,6 +155,7 @@ end, true)
|
|||
minetest.register_on_player_hpchange(function(player, hp_change, mt_reason)
|
||||
if not damage_enabled then return 0 end
|
||||
if player:get_hp() > 0 then
|
||||
mt_reason.approved = true
|
||||
if hp_change < 0 then
|
||||
mcl_damage.run_damage_callbacks(player, -hp_change, mcl_damage.from_mt(mt_reason))
|
||||
end
|
||||
|
|
@ -162,7 +163,9 @@ minetest.register_on_player_hpchange(function(player, hp_change, mt_reason)
|
|||
end, false)
|
||||
|
||||
minetest.register_on_dieplayer(function(player, mt_reason)
|
||||
mcl_damage.run_death_callbacks(player, mcl_damage.from_mt(mt_reason))
|
||||
if mt_reason.approved then
|
||||
mcl_damage.run_death_callbacks(player, mcl_damage.from_mt(mt_reason))
|
||||
end
|
||||
minetest.log("action","Player "..player:get_player_name().." died at "..minetest.pos_to_string(vector.round(player:get_pos())))
|
||||
end)
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
--[[
|
||||
Explosion API mod for Minetest (adapted to VoxeLibre)
|
||||
Explosion API mod for Minetest (adapted to MineClone 2)
|
||||
|
||||
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 VoxeLibre
|
||||
to have the same explosion mechanics as Minecraft and work with MineClone.
|
||||
The computation-intensive parts of the mod has been optimized to allow for
|
||||
larger explosions and faster world updating.
|
||||
|
||||
|
|
@ -13,7 +13,6 @@ under the LGPLv2.1 license.
|
|||
mcl_explosions = {}
|
||||
|
||||
local mod_fire = minetest.get_modpath("mcl_fire")
|
||||
local explosions_griefing = minetest.settings:get_bool("mcl_explosions_griefing", true)
|
||||
--local CONTENT_FIRE = minetest.get_content_id("mcl_fire:fire")
|
||||
|
||||
local math = math
|
||||
|
|
@ -192,7 +191,7 @@ local function trace_explode(pos, strength, raydirs, radius, info, direct, sourc
|
|||
local grief_protected = info.grief_protected
|
||||
|
||||
-- Trace rays for environment destruction
|
||||
if info.griefing and explosions_griefing then
|
||||
if info.griefing then
|
||||
for i = 1, #raydirs do
|
||||
local rpos_x = pos.x
|
||||
local rpos_y = pos.y
|
||||
|
|
@ -352,23 +351,6 @@ local function trace_explode(pos, strength, raydirs, radius, info, direct, sourc
|
|||
end
|
||||
end
|
||||
end
|
||||
|
||||
-- Punch End Crystals to make them explode
|
||||
if ent and ent.name == "mcl_end:crystal" then
|
||||
if direct then
|
||||
local puncher = direct:get_luaentity()
|
||||
if puncher and puncher.name == "mcl_end:crystal" then
|
||||
ent.object:punch(direct, 1.0, { -- End Crystal nearby, trigger it.
|
||||
full_punch_interval = 1.0,
|
||||
damage_groups = {fleshy = 1},
|
||||
}, nil, nil)
|
||||
else
|
||||
ent.object:remove() -- Direct Exists, but it is not an end crystal, remove crystal.
|
||||
end
|
||||
else
|
||||
ent.object:remove() -- Node exploded the end crystal, remove it.
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
local airs, fires = {}, {}
|
||||
|
|
|
|||
|
|
@ -1,2 +0,0 @@
|
|||
# textdomain:mcl_explosions
|
||||
@1 was caught in an explosion.=@1 est mort dans une explosion
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
# textdomain:mcl_explosions
|
||||
@1 was caught in an explosion.=@1 z-es mòrt dins una explosion
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
# textdomain:mcl_explosions
|
||||
@1 was caught in an explosion.=@1 foi pego(a) em uma explosão.
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
# textdomain:mcl_explosions
|
||||
@1 was caught in an explosion.=@1 попал(а) под взрыв.
|
||||
|
|
@ -1,2 +0,0 @@
|
|||
# textdomain:mcl_explosions
|
||||
@1 was caught in an explosion.=
|
||||
|
|
@ -1,30 +1,28 @@
|
|||
-- Some global variables (don't overwrite them!)
|
||||
mcl_vars = {}
|
||||
|
||||
minetest.log("action", "World seed = " .. minetest.get_mapgen_setting("seed"))
|
||||
|
||||
mcl_vars.redstone_tick = 0.1
|
||||
|
||||
-- GUI / inventory menu settings
|
||||
--- GUI / inventory menu settings
|
||||
mcl_vars.gui_slots = "listcolors[#9990;#FFF7;#FFF0;#000;#FFF]"
|
||||
|
||||
-- nonbg is added as formspec prepend in mcl_formspec_prepend
|
||||
mcl_vars.gui_nonbg = table.concat({
|
||||
mcl_vars.gui_slots,
|
||||
"style_type[image_button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]",
|
||||
"style_type[button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]",
|
||||
"style_type[field;textcolor=#323232]",
|
||||
"style_type[label;textcolor=#323232]",
|
||||
"style_type[textarea;textcolor=#323232]",
|
||||
"style_type[checkbox;textcolor=#323232]",
|
||||
})
|
||||
mcl_vars.gui_nonbg = mcl_vars.gui_slots ..
|
||||
"style_type[image_button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]"..
|
||||
"style_type[button;border=false;bgimg=mcl_inventory_button9.png;bgimg_pressed=mcl_inventory_button9_pressed.png;bgimg_middle=2,2]"..
|
||||
"style_type[field;textcolor=#323232]"..
|
||||
"style_type[label;textcolor=#323232]"..
|
||||
"style_type[textarea;textcolor=#323232]"..
|
||||
"style_type[checkbox;textcolor=#323232]"
|
||||
|
||||
-- Background stuff must be manually added by mods (no formspec prepend)
|
||||
mcl_vars.gui_bg_color = "bgcolor[#00000000]"
|
||||
mcl_vars.gui_bg_img = "background9[1,1;1,1;mcl_base_textures_background9.png;true;7]"
|
||||
|
||||
-- Legacy
|
||||
mcl_vars.inventory_header = ""
|
||||
|
||||
-- Tool wield size
|
||||
mcl_vars.tool_wield_scale = vector.new(1.8, 1.8, 1)
|
||||
mcl_vars.tool_wield_scale = { x = 1.8, y = 1.8, z = 1 }
|
||||
|
||||
-- Mapgen variables
|
||||
local mg_name = minetest.get_mapgen_setting("mg_name")
|
||||
|
|
@ -37,71 +35,55 @@ mcl_vars.chunksize = math.max(1, tonumber(minetest.get_mapgen_setting("chunksize
|
|||
mcl_vars.MAP_BLOCKSIZE = math.max(1, minetest.MAP_BLOCKSIZE or 16)
|
||||
mcl_vars.mapgen_limit = math.max(1, tonumber(minetest.get_mapgen_setting("mapgen_limit")) or 31000)
|
||||
mcl_vars.MAX_MAP_GENERATION_LIMIT = math.max(1, minetest.MAX_MAP_GENERATION_LIMIT or 31000)
|
||||
|
||||
-- Central chunk is offset from 0,0,0 coordinates by 32 nodes (2 blocks)
|
||||
-- See more in https://git.minetest.land/VoxeLibre/VoxeLibre/wiki/World-structure%3A-positions%2C-boundaries%2C-blocks%2C-chunks%2C-dimensions%2C-barriers-and-the-void
|
||||
local central_chunk_offset = -math.floor(mcl_vars.chunksize / 2)
|
||||
|
||||
mcl_vars.central_chunk_offset_in_nodes = central_chunk_offset * mcl_vars.MAP_BLOCKSIZE
|
||||
mcl_vars.chunk_size_in_nodes = mcl_vars.chunksize * mcl_vars.MAP_BLOCKSIZE
|
||||
|
||||
local central_chunk_min_pos = central_chunk_offset * mcl_vars.MAP_BLOCKSIZE
|
||||
local central_chunk_max_pos = central_chunk_min_pos + mcl_vars.chunk_size_in_nodes - 1
|
||||
local ccfmin = central_chunk_min_pos - mcl_vars.MAP_BLOCKSIZE -- Fullminp/fullmaxp of central chunk, in nodes
|
||||
local ccfmax = central_chunk_max_pos + mcl_vars.MAP_BLOCKSIZE
|
||||
local mapgen_limit_b = math.floor(math.min(mcl_vars.mapgen_limit, mcl_vars.MAX_MAP_GENERATION_LIMIT) /
|
||||
mcl_vars.MAP_BLOCKSIZE)
|
||||
local mapgen_limit_b = math.floor(math.min(mcl_vars.mapgen_limit, mcl_vars.MAX_MAP_GENERATION_LIMIT) / mcl_vars.MAP_BLOCKSIZE)
|
||||
local mapgen_limit_min = -mapgen_limit_b * mcl_vars.MAP_BLOCKSIZE
|
||||
local mapgen_limit_max = (mapgen_limit_b + 1) * mcl_vars.MAP_BLOCKSIZE - 1
|
||||
local numcmin = math.max(math.floor((ccfmin - mapgen_limit_min) / mcl_vars.chunk_size_in_nodes), 0) -- Number of complete chunks from central chunk
|
||||
local numcmax = math.max(math.floor((mapgen_limit_max - ccfmax) / mcl_vars.chunk_size_in_nodes), 0) -- fullminp/fullmaxp to effective mapgen limits.
|
||||
|
||||
mcl_vars.mapgen_edge_min = central_chunk_min_pos - numcmin * mcl_vars.chunk_size_in_nodes
|
||||
mcl_vars.mapgen_edge_max = central_chunk_max_pos + numcmax * mcl_vars.chunk_size_in_nodes
|
||||
|
||||
---@param x integer
|
||||
---@return integer
|
||||
local function coordinate_to_block(x)
|
||||
return math.floor(x / mcl_vars.MAP_BLOCKSIZE)
|
||||
end
|
||||
|
||||
---@param x integer
|
||||
---@return integer
|
||||
local function coordinate_to_chunk(x)
|
||||
return math.floor((coordinate_to_block(x) - central_chunk_offset) / mcl_vars.chunksize)
|
||||
end
|
||||
|
||||
---@param pos Vector
|
||||
---@return Vector
|
||||
function mcl_vars.pos_to_block(pos)
|
||||
return vector.new(
|
||||
coordinate_to_block(pos.x),
|
||||
coordinate_to_block(pos.y),
|
||||
coordinate_to_block(pos.z)
|
||||
)
|
||||
return {
|
||||
x = coordinate_to_block(pos.x),
|
||||
y = coordinate_to_block(pos.y),
|
||||
z = coordinate_to_block(pos.z)
|
||||
}
|
||||
end
|
||||
|
||||
---@param pos Vector
|
||||
---@return Vector
|
||||
function mcl_vars.pos_to_chunk(pos)
|
||||
return vector.new(
|
||||
coordinate_to_chunk(pos.x),
|
||||
coordinate_to_chunk(pos.y),
|
||||
coordinate_to_chunk(pos.z)
|
||||
)
|
||||
return {
|
||||
x = coordinate_to_chunk(pos.x),
|
||||
y = coordinate_to_chunk(pos.y),
|
||||
z = coordinate_to_chunk(pos.z)
|
||||
}
|
||||
end
|
||||
|
||||
local k_positive = math.ceil(mcl_vars.MAX_MAP_GENERATION_LIMIT / mcl_vars.chunk_size_in_nodes)
|
||||
local k_positive_z = k_positive * 2
|
||||
local k_positive_y = k_positive_z * k_positive_z
|
||||
|
||||
---@param pos Vector
|
||||
---@return integer
|
||||
function mcl_vars.get_chunk_number(pos) -- unsigned int
|
||||
local c = mcl_vars.pos_to_chunk(pos)
|
||||
return (c.y + k_positive) * k_positive_y +
|
||||
return
|
||||
(c.y + k_positive) * k_positive_y +
|
||||
(c.z + k_positive) * k_positive_z +
|
||||
c.x + k_positive
|
||||
c.x + k_positive
|
||||
end
|
||||
|
||||
if not superflat and not singlenode then
|
||||
|
|
@ -135,8 +117,11 @@ elseif singlenode then
|
|||
mcl_vars.mg_bedrock_is_rough = false
|
||||
else
|
||||
-- Classic superflat
|
||||
local ground = tonumber(minetest.get_mapgen_setting("mgflat_ground_level")) or 8
|
||||
|
||||
local ground = minetest.get_mapgen_setting("mgflat_ground_level")
|
||||
ground = tonumber(ground)
|
||||
if not ground then
|
||||
ground = 8
|
||||
end
|
||||
mcl_vars.mg_overworld_min = ground - 3
|
||||
mcl_vars.mg_overworld_max_official = mcl_vars.mg_overworld_min + minecraft_height_limit
|
||||
mcl_vars.mg_bedrock_overworld_min = mcl_vars.mg_overworld_min
|
||||
|
|
@ -185,7 +170,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 VoxeLibre-style dungeons
|
||||
-- Use MineClone 2-style dungeons
|
||||
mcl_vars.mg_dungeons = true
|
||||
|
||||
-- Set default stack sizes
|
||||
|
|
@ -196,16 +181,14 @@ minetest.craftitemdef_default.stack_max = 64
|
|||
math.randomseed(os.time())
|
||||
|
||||
local chunks = {} -- intervals of chunks generated
|
||||
|
||||
---@param pos Vector
|
||||
function mcl_vars.add_chunk(pos)
|
||||
local n = mcl_vars.get_chunk_number(pos) -- unsigned int
|
||||
local prev
|
||||
for i, d in pairs(chunks) do
|
||||
if n <= d[2] then -- we've found it
|
||||
if (n == d[2]) or (n >= d[1]) then return end -- already here
|
||||
if n == d[1] - 1 then -- right before:
|
||||
if prev and (prev[2] == n - 1) then
|
||||
if n == d[1]-1 then -- right before:
|
||||
if prev and (prev[2] == n-1) then
|
||||
prev[2] = d[2]
|
||||
table.remove(chunks, i)
|
||||
return
|
||||
|
|
@ -213,20 +196,17 @@ function mcl_vars.add_chunk(pos)
|
|||
d[1] = n
|
||||
return
|
||||
end
|
||||
if prev and (prev[2] == n - 1) then --join to previous
|
||||
if prev and (prev[2] == n-1) then --join to previous
|
||||
prev[2] = n
|
||||
return
|
||||
end
|
||||
table.insert(chunks, i, { n, n }) -- insert new interval before i
|
||||
table.insert(chunks, i, {n, n}) -- insert new interval before i
|
||||
return
|
||||
end
|
||||
prev = d
|
||||
end
|
||||
chunks[#chunks + 1] = { n, n }
|
||||
chunks[#chunks+1] = {n, n}
|
||||
end
|
||||
|
||||
---@param pos Vector
|
||||
---@return boolean
|
||||
function mcl_vars.is_generated(pos)
|
||||
local n = mcl_vars.get_chunk_number(pos) -- unsigned int
|
||||
for i, d in pairs(chunks) do
|
||||
|
|
@ -237,46 +217,47 @@ function mcl_vars.is_generated(pos)
|
|||
return false
|
||||
end
|
||||
|
||||
---"Trivial" (actually NOT) function to just read the node and some stuff to not just return "ignore", like mt 5.4 does.
|
||||
---@param pos Vector Position, if it's wrong, `{name="error"}` node will return.
|
||||
---@param force? boolean Optional (default: `false`), Do the maximum to still read the node within us_timeout.
|
||||
---@param us_timeout? number Optional (default: `244 = 0.000244 s = 1/80/80/80`), set it at least to `3000000` to let mapgen to finish its job
|
||||
---@return node # Node definition, eg. `{name="air"}`. Unfortunately still can return `{name="ignore"}`.
|
||||
---@nodiscard
|
||||
function mcl_vars.get_node(pos, force, us_timeout)
|
||||
-- "Trivial" (actually NOT) function to just read the node and some stuff to not just return "ignore", like mt 5.4 does.
|
||||
-- p: Position, if it's wrong, {name="error"} node will return.
|
||||
-- force: optional (default: false) - Do the maximum to still read the node within us_timeout.
|
||||
-- us_timeout: optional (default: 244 = 0.000244 s = 1/80/80/80), set it at least to 3000000 to let mapgen to finish its job.
|
||||
--
|
||||
-- returns node definition, eg. {name="air"}. Unfortunately still can return {name="ignore"}.
|
||||
function mcl_vars.get_node(p, force, us_timeout)
|
||||
-- check initial circumstances
|
||||
if not pos or not pos.x or not pos.y or not pos.z then return { name = "error" } end
|
||||
if not p or not p.x or not p.y or not p.z then return {name="error"} end
|
||||
|
||||
-- try common way
|
||||
local node = minetest.get_node(pos)
|
||||
local node = minetest.get_node(p)
|
||||
if node.name ~= "ignore" then
|
||||
return node
|
||||
end
|
||||
|
||||
-- copy vector to get sure it won't changed by other threads
|
||||
local pos_copy = vector.copy(pos)
|
||||
-- copy table to get sure it won't changed by other threads
|
||||
local pos = {x=p.x,y=p.y,z=p.z}
|
||||
|
||||
-- try LVM
|
||||
minetest.get_voxel_manip():read_from_map(pos_copy, pos_copy)
|
||||
node = minetest.get_node(pos_copy)
|
||||
minetest.get_voxel_manip():read_from_map(pos, pos)
|
||||
node = minetest.get_node(pos)
|
||||
if node.name ~= "ignore" or not force then
|
||||
return node
|
||||
end
|
||||
|
||||
-- all ways failed - need to emerge (or forceload if generated)
|
||||
if mcl_vars.is_generated(pos_copy) then
|
||||
local us_timeout = us_timeout or 244
|
||||
if mcl_vars.is_generated(pos) then
|
||||
minetest.chat_send_all("IMPOSSIBLE! Please report this to MCL2 issue tracker!")
|
||||
minetest.forceload_block(pos_copy)
|
||||
minetest.forceload_block(pos)
|
||||
else
|
||||
minetest.emerge_area(pos_copy, pos_copy)
|
||||
minetest.emerge_area(pos, pos)
|
||||
end
|
||||
|
||||
local t = minetest.get_us_time()
|
||||
|
||||
node = minetest.get_node(pos_copy)
|
||||
node = minetest.get_node(pos)
|
||||
|
||||
while (not node or node.name == "ignore") and (minetest.get_us_time() - t < (us_timeout or 244)) do
|
||||
node = minetest.get_node(pos_copy)
|
||||
while (not node or node.name == "ignore") and (minetest.get_us_time() - t < us_timeout) do
|
||||
node = minetest.get_node(pos)
|
||||
end
|
||||
|
||||
return node
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
name = mcl_init
|
||||
author = Wuzzy
|
||||
description = Initialization mod of VoxeLibre. Defines some common shared variables and sets up initial default settings which have to be set at the beginning.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,14 +0,0 @@
|
|||
# Oxidization API for VoxeLibre
|
||||
This mods adds the oxidization api, so that modders can easily use the same features that copper uses.
|
||||
|
||||
## API
|
||||
To take advantage of the actual oxidization, put `oxidizable = 1` into the list of groups for the oxidizable node.
|
||||
You would also need to put `_mcl_oxidized_variant = itemstring of node this node will oxidize into` into the node definition.
|
||||
For example, a copper block oxidizes into exposed copper, so the defintion would be `_mcl_oxidized_variant = "mcl_copper:block_exposed"`.
|
||||
|
||||
To utilize the ability to wax the block for protection from oxidization, put `mcl_waxed_variant = item string of waxed variant of node` into the node definition table.
|
||||
For example, Copper Blocks have the definition arguement of `_mcl_waxed_variant = "mcl_copper:waxed_block"`.
|
||||
|
||||
For waxed nodes, scraping is easy. Start by putting `waxed = 1` into the list of groups of the waxed node.
|
||||
Next put `_mcl_stripped_variant = item string of the unwaxed variant of the node` into the defintion table.
|
||||
Waxed Copper Blocks can be scrapped into normal Copper Blocks because of the definition `_mcl_stripped_variant = "mcl_copper:block"`.
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
minetest.register_abm({
|
||||
label = "Oxidatize Nodes",
|
||||
nodenames = { "group:oxidizable" },
|
||||
interval = 500,
|
||||
chance = 3,
|
||||
action = function(pos, node)
|
||||
local def = minetest.registered_nodes[node.name]
|
||||
if def and def._mcl_oxidized_variant then
|
||||
minetest.set_node(pos, { name = def._mcl_oxidized_variant, param2 = node.param2 })
|
||||
end
|
||||
end,
|
||||
})
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
name = mcl_oxidation
|
||||
title = Oxidation API for VoxeLibre
|
||||
author = PrairieWind, N011, Michael
|
||||
description = API to allow oxidizing different nodes.
|
||||
|
|
@ -1,2 +1,3 @@
|
|||
name = mcl_particles
|
||||
author = Wuzzy
|
||||
description = Contains particle images of MineClone 2. No code.
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 3.3 KiB |
|
Before Width: | Height: | Size: 126 B After Width: | Height: | Size: 126 B |
|
Before Width: | Height: | Size: 127 B After Width: | Height: | Size: 127 B |
|
Before Width: | Height: | Size: 91 B After Width: | Height: | Size: 91 B |
|
Before Width: | Height: | Size: 137 B After Width: | Height: | Size: 137 B |
|
Before Width: | Height: | Size: 145 B After Width: | Height: | Size: 145 B |
|
Before Width: | Height: | Size: 125 B After Width: | Height: | Size: 125 B |
Binary file not shown.
|
After Width: | Height: | Size: 183 B |
Binary file not shown.
|
After Width: | Height: | Size: 262 B |
Binary file not shown.
|
After Width: | Height: | Size: 126 B |
|
Before Width: | Height: | Size: 126 B After Width: | Height: | Size: 126 B |
Binary file not shown.
|
After Width: | Height: | Size: 216 B |
|
Before Width: | Height: | Size: 144 B After Width: | Height: | Size: 144 B |
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.1 KiB |
|
Before Width: | Height: | Size: 101 B After Width: | Height: | Size: 101 B |
Binary file not shown.
|
After Width: | Height: | Size: 148 B |
Binary file not shown.
|
After Width: | Height: | Size: 154 B |
Binary file not shown.
|
After Width: | Height: | Size: 155 B |
Binary file not shown.
|
After Width: | Height: | Size: 165 B |
|
|
@ -39,8 +39,8 @@ Metal sounds:
|
|||
default_place_node_metal.*.ogg - Ogrebane - CC0
|
||||
- http://opengameart.org/content/wood-and-metal-sound-effects-volume-2
|
||||
|
||||
AGFX (CC BY 3.0):
|
||||
https://www.freesound.org/people/AGFX/packs/1253/
|
||||
original by anonymous (CC0 1.0), mastering by iliekprogrammar (CC0 1.0):
|
||||
https://freesound.org/people/deleted_user_2104797/sounds/166313/
|
||||
default_water_footstep.*.ogg
|
||||
|
||||
blukotek (CC0 1.0):
|
||||
|
|
|
|||
|
|
@ -166,7 +166,7 @@ end
|
|||
function mcl_sounds.node_sound_water_defaults(table)
|
||||
table = table or {}
|
||||
table.footstep = table.footstep or
|
||||
{name = "default_water_footstep", gain = 0.2}
|
||||
{name = "default_water_footstep", gain = 0.05}
|
||||
table.place = table.place or
|
||||
{name = "mcl_sounds_place_node_water", gain = 1.0}
|
||||
table.dug = table.dug or
|
||||
|
|
|
|||
|
|
@ -1,3 +1,3 @@
|
|||
name = mcl_sounds
|
||||
author = Wuzzy
|
||||
description = This mod contains the core sounds of VoxeLibre as well as helper function for mods to access them.
|
||||
description = This mod contains the core sounds of MineClone 2 as well as helper function for mods to access them.
|
||||
|
|
|
|||
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
File diff suppressed because it is too large
Load Diff
|
|
@ -1,4 +1,4 @@
|
|||
name = mcl_util
|
||||
author = Wuzzy
|
||||
description = Helper functions for VoxeLibre.
|
||||
description = Helper functions for MineClone 2.
|
||||
depends = mcl_init
|
||||
|
|
|
|||
|
|
@ -1,30 +0,0 @@
|
|||
local converter = {
|
||||
{1000, "M"},
|
||||
{900, "CM"},
|
||||
{500, "D"},
|
||||
{400, "CD"},
|
||||
{100, "C"},
|
||||
{90, "XC"},
|
||||
{50, "L"},
|
||||
{40, "XL"},
|
||||
{10, "X"},
|
||||
{9, "IX"},
|
||||
{5, "V"},
|
||||
{4, "IV"},
|
||||
{1, "I"}
|
||||
}
|
||||
|
||||
mcl_util.to_roman = function(number)
|
||||
local r = ""
|
||||
local a = number
|
||||
local i = 1
|
||||
while a > 0 do
|
||||
if a >= converter[i][1] then
|
||||
a = a - converter[i][1]
|
||||
r = r.. converter[i][2]
|
||||
else
|
||||
i = i + 1
|
||||
end
|
||||
end
|
||||
return r
|
||||
end
|
||||
|
|
@ -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 VoxeLibre.
|
||||
Takes a Minecraft layer and a “dimension” name and returns the corresponding Y coordinate for MineClone 2.
|
||||
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
|
||||
-- VoxeLibre
|
||||
-- MineClone 2.
|
||||
-- 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
|
||||
|
|
|
|||
|
|
@ -1,674 +0,0 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<https://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<https://www.gnu.org/licenses/why-not-lgpl.html>.
|
||||
|
|
@ -1,87 +1,4 @@
|
|||
# tga_encoder
|
||||
A TGA Encoder written in Lua without the use of external Libraries.
|
||||
|
||||
Created by fleckenstein for VoxeLibre, then improved by erlehmann.
|
||||
|
||||
May be used as a Minetest mod.
|
||||
|
||||
See `examples.lua` for example code and usage hints.
|
||||
|
||||
## Use Cases for `tga_encoder`
|
||||
|
||||
### Encoding Textures for Editing
|
||||
|
||||
TGA images of types 1/2/3 consist of header data followed by a pixel array.
|
||||
|
||||
This makes it trivial to parse TGA files – and even edit pixels in-place.
|
||||
|
||||
No checksums need to be updated on any kind of in-place texture editing.
|
||||
|
||||
**Tip**: When storing an editable image in item meta, use zlib compression.
|
||||
|
||||
### Legacy Minetest Texture Encoding
|
||||
|
||||
Minetest 5.4 did not include `minetest.encode_png()` (or any equvivalent).
|
||||
|
||||
Since `tga_encoder` is written in pure Lua, it does not need engine support.
|
||||
|
||||
**Tip:** Look at `examples.lua` and the Minetest mod `mcl_maps` for guidance.
|
||||
|
||||
### Advanced Texture Format Control
|
||||
|
||||
The function `minetest.encode_png()` always encodes images as 32bpp RGBA.
|
||||
|
||||
`tga_encoder` allows saving images as grayscale, 16bpp RGBA and 24bpp RGB.
|
||||
|
||||
For generating maps from terrain, color-mapped formats can be more useful.
|
||||
|
||||
### Encoding Very Small Textures
|
||||
|
||||
Images of size 8×8 or below are often smaller than an equivalent PNG file.
|
||||
|
||||
Note that on many filesystems files use at least 4096 bytes (i.e. 64×64).
|
||||
|
||||
Therefore, saving bytes on files up to a few 100 bytes is often useless.
|
||||
|
||||
### Encoding Reference Textures
|
||||
|
||||
TGA is a simple format, which makes it easy to create reference textures.
|
||||
|
||||
Using a hex editor, one can trivially see how all the pixels are stored.
|
||||
|
||||
## Supported Image Types
|
||||
|
||||
For all types, images are encoded in a fast single pass (i.e. append-only).
|
||||
|
||||
### Color-Mapped Images (Type 1)
|
||||
|
||||
These images contain a palette, followed by pixel data.
|
||||
|
||||
* `A1R5G5B5` (8bpp RGB)
|
||||
* `B8G8R8` (8bpp RGB)
|
||||
* `B8G8R8A8` (8bpp RGBA)
|
||||
|
||||
### True-Color Images (Type 2)
|
||||
|
||||
These images contain uncompressed RGB(A) pixel data.
|
||||
|
||||
* `A1R5G5B5` (16bpp RGBA)
|
||||
* `B8G8R8` (24bpp RGB)
|
||||
* `B8G8R8A8` (32bpp RGBA)
|
||||
|
||||
### Grayscale Images (Type 3)
|
||||
|
||||
* `Y8` (8bpp grayscale)
|
||||
|
||||
### Run-Length Encoded (RLE), True-Color Images (Type 10)
|
||||
|
||||
These images contain compressed RGB(A) pixel data.
|
||||
|
||||
* `A1R5G5B5` (16bpp RGBA)
|
||||
* `B8G8R8` (24bpp RGB)
|
||||
* `B8G8R8A8` (32bpp RGBA)
|
||||
|
||||
## TODO
|
||||
|
||||
* Actually support `R8G8B8A8` input for `A1R5G5B5` output
|
||||
* Add both zoomable and explorable maps to `mcl_maps`.
|
||||
|
|
|
|||
|
|
@ -1,32 +0,0 @@
|
|||
dofile("init.lua")
|
||||
|
||||
-- This generates images necessary to colorize 16 Minetest nodes in 4096 colors.
|
||||
-- It serves as a demonstration of what you can achieve using colormapped nodes.
|
||||
-- It is be useful for grass or beam or glass nodes that need to blend smoothly.
|
||||
|
||||
-- Sample depth rescaling is done according to the algorithm presented in:
|
||||
-- <https://www.w3.org/TR/2003/REC-PNG-20031110/#13Sample-depth-rescaling>
|
||||
local max_sample_in = math.pow(2, 4) - 1
|
||||
local max_sample_out = math.pow(2, 8) - 1
|
||||
|
||||
for r = 0,15 do
|
||||
local pixels = {}
|
||||
for g = 0,15 do
|
||||
if nil == pixels[g + 1] then
|
||||
pixels[g + 1] = {}
|
||||
end
|
||||
for b = 0,15 do
|
||||
local color = {
|
||||
math.floor((r * max_sample_out / max_sample_in) + 0.5),
|
||||
math.floor((g * max_sample_out / max_sample_in) + 0.5),
|
||||
math.floor((b * max_sample_out / max_sample_in) + 0.5),
|
||||
}
|
||||
pixels[g + 1][b + 1] = color
|
||||
end
|
||||
end
|
||||
local filename = "colormap_" .. tostring(r) .. ".tga"
|
||||
tga_encoder.image(pixels):save(
|
||||
filename,
|
||||
{ color_format="A1R5G5B5" } -- waste less bits
|
||||
)
|
||||
end
|
||||
|
|
@ -1,105 +0,0 @@
|
|||
#!/usr/bin/env lua5.1
|
||||
-- -*- coding: utf-8 -*-
|
||||
|
||||
-- 3D “donut” shape rendering using floating-point math
|
||||
-- see <https://www.a1k0n.net/2011/07/20/donut-math.html>
|
||||
|
||||
-- cargo-culted by erle 2023-09-18
|
||||
|
||||
local theta_spacing = 0.01 -- 0.07
|
||||
local phi_spacing = 0.002 -- 0.02
|
||||
|
||||
local R1 = 1
|
||||
local R2 = 2
|
||||
local K2 = 5
|
||||
|
||||
local screen_height = 256
|
||||
local screen_width = 256
|
||||
|
||||
local K1 = screen_width * K2 * 3 / ( 8 * ( R1 + R2 ) )
|
||||
|
||||
local output = {}
|
||||
local zbuffer = {}
|
||||
|
||||
local grey = { 120, 120, 120 }
|
||||
local gray = { 136, 136, 136 }
|
||||
|
||||
for y = 1,screen_height,1 do
|
||||
output[y] = {}
|
||||
zbuffer[y] = {}
|
||||
for x = 1,screen_width,1 do
|
||||
local hori = math.floor( ( (y - 1) / 32 ) % 2 )
|
||||
local vert = math.floor( ( (x - 1) / 32 ) % 2 )
|
||||
output[y][x] = hori ~= vert and grey or gray
|
||||
zbuffer[y][x] = 0
|
||||
end
|
||||
end
|
||||
|
||||
function render_frame(A, B)
|
||||
-- precompute sines and cosines of A and B
|
||||
local cosA = math.cos(A)
|
||||
local sinA = math.sin(A)
|
||||
local cosB = math.cos(B)
|
||||
local sinB = math.sin(B)
|
||||
|
||||
-- theta goas around the cross-sectional circle of a torus
|
||||
local theta = 0
|
||||
while theta <= 2*math.pi do
|
||||
if ( theta < 2*math.pi * 1/8 ) or ( theta > 2*math.pi * 7/8 ) then
|
||||
theta = theta + (theta_spacing * 16)
|
||||
else
|
||||
theta = theta + theta_spacing
|
||||
end
|
||||
-- precompute sines and cosines of theta
|
||||
local costheta = math.cos(theta)
|
||||
local sintheta = math.sin(theta)
|
||||
|
||||
-- phi goes around the center of revolution of a torus
|
||||
local phi = 0
|
||||
while phi <= 2*math.pi do
|
||||
if ( phi > 2*math.pi * 3/8 ) and ( phi < 2*math.pi * 5/8 ) then
|
||||
phi = phi + (phi_spacing * 128)
|
||||
else
|
||||
phi = phi + phi_spacing
|
||||
end
|
||||
-- precompute sines and cosines of phi
|
||||
local cosphi = math.cos(phi)
|
||||
local sinphi = math.sin(phi)
|
||||
|
||||
-- 2D (x, y) coordinates of the circle, before revolving
|
||||
local circlex = R2 + R1*costheta
|
||||
local circley = R1*sintheta
|
||||
|
||||
-- 3D (x, y, z) coordinates after rotation
|
||||
local x = circlex*(cosB*cosphi + sinA*sinB*sinphi) - circley*cosA*sinB
|
||||
local y = circlex*(sinB*cosphi - sinA*cosB*sinphi) + circley*cosA*cosB
|
||||
local z = K2 + cosA*circlex*sinphi + circley*sinA
|
||||
|
||||
local ooz = 1/z
|
||||
|
||||
-- x and y projection
|
||||
local xp = math.floor(screen_width/2 + K1*ooz*x)
|
||||
local yp = math.floor(screen_height/2 + K1*ooz*y)
|
||||
|
||||
-- calculate luminance
|
||||
local L = cosphi*costheta*sinB - cosA*costheta*sinphi - sinA*sintheta + cosB*( cosA*sintheta - costheta*sinA*sinphi )
|
||||
-- if (L > 0) then
|
||||
if (true) then
|
||||
if (ooz > zbuffer[yp][xp]) then
|
||||
zbuffer[yp][xp] = ooz
|
||||
local luminance = math.max( math.ceil( L * 180 ), 0 )
|
||||
-- luminance is now in the range 0 to 255
|
||||
r = math.ceil( (luminance + xp) / 2 )
|
||||
g = math.ceil( (luminance + yp) / 2 )
|
||||
b = math.ceil( (luminance + xp + yp) / 3 )
|
||||
output[yp][xp] = { r, g, b }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
dofile('init.lua')
|
||||
|
||||
render_frame(-0.7, 0.7)
|
||||
tga_encoder.image(output):save("donut.tga")
|
||||
|
|
@ -1,181 +0,0 @@
|
|||
dofile("init.lua")
|
||||
|
||||
-- encode a bitmap
|
||||
local _ = { 0, 0, 0 }
|
||||
local R = { 255, 127, 127 }
|
||||
local pixels = {
|
||||
{ _, _, _, _, _, _, _ },
|
||||
{ _, _, _, R, _, _, _ },
|
||||
{ _, _, R, R, R, _, _ },
|
||||
{ _, R, R, R, R, R, _ },
|
||||
{ _, R, R, R, R, R, _ },
|
||||
{ _, _, R, _, R, _, _ },
|
||||
{ _, _, _, _, _, _, _ },
|
||||
}
|
||||
tga_encoder.image(pixels):save("bitmap_small.tga")
|
||||
|
||||
-- test that image can be encoded
|
||||
local bitmap_small_0 = tga_encoder.image(pixels)
|
||||
bitmap_small_0:encode()
|
||||
assert(191 == #bitmap_small_0.data)
|
||||
|
||||
-- test that imbage can be encoded with parameters
|
||||
local bitmap_small_1 = tga_encoder.image(pixels)
|
||||
bitmap_small_1:encode(
|
||||
{
|
||||
colormap = {},
|
||||
color_format = "B8G8R8",
|
||||
compression = "RAW",
|
||||
}
|
||||
)
|
||||
assert(191 == #bitmap_small_1.data)
|
||||
|
||||
-- change a single pixel, then rescale the bitmap
|
||||
local pixels_orig = pixels
|
||||
pixels_orig[4][4] = { 255, 255, 255 }
|
||||
local pixels = {}
|
||||
for x = 1,56,1 do
|
||||
local x_orig = math.ceil(x/8)
|
||||
for z = 1,56,1 do
|
||||
local z_orig = math.ceil(z/8)
|
||||
local color = pixels_orig[z_orig][x_orig]
|
||||
pixels[z] = pixels[z] or {}
|
||||
pixels[z][x] = color
|
||||
end
|
||||
end
|
||||
tga_encoder.image(pixels):save("bitmap_large.tga")
|
||||
|
||||
-- note that the uncompressed grayscale TGA file written in this
|
||||
-- example is 80 bytes – but an optimized PNG file is 81 bytes …
|
||||
local pixels = {}
|
||||
for x = 1,6,1 do -- left to right
|
||||
for z = 1,6,1 do -- bottom to top
|
||||
local color = { math.min(x * z * 4 - 1, 255) }
|
||||
pixels[z] = pixels[z] or {}
|
||||
pixels[z][x] = color
|
||||
end
|
||||
end
|
||||
tga_encoder.image(pixels):save("gradient_8bpp_raw.tga", {color_format="Y8", compression="RAW"})
|
||||
|
||||
local pixels = {}
|
||||
for x = 1,16,1 do -- left to right
|
||||
for z = 1,16,1 do -- bottom to top
|
||||
local r = math.min(x * 32 - 1, 255)
|
||||
local g = math.min(z * 32 - 1, 255)
|
||||
local b = 0
|
||||
-- blue rectangle in top right corner
|
||||
if x > 8 and z > 8 then
|
||||
r = 0
|
||||
g = 0
|
||||
b = math.min(z * 16 - 1, 255)
|
||||
end
|
||||
local color = { r, g, b }
|
||||
pixels[z] = pixels[z] or {}
|
||||
pixels[z][x] = color
|
||||
end
|
||||
end
|
||||
local gradients = tga_encoder.image(pixels)
|
||||
gradients:save("gradients_8bpp_raw.tga", {color_format="Y8", compression="RAW"})
|
||||
gradients:save("gradients_16bpp_raw.tga", {color_format="A1R5G5B5", compression="RAW"})
|
||||
gradients:save("gradients_16bpp_rle.tga", {color_format="A1R5G5B5", compression="RLE"})
|
||||
gradients:save("gradients_24bpp_raw.tga", {color_format="B8G8R8", compression="RAW"})
|
||||
gradients:save("gradients_24bpp_rle.tga", {color_format="B8G8R8", compression="RLE"})
|
||||
|
||||
for x = 1,16,1 do -- left to right
|
||||
for z = 1,16,1 do -- bottom to top
|
||||
local color = pixels[z][x]
|
||||
color[#color+1] = ((x * x) + (z * z)) % 256
|
||||
pixels[z][x] = color
|
||||
end
|
||||
end
|
||||
gradients:save("gradients_32bpp_raw.tga", {color_format="B8G8R8A8", compression="RAW"})
|
||||
-- the RLE-compressed file is larger than just dumping pixels because
|
||||
-- the gradients in this picture can not be compressed well using RLE
|
||||
gradients:save("gradients_32bpp_rle.tga", {color_format="B8G8R8A8", compression="RLE"})
|
||||
|
||||
local pixels = {}
|
||||
for x = 1,512,1 do -- left to right
|
||||
for z = 1,512,1 do -- bottom to top
|
||||
local oz = (z - 256) / 256 + 0.75
|
||||
local ox = (x - 256) / 256
|
||||
local px, pz, i = 0, 0, 0
|
||||
while (px * px) + (pz * pz) <= 4 and i < 128 do
|
||||
px = (px * px) - (pz * pz) + oz
|
||||
pz = (2 * px * pz) + ox
|
||||
i = i + 1
|
||||
end
|
||||
local color = {
|
||||
math.max(0, math.min(255, math.floor(px * 64))),
|
||||
math.max(0, math.min(255, math.floor(pz * 64))),
|
||||
math.max(0, math.min(255, math.floor(i))),
|
||||
}
|
||||
pixels[z] = pixels[z] or {}
|
||||
pixels[z][x] = color
|
||||
end
|
||||
end
|
||||
tga_encoder.image(pixels):save("fractal_8bpp.tga", {color_format="Y8"})
|
||||
tga_encoder.image(pixels):save("fractal_16bpp.tga", {color_format="A1R5G5B5"})
|
||||
tga_encoder.image(pixels):save("fractal_24bpp.tga", {color_format="B8G8R8"})
|
||||
|
||||
-- encode a colormapped bitmap
|
||||
local K = { 0 }
|
||||
local B = { 1 }
|
||||
local R = { 2 }
|
||||
local G = { 3 }
|
||||
local W = { 4 }
|
||||
local colormap = {
|
||||
{ 1, 2, 3 }, -- K
|
||||
{ 0, 0, 255 }, -- B
|
||||
{ 255, 0, 0 }, -- R
|
||||
{ 0, 255, 0 }, -- G
|
||||
{ 253, 254, 255 }, -- W
|
||||
}
|
||||
local pixels = {
|
||||
{ W, K, W, K, W, K, W },
|
||||
{ R, G, B, R, G, B, K },
|
||||
{ K, W, K, W, K, W, K },
|
||||
{ G, B, R, G, B, R, W },
|
||||
{ W, W, W, K, K, K, W },
|
||||
{ B, R, G, B, R, G, K },
|
||||
{ B, R, G, B, R, G, W },
|
||||
}
|
||||
-- note that the uncompressed colormapped TGA file written in this
|
||||
-- example is 108 bytes – but an optimized PNG file is 121 bytes …
|
||||
tga_encoder.image(pixels):save("colormapped_B8G8R8.tga", {colormap=colormap})
|
||||
-- encoding as A1R5G5B5 saves 1 byte per palette entry → 103 bytes
|
||||
tga_encoder.image(pixels):save("colormapped_A1R5G5B5.tga", {colormap=colormap, color_format="A1R5G5B5"})
|
||||
|
||||
-- encode a colormapped bitmap with transparency
|
||||
local _ = { 0 }
|
||||
local K = { 1 }
|
||||
local W = { 2 }
|
||||
local colormap = {
|
||||
{ 0, 0, 0, 0 },
|
||||
{ 0, 0, 0, 255 },
|
||||
{ 255, 255, 255, 255 },
|
||||
}
|
||||
local pixels = {
|
||||
{ _, K, K, K, K, K, _ },
|
||||
{ _, K, W, W, W, K, _ },
|
||||
{ K, K, W, W, W, K, K },
|
||||
{ K, W, W, W, W, W, K },
|
||||
{ _, K, W, W, W, K, _ },
|
||||
{ _, _, K, W, K, _, _ },
|
||||
{ _, _, _, K, _, _, _ },
|
||||
}
|
||||
tga_encoder.image(pixels):save("colormapped_B8G8R8A8.tga", {colormap=colormap})
|
||||
|
||||
-- encoding a colormapped image with illegal colormap indexes should error out
|
||||
local colormap = {
|
||||
{ 0, 0, 0, 0 },
|
||||
{ 0, 0, 0, 255 },
|
||||
}
|
||||
local status, message = pcall(
|
||||
function ()
|
||||
tga_encoder.image(pixels):encode({colormap=colormap})
|
||||
end
|
||||
)
|
||||
assert(
|
||||
false == status and
|
||||
"init.lua:36: colormap index 2 not in colormap of size 2" == message
|
||||
)
|
||||
|
|
@ -9,566 +9,60 @@ local image = setmetatable({}, {
|
|||
})
|
||||
|
||||
function image:constructor(pixels)
|
||||
self.data = ""
|
||||
self.pixels = pixels
|
||||
self.width = #pixels[1]
|
||||
self.height = #pixels
|
||||
|
||||
self:encode()
|
||||
end
|
||||
|
||||
local pixel_depth_by_color_format = {
|
||||
["Y8"] = 8,
|
||||
["A1R5G5B5"] = 16,
|
||||
["B8G8R8"] = 24,
|
||||
["B8G8R8A8"] = 32,
|
||||
}
|
||||
|
||||
function image:encode_colormap_spec(properties)
|
||||
local colormap = properties.colormap
|
||||
local colormap_pixel_depth = 0
|
||||
if 0 ~= #colormap then
|
||||
colormap_pixel_depth = pixel_depth_by_color_format[
|
||||
properties.color_format
|
||||
]
|
||||
-- ensure that each pixel references a legal colormap entry
|
||||
for _, row in ipairs(self.pixels) do
|
||||
for _, pixel in ipairs(row) do
|
||||
local colormap_index = pixel[1]
|
||||
if colormap_index >= #colormap then
|
||||
error(
|
||||
"colormap index " .. colormap_index ..
|
||||
" not in colormap of size " .. #colormap
|
||||
)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
local colormap_spec =
|
||||
string.char(0, 0) .. -- first entry index
|
||||
string.char(#colormap % 256, math.floor(#colormap / 256)) .. -- number of entries
|
||||
string.char(colormap_pixel_depth) -- bits per pixel
|
||||
self.data = self.data .. colormap_spec
|
||||
function image:encode_colormap_spec()
|
||||
self.data = self.data
|
||||
.. string.char(0, 0) -- first entry index
|
||||
.. string.char(0, 0) -- number of entries
|
||||
.. string.char(0) -- bits per pixel
|
||||
end
|
||||
|
||||
function image:encode_image_spec(properties)
|
||||
local color_format = properties.color_format
|
||||
assert(
|
||||
"Y8" == color_format or -- (8 bit grayscale = 1 byte = 8 bits)
|
||||
"A1R5G5B5" == color_format or -- (A1R5G5B5 = 2 bytes = 16 bits)
|
||||
"B8G8R8" == color_format or -- (B8G8R8 = 3 bytes = 24 bits)
|
||||
"B8G8R8A8" == color_format -- (B8G8R8A8 = 4 bytes = 32 bits)
|
||||
)
|
||||
local scanline_order = properties.scanline_order
|
||||
assert (
|
||||
"bottom-top" == scanline_order or
|
||||
"top-bottom" == scanline_order
|
||||
)
|
||||
local pixel_depth
|
||||
if 0 ~= #properties.colormap then
|
||||
pixel_depth = self.pixel_depth
|
||||
else
|
||||
pixel_depth = pixel_depth_by_color_format[color_format]
|
||||
end
|
||||
assert( nil ~= pixel_depth)
|
||||
-- the origin is the bottom left corner of the image (always)
|
||||
local x_origin_lo = 0
|
||||
local x_origin_hi = 0
|
||||
local y_origin_lo = 0
|
||||
local y_origin_hi = 0
|
||||
local image_descriptor = 0 -- equal to bottom-top scanline order
|
||||
local width_lo = self.width % 256
|
||||
local width_hi = math.floor(self.width / 256)
|
||||
local height_lo = self.height % 256
|
||||
local height_hi = math.floor(self.height / 256)
|
||||
if "top-bottom" == scanline_order then
|
||||
image_descriptor = 32
|
||||
y_origin_lo = height_lo
|
||||
y_origin_hi = height_hi
|
||||
end
|
||||
self.data = self.data .. string.char (
|
||||
x_origin_lo, x_origin_hi,
|
||||
y_origin_lo, y_origin_hi,
|
||||
width_lo, width_hi,
|
||||
height_lo, height_hi,
|
||||
pixel_depth,
|
||||
image_descriptor
|
||||
)
|
||||
function image:encode_image_spec()
|
||||
self.data = self.data
|
||||
.. string.char(0, 0) -- X-origin
|
||||
.. string.char(0, 0) -- Y-origin
|
||||
.. string.char(self.width % 256, math.floor(self.width / 256)) -- width
|
||||
.. string.char(self.height % 256, math.floor(self.height / 256)) -- height
|
||||
.. string.char(24) -- pixel depth (RGB = 3 bytes = 24 bits)
|
||||
.. string.char(0) -- image descriptor
|
||||
end
|
||||
|
||||
function image:encode_colormap(properties)
|
||||
local colormap = properties.colormap
|
||||
if 0 == #colormap then
|
||||
return
|
||||
end
|
||||
local color_format = properties.color_format
|
||||
assert (
|
||||
"A1R5G5B5" == color_format or
|
||||
"B8G8R8" == color_format or
|
||||
"B8G8R8A8" == color_format
|
||||
)
|
||||
local colors = {}
|
||||
if "A1R5G5B5" == color_format then
|
||||
-- Sample depth rescaling is done according to the algorithm presented in:
|
||||
-- <https://www.w3.org/TR/2003/REC-PNG-20031110/#13Sample-depth-rescaling>
|
||||
local max_sample_in = math.pow(2, 8) - 1
|
||||
local max_sample_out = math.pow(2, 5) - 1
|
||||
for i = 1,#colormap,1 do
|
||||
local color = colormap[i]
|
||||
local colorword = 32768 +
|
||||
((math.floor((color[1] * max_sample_out / max_sample_in) + 0.5)) * 1024) +
|
||||
((math.floor((color[2] * max_sample_out / max_sample_in) + 0.5)) * 32) +
|
||||
((math.floor((color[3] * max_sample_out / max_sample_in) + 0.5)) * 1)
|
||||
local color_bytes = string.char(
|
||||
colorword % 256,
|
||||
math.floor(colorword / 256)
|
||||
)
|
||||
colors[#colors + 1] = color_bytes
|
||||
end
|
||||
elseif "B8G8R8" == color_format then
|
||||
for i = 1,#colormap,1 do
|
||||
local color = colormap[i]
|
||||
local color_bytes = string.char(
|
||||
color[3], -- B
|
||||
color[2], -- G
|
||||
color[1] -- R
|
||||
)
|
||||
colors[#colors + 1] = color_bytes
|
||||
end
|
||||
elseif "B8G8R8A8" == color_format then
|
||||
for i = 1,#colormap,1 do
|
||||
local color = colormap[i]
|
||||
local color_bytes = string.char(
|
||||
color[3], -- B
|
||||
color[2], -- G
|
||||
color[1], -- R
|
||||
color[4] -- A
|
||||
)
|
||||
colors[#colors + 1] = color_bytes
|
||||
end
|
||||
end
|
||||
assert( 0 ~= #colors )
|
||||
self.data = self.data .. table.concat(colors)
|
||||
end
|
||||
|
||||
function image:encode_header(properties)
|
||||
local color_format = properties.color_format
|
||||
local colormap = properties.colormap
|
||||
local compression = properties.compression
|
||||
local colormap_type
|
||||
local image_type
|
||||
if "Y8" == color_format and "RAW" == compression then
|
||||
colormap_type = 0
|
||||
image_type = 3 -- grayscale
|
||||
elseif (
|
||||
"A1R5G5B5" == color_format or
|
||||
"B8G8R8" == color_format or
|
||||
"B8G8R8A8" == color_format
|
||||
) then
|
||||
if "RAW" == compression then
|
||||
if 0 ~= #colormap then
|
||||
colormap_type = 1
|
||||
image_type = 1 -- colormapped RGB(A)
|
||||
else
|
||||
colormap_type = 0
|
||||
image_type = 2 -- RAW RGB(A)
|
||||
end
|
||||
elseif "RLE" == compression then
|
||||
colormap_type = 0
|
||||
image_type = 10 -- RLE RGB
|
||||
end
|
||||
end
|
||||
assert( nil ~= colormap_type )
|
||||
assert( nil ~= image_type )
|
||||
function image:encode_header()
|
||||
self.data = self.data
|
||||
.. string.char(0) -- image id
|
||||
.. string.char(colormap_type)
|
||||
.. string.char(image_type)
|
||||
self:encode_colormap_spec(properties) -- color map specification
|
||||
self:encode_image_spec(properties) -- image specification
|
||||
self:encode_colormap(properties)
|
||||
.. string.char(0) -- color map type
|
||||
.. string.char(10) -- image type (RLE RGB = 10)
|
||||
self:encode_colormap_spec() -- color map specification
|
||||
self:encode_image_spec() -- image specification
|
||||
end
|
||||
|
||||
function image:encode_data(properties)
|
||||
local color_format = properties.color_format
|
||||
local colormap = properties.colormap
|
||||
local compression = properties.compression
|
||||
|
||||
local data_length_before = #self.data
|
||||
if "Y8" == color_format and "RAW" == compression then
|
||||
if 8 == self.pixel_depth then
|
||||
self:encode_data_Y8_as_Y8_raw()
|
||||
elseif 24 == self.pixel_depth then
|
||||
self:encode_data_R8G8B8_as_Y8_raw()
|
||||
end
|
||||
elseif "A1R5G5B5" == color_format then
|
||||
if 0 ~= #colormap then
|
||||
if "RAW" == compression then
|
||||
if 8 == self.pixel_depth then
|
||||
self:encode_data_Y8_as_Y8_raw()
|
||||
end
|
||||
end
|
||||
else
|
||||
if "RAW" == compression then
|
||||
self:encode_data_R8G8B8_as_A1R5G5B5_raw()
|
||||
elseif "RLE" == compression then
|
||||
self:encode_data_R8G8B8_as_A1R5G5B5_rle()
|
||||
end
|
||||
end
|
||||
elseif "B8G8R8" == color_format then
|
||||
if 0 ~= #colormap then
|
||||
if "RAW" == compression then
|
||||
if 8 == self.pixel_depth then
|
||||
self:encode_data_Y8_as_Y8_raw()
|
||||
end
|
||||
end
|
||||
else
|
||||
if "RAW" == compression then
|
||||
self:encode_data_R8G8B8_as_B8G8R8_raw()
|
||||
elseif "RLE" == compression then
|
||||
self:encode_data_R8G8B8_as_B8G8R8_rle()
|
||||
end
|
||||
end
|
||||
elseif "B8G8R8A8" == color_format then
|
||||
if 0 ~= #colormap then
|
||||
if "RAW" == compression then
|
||||
if 8 == self.pixel_depth then
|
||||
self:encode_data_Y8_as_Y8_raw()
|
||||
end
|
||||
end
|
||||
else
|
||||
if "RAW" == compression then
|
||||
self:encode_data_R8G8B8A8_as_B8G8R8A8_raw()
|
||||
elseif "RLE" == compression then
|
||||
self:encode_data_R8G8B8A8_as_B8G8R8A8_rle()
|
||||
end
|
||||
end
|
||||
end
|
||||
local data_length_after = #self.data
|
||||
assert(
|
||||
data_length_after ~= data_length_before,
|
||||
"No data encoded for color format: " .. color_format
|
||||
)
|
||||
end
|
||||
|
||||
function image:encode_data_Y8_as_Y8_raw()
|
||||
assert(8 == self.pixel_depth)
|
||||
local raw_pixels = {}
|
||||
for _, row in ipairs(self.pixels) do
|
||||
for _, pixel in ipairs(row) do
|
||||
local raw_pixel = string.char(pixel[1])
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
end
|
||||
end
|
||||
self.data = self.data .. table.concat(raw_pixels)
|
||||
end
|
||||
|
||||
function image:encode_data_R8G8B8_as_Y8_raw()
|
||||
assert(24 == self.pixel_depth)
|
||||
local raw_pixels = {}
|
||||
for _, row in ipairs(self.pixels) do
|
||||
for _, pixel in ipairs(row) do
|
||||
-- the HSP RGB to brightness formula is
|
||||
-- sqrt( 0.299 r² + .587 g² + .114 b² )
|
||||
-- see <https://alienryderflex.com/hsp.html>
|
||||
local gray = math.floor(
|
||||
math.sqrt(
|
||||
0.299 * pixel[1]^2 +
|
||||
0.587 * pixel[2]^2 +
|
||||
0.114 * pixel[3]^2
|
||||
) + 0.5
|
||||
)
|
||||
local raw_pixel = string.char(gray)
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
end
|
||||
end
|
||||
self.data = self.data .. table.concat(raw_pixels)
|
||||
end
|
||||
|
||||
function image:encode_data_R8G8B8_as_A1R5G5B5_raw()
|
||||
assert(24 == self.pixel_depth)
|
||||
local raw_pixels = {}
|
||||
-- Sample depth rescaling is done according to the algorithm presented in:
|
||||
-- <https://www.w3.org/TR/2003/REC-PNG-20031110/#13Sample-depth-rescaling>
|
||||
local max_sample_in = math.pow(2, 8) - 1
|
||||
local max_sample_out = math.pow(2, 5) - 1
|
||||
for _, row in ipairs(self.pixels) do
|
||||
for _, pixel in ipairs(row) do
|
||||
local colorword = 32768 +
|
||||
((math.floor((pixel[1] * max_sample_out / max_sample_in) + 0.5)) * 1024) +
|
||||
((math.floor((pixel[2] * max_sample_out / max_sample_in) + 0.5)) * 32) +
|
||||
((math.floor((pixel[3] * max_sample_out / max_sample_in) + 0.5)) * 1)
|
||||
local raw_pixel = string.char(colorword % 256, math.floor(colorword / 256))
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
end
|
||||
end
|
||||
self.data = self.data .. table.concat(raw_pixels)
|
||||
end
|
||||
|
||||
function image:encode_data_R8G8B8_as_A1R5G5B5_rle()
|
||||
assert(24 == self.pixel_depth)
|
||||
local colorword = nil
|
||||
local previous_r = nil
|
||||
local previous_g = nil
|
||||
local previous_b = nil
|
||||
local raw_pixel = ''
|
||||
local raw_pixels = {}
|
||||
function image:encode_data()
|
||||
local current_pixel = ''
|
||||
local previous_pixel = ''
|
||||
local count = 1
|
||||
local packets = {}
|
||||
local raw_packet = ''
|
||||
local rle_packet = ''
|
||||
-- Sample depth rescaling is done according to the algorithm presented in:
|
||||
-- <https://www.w3.org/TR/2003/REC-PNG-20031110/#13Sample-depth-rescaling>
|
||||
local max_sample_in = math.pow(2, 8) - 1
|
||||
local max_sample_out = math.pow(2, 5) - 1
|
||||
for _, row in ipairs(self.pixels) do
|
||||
for _, pixel in ipairs(row) do
|
||||
if pixel[1] ~= previous_r or pixel[2] ~= previous_g or pixel[3] ~= previous_b or count == 128 then
|
||||
if nil ~= previous_r then
|
||||
colorword = 32768 +
|
||||
((math.floor((previous_r * max_sample_out / max_sample_in) + 0.5)) * 1024) +
|
||||
((math.floor((previous_g * max_sample_out / max_sample_in) + 0.5)) * 32) +
|
||||
((math.floor((previous_b * max_sample_out / max_sample_in) + 0.5)) * 1)
|
||||
if 1 == count then
|
||||
-- remember pixel verbatim for raw encoding
|
||||
raw_pixel = string.char(colorword % 256, math.floor(colorword / 256))
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
if 128 == #raw_pixels then
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
end
|
||||
else
|
||||
-- encode raw pixels, if any
|
||||
if #raw_pixels > 0 then
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
end
|
||||
-- RLE encoding
|
||||
rle_packet = string.char(128 + count - 1, colorword % 256, math.floor(colorword / 256))
|
||||
packets[#packets +1] = rle_packet
|
||||
end
|
||||
end
|
||||
count = 1
|
||||
previous_r = pixel[1]
|
||||
previous_g = pixel[2]
|
||||
previous_b = pixel[3]
|
||||
else
|
||||
count = count + 1
|
||||
end
|
||||
end
|
||||
end
|
||||
colorword = 32768 +
|
||||
((math.floor((previous_r * max_sample_out / max_sample_in) + 0.5)) * 1024) +
|
||||
((math.floor((previous_g * max_sample_out / max_sample_in) + 0.5)) * 32) +
|
||||
((math.floor((previous_b * max_sample_out / max_sample_in) + 0.5)) * 1)
|
||||
if 1 == count then
|
||||
raw_pixel = string.char(colorword % 256, math.floor(colorword / 256))
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
else
|
||||
-- encode raw pixels, if any
|
||||
if #raw_pixels > 0 then
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
end
|
||||
-- RLE encoding
|
||||
rle_packet = string.char(128 + count - 1, colorword % 256, math.floor(colorword / 256))
|
||||
packets[#packets +1] = rle_packet
|
||||
end
|
||||
self.data = self.data .. table.concat(packets)
|
||||
end
|
||||
|
||||
function image:encode_data_R8G8B8_as_B8G8R8_raw()
|
||||
assert(24 == self.pixel_depth)
|
||||
local raw_pixels = {}
|
||||
for _, row in ipairs(self.pixels) do
|
||||
for _, pixel in ipairs(row) do
|
||||
local raw_pixel = string.char(pixel[3], pixel[2], pixel[1])
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
end
|
||||
end
|
||||
self.data = self.data .. table.concat(raw_pixels)
|
||||
end
|
||||
|
||||
function image:encode_data_R8G8B8_as_B8G8R8_rle()
|
||||
assert(24 == self.pixel_depth)
|
||||
local previous_r = nil
|
||||
local previous_g = nil
|
||||
local previous_b = nil
|
||||
local raw_pixel = ''
|
||||
local raw_pixels = {}
|
||||
local count = 1
|
||||
local packets = {}
|
||||
local raw_packet = ''
|
||||
local rle_packet = ''
|
||||
for _, row in ipairs(self.pixels) do
|
||||
for _, pixel in ipairs(row) do
|
||||
if pixel[1] ~= previous_r or pixel[2] ~= previous_g or pixel[3] ~= previous_b or count == 128 then
|
||||
if nil ~= previous_r then
|
||||
if 1 == count then
|
||||
-- remember pixel verbatim for raw encoding
|
||||
raw_pixel = string.char(previous_b, previous_g, previous_r)
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
if 128 == #raw_pixels then
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
end
|
||||
else
|
||||
-- encode raw pixels, if any
|
||||
if #raw_pixels > 0 then
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
end
|
||||
-- RLE encoding
|
||||
rle_packet = string.char(128 + count - 1, previous_b, previous_g, previous_r)
|
||||
packets[#packets +1] = rle_packet
|
||||
end
|
||||
end
|
||||
current_pixel = string.char(pixel[3], pixel[2], pixel[1])
|
||||
if current_pixel ~= previous_pixel or count == 128 then
|
||||
packets[#packets +1] = rle_packet
|
||||
count = 1
|
||||
previous_r = pixel[1]
|
||||
previous_g = pixel[2]
|
||||
previous_b = pixel[3]
|
||||
previous_pixel = current_pixel
|
||||
else
|
||||
count = count + 1
|
||||
end
|
||||
rle_packet = string.char(128 + count - 1) .. current_pixel
|
||||
end
|
||||
end
|
||||
if 1 == count then
|
||||
raw_pixel = string.char(previous_b, previous_g, previous_r)
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
else
|
||||
-- encode raw pixels, if any
|
||||
if #raw_pixels > 0 then
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
end
|
||||
-- RLE encoding
|
||||
rle_packet = string.char(128 + count - 1, previous_b, previous_g, previous_r)
|
||||
packets[#packets +1] = rle_packet
|
||||
end
|
||||
self.data = self.data .. table.concat(packets)
|
||||
end
|
||||
|
||||
function image:encode_data_R8G8B8A8_as_B8G8R8A8_raw()
|
||||
assert(32 == self.pixel_depth)
|
||||
local raw_pixels = {}
|
||||
for _, row in ipairs(self.pixels) do
|
||||
for _, pixel in ipairs(row) do
|
||||
local raw_pixel = string.char(pixel[3], pixel[2], pixel[1], pixel[4])
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
end
|
||||
end
|
||||
self.data = self.data .. table.concat(raw_pixels)
|
||||
end
|
||||
|
||||
function image:encode_data_R8G8B8A8_as_B8G8R8A8_rle()
|
||||
assert(32 == self.pixel_depth)
|
||||
local previous_r = nil
|
||||
local previous_g = nil
|
||||
local previous_b = nil
|
||||
local previous_a = nil
|
||||
local raw_pixel = ''
|
||||
local raw_pixels = {}
|
||||
local count = 1
|
||||
local packets = {}
|
||||
local raw_packet = ''
|
||||
local rle_packet = ''
|
||||
for _, row in ipairs(self.pixels) do
|
||||
for _, pixel in ipairs(row) do
|
||||
if pixel[1] ~= previous_r or pixel[2] ~= previous_g or pixel[3] ~= previous_b or pixel[4] ~= previous_a or count == 128 then
|
||||
if nil ~= previous_r then
|
||||
if 1 == count then
|
||||
-- remember pixel verbatim for raw encoding
|
||||
raw_pixel = string.char(previous_b, previous_g, previous_r, previous_a)
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
if 128 == #raw_pixels then
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
end
|
||||
else
|
||||
-- encode raw pixels, if any
|
||||
if #raw_pixels > 0 then
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
end
|
||||
-- RLE encoding
|
||||
rle_packet = string.char(128 + count - 1, previous_b, previous_g, previous_r, previous_a)
|
||||
packets[#packets +1] = rle_packet
|
||||
end
|
||||
end
|
||||
count = 1
|
||||
previous_r = pixel[1]
|
||||
previous_g = pixel[2]
|
||||
previous_b = pixel[3]
|
||||
previous_a = pixel[4]
|
||||
else
|
||||
count = count + 1
|
||||
end
|
||||
end
|
||||
end
|
||||
if 1 == count then
|
||||
raw_pixel = string.char(previous_b, previous_g, previous_r, previous_a)
|
||||
raw_pixels[#raw_pixels + 1] = raw_pixel
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
else
|
||||
-- encode raw pixels, if any
|
||||
if #raw_pixels > 0 then
|
||||
raw_packet = string.char(#raw_pixels - 1)
|
||||
packets[#packets + 1] = raw_packet
|
||||
for i=1, #raw_pixels do
|
||||
packets[#packets +1] = raw_pixels[i]
|
||||
end
|
||||
raw_pixels = {}
|
||||
end
|
||||
-- RLE encoding
|
||||
rle_packet = string.char(128 + count - 1, previous_b, previous_g, previous_r, previous_a)
|
||||
packets[#packets +1] = rle_packet
|
||||
end
|
||||
packets[#packets +1] = rle_packet
|
||||
self.data = self.data .. table.concat(packets)
|
||||
end
|
||||
|
||||
|
|
@ -581,45 +75,15 @@ function image:encode_footer()
|
|||
.. string.char(0)
|
||||
end
|
||||
|
||||
function image:encode(properties)
|
||||
local properties = properties or {}
|
||||
properties.colormap = properties.colormap or {}
|
||||
properties.compression = properties.compression or "RAW"
|
||||
properties.scanline_order = properties.scanline_order or "bottom-top"
|
||||
|
||||
self.pixel_depth = #self.pixels[1][1] * 8
|
||||
|
||||
local color_format_defaults_by_pixel_depth = {
|
||||
[8] = "Y8",
|
||||
[24] = "B8G8R8",
|
||||
[32] = "B8G8R8A8",
|
||||
}
|
||||
if nil == properties.color_format then
|
||||
if 0 ~= #properties.colormap then
|
||||
properties.color_format =
|
||||
color_format_defaults_by_pixel_depth[
|
||||
#properties.colormap[1] * 8
|
||||
]
|
||||
else
|
||||
properties.color_format =
|
||||
color_format_defaults_by_pixel_depth[
|
||||
self.pixel_depth
|
||||
]
|
||||
end
|
||||
end
|
||||
assert( nil ~= properties.color_format )
|
||||
|
||||
self.data = ""
|
||||
self:encode_header(properties) -- header
|
||||
function image:encode()
|
||||
self:encode_header() -- header
|
||||
-- no color map and image id data
|
||||
self:encode_data(properties) -- encode data
|
||||
self:encode_data() -- encode data
|
||||
-- no extension or developer area
|
||||
self:encode_footer() -- footer
|
||||
end
|
||||
|
||||
function image:save(filename, properties)
|
||||
self:encode(properties)
|
||||
|
||||
function image:save(filename)
|
||||
local f = assert(io.open(filename, "wb"))
|
||||
f:write(self.data)
|
||||
f:close()
|
||||
|
|
|
|||
|
|
@ -1,51 +0,0 @@
|
|||
dofile("init.lua")
|
||||
|
||||
local colormap = {
|
||||
{ 0, 0, 0 }, -- black
|
||||
{ 255, 255, 255 }, -- white
|
||||
{ 255, 0, 0 }, -- red
|
||||
{ 0, 255, 0 }, -- green
|
||||
{ 0, 0, 255 }, -- blue
|
||||
}
|
||||
|
||||
local _ = { 0 }
|
||||
local W = { 1 }
|
||||
local R = { 2 }
|
||||
local G = { 3 }
|
||||
local B = { 4 }
|
||||
|
||||
local pixels_tiny = {
|
||||
{ W, W, W, W, W, W, W, W, W, W, W, W, },
|
||||
{ W, _, _, _, _, _, _, _, _, _, _, W, },
|
||||
{ W, _, _, _, _, _, _, B, _, B, _, W, },
|
||||
{ W, _, _, _, _, _, _, B, B, B, _, W, },
|
||||
{ W, _, _, _, G, G, G, B, _, B, _, W, },
|
||||
{ W, _, _, _, G, _, G, B, B, B, _, W, },
|
||||
{ W, _, _, R, G, _, _, _, _, _, _, W, },
|
||||
{ W, _, _, R, G, G, G, _, _, _, _, W, },
|
||||
{ W, _, _, R, _, _, _, _, _, _, _, W, },
|
||||
{ W, _, R, R, R, _, _, _, _, _, _, W, },
|
||||
{ W, _, _, _, _, _, _, _, _, _, _, W, },
|
||||
{ W, W, W, W, W, W, W, W, W, W, W, W, },
|
||||
}
|
||||
|
||||
local pixels_huge = {}
|
||||
|
||||
local size_tiny = #pixels_tiny
|
||||
local size_huge = 1200
|
||||
local scale = size_huge / size_tiny
|
||||
|
||||
for x_huge = 1,size_huge,1 do
|
||||
local x_tiny = math.ceil( x_huge / scale )
|
||||
for z_huge = 1,size_huge,1 do
|
||||
local z_tiny = math.ceil( z_huge / scale )
|
||||
if nil == pixels_huge[z_huge] then
|
||||
pixels_huge[z_huge] = {}
|
||||
end
|
||||
pixels_huge[z_huge][x_huge] = pixels_tiny[z_tiny][x_tiny]
|
||||
end
|
||||
end
|
||||
|
||||
tga_encoder.image(pixels_tiny):save("logo_tiny.tga", {colormap=colormap})
|
||||
tga_encoder.image(pixels_huge):save("logo_huge.tga", {colormap=colormap})
|
||||
|
||||
|
|
@ -1,2 +1,3 @@
|
|||
name = tga_encoder
|
||||
author = Fleckenstein
|
||||
description = A TGA Encoder written in Lua without the use of external Libraries.
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue