ninnghazad · ninnghazad · Mar 15, 2025 · Mar 15, 2025 · Mar 19, 2025 · Mar 16, 2025
diff --git a/.clang-tidy b/.clang-tidy
@@ -0,0 +1,5 @@
+Checks: '-*,modernize-use-emplace,modernize-avoid-bind,misc-throw-by-value-catch-by-reference,misc-unconventional-assign-operator,performance-*,-performance-avoid-endl,performance-inefficient-string-concatenation'
+WarningsAsErrors: '-*,modernize-use-emplace,performance-type-promotion-in-math-fn,performance-faster-string-find,performance-implicit-cast-in-loop'
+CheckOptions:
+  - key: performance-unnecessary-value-param.AllowedTypes
+    value: v[23]f;v[23][su](16|32)
diff --git a/.dockerignore b/.dockerignore
@@ -0,0 +1,4 @@
+./cmake-build-*
+./build/*
+./cache/*
+Dockerfile
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,16 @@
+[*]
+end_of_line = lf
+
+[*.{cpp,h,lua,txt,glsl,c,cmake,java,gradle}]
+charset = utf-8
+indent_size = 4
+indent_style = tab
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+charset = utf-8
+indent_size = 4
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
diff --git a/.gitattributes b/.gitattributes
@@ -1,2 +1,8 @@
+# Forces all files which git considers text files to use LF line endings
+* text=auto eol=lf
+
 *.cpp diff=cpp
 *.h diff=cpp
+
+*.gltf binary
+*.x binary
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -0,0 +1,172 @@
+# Contributing
+
+Contributions are welcome! Here's how you can help:
+
+- [Contributing code](#code)
+- [Reporting issues](#issues)
+- [Requesting features](#feature-requests)
+- [Translating](#translations)
+- [Donating](#donations)
+
+## Code
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) the repository and
+   [clone](https://help.github.com/articles/cloning-a-repository/) your fork.
+
+2. Before you start coding, consider opening an
+   [issue on Github](https://github.com/luanti-org/luanti/issues) to discuss the
+   suitability and implementation of your intended contribution with the core
+   developers.
+
+   Any Pull Request that isn't a bug fix and isn't covered by
+   [the roadmap](../doc/direction.md) will be closed within a month unless it
+   receives a concept approval from a Core Developer. For this reason, it is
+   recommended that you open an issue for any such pull requests before doing
+   the work, to avoid disappointment.
+
+   You may also benefit from discussing on our IRC development channel
+   [#luanti-dev](http://www.luanti.org/irc/). Note that a proper IRC client
+   is required to speak on this channel.
+
+3. Start coding!
+    - Refer to the
+      [Lua API](https://github.com/luanti-org/luanti/blob/master/doc/lua_api.md),
+      [Developer Wiki](https://dev.luanti.org/) and other
+      [documentation](https://github.com/luanti-org/luanti/tree/master/doc).
+    - Follow the [C/C++](https://dev.luanti.org/Code_style_guidelines) and
+      [Lua](https://dev.luanti.org/Lua_code_style_guidelines) code style guidelines.
+    - Check your code works as expected and document any changes to the Lua API.
+    - To avoid conflicting changes between contributions, do not do the following manually. They will be done before each release.
+      - Run `updatepo.sh` or update `luanti.po{,t}` even if your code adds new translatable strings.
+      - Update `minetest.conf.example` and `settings_translation_file.cpp` even if your code adds new core settings.
+
+4. Commit & [push](https://help.github.com/articles/pushing-to-a-remote/) your changes to a new branch (not `master`, one change per branch)
+    - Commit messages should:
+        - Use the present tense.
+        - Be descriptive. See the commit messages by core developers for examples.
+    - The first line should:
+        - Start with a capital letter.
+        - Be a compact summary of the commit.
+        - Preferably have less than 70 characters.
+        - Have no full stop at the end.
+    - The second line should be empty.
+    - The following lines should describe the commit, starting a new line for each point.
+
+5. Once you are happy with your changes, submit a pull request.
+     - Open the [pull-request form](https://github.com/luanti-org/luanti/pull/new/master).
+     - Add a description explaining what you've done (or if it's a
+       work-in-progress - what you need to do).
+     - Make sure to fill out the pull request template.
+
+### A pull-request is considered merge-able when:
+
+1. It follows [the roadmap](../doc/direction.md) in some way and fits the whole
+   picture of the project.
+2. It works.
+3. It follows the code style for
+   [C/C++](https://dev.luanti.org/Code_style_guidelines) or
+   [Lua](https://dev.luanti.org/Lua_code_style_guidelines).
+4. The code's interfaces are well designed, regardless of other aspects that
+   might need more work in the future.
+5. It uses protocols and formats which include the required compatibility.
+
+## Issues
+
+If you experience an issue, we would like to know the details - especially when
+a stable release is on the way.
+
+1. Do a quick search on GitHub to check if the issue has already been reported.
+2. Is it an issue with the Luanti *engine*? If not, report it
+   [elsewhere](http://www.luanti.org/development/#reporting-issues).
+3. [Open an issue](https://github.com/luanti-org/luanti/issues/new) and describe
+   the issue you are having - you could include:
+     - Error logs (check the bottom of the `debug.txt` file).
+     - Screenshots.
+     - Ways you have tried to solve the issue, and whether they worked or not.
+     - Your Luanti version and the content (games, mods or texture packs) you have installed.
+     - Your platform (e.g. Windows 10 or Ubuntu 15.04 x64).
+
+After reporting you should aim to answer questions or clarifications as this
+helps pinpoint the cause of the issue (if you don't do this your issue may be
+closed after 1 month).
+
+## Feature requests
+
+Feature requests are welcome but take a moment to see if your idea follows
+[the roadmap](../doc/direction.md) in some way and fits the whole picture of
+the project. You should provide a clear explanation with as much detail as
+possible.
+
+## Translations
+
+The core translations of Luanti are performed using Weblate. You can access
+the project page with a list of current languages
+[here](https://hosted.weblate.org/projects/minetest/minetest/).
+
+Builtin (the component which contains things like server messages, chat command
+descriptions, privilege descriptions) is translated separately; it needs to be
+translated by editing a `.tr` text file. See
+[Translation](https://dev.luanti.org/Translation) for more information.
+
+## Donations
+
+If you'd like to monetarily support Luanti development, you can find donation
+methods on [our website](http://www.luanti.org/development/#donate).
+
+# Maintaining
+
+* This is a concise version of the
+  [Rules & Guidelines](https://dev.luanti.org/engine-dev-process/) on the developer wiki.*
+
+These notes are for those who have push access Luanti (core developers / maintainers).
+
+- See the [project organisation](https://dev.luanti.org/Organisation) for the people involved.
+
+## Concept approvals and roadmaps
+
+If a Pull Request is not a bug fix:
+
+* If it matches a goal in [the roadmap](../doc/direction.md), then the PR should
+  be labeled as "Roadmap" and the goal stated by number in the description.
+* If it doesn't match a goal, then it needs to receive a concept approval within
+  a week of being opened to remain open. This 1 week deadline does not apply to
+  PRs opened before the roadmap was adopted; instead, they may remain open or be
+  closed as needed. Use the "Concept Approved" label. Issues can be marked as
+  "Concept Approved" to give preapproval to future PRs.
+
+## Reviewing pull requests
+
+Pull requests should be reviewed and, if appropriate, checked if they achieve
+their intended purpose. You can show that you are in the process of, or will
+review the pull request by commenting *"Looks good"* or something similar.
+
+**If the pull-request is not [merge-able](#a-pull-request-is-considered-merge-able-when):**
+
+Submit a comment explaining to the author what they need to change to make the
+pull-request merge-able.
+
+- If the author comments or makes changes to the pull-request, it can be
+  reviewed again.
+- If no response is made from the author within 1 month (when improvements are
+  suggested or a question is asked), it can be closed.
+
+**If the pull-request is [merge-able](#a-pull-request-is-considered-merge-able-when):**
+
+Submit a :+1: (+1) or "Looks good" comment to show you believe the pull-request should be merged. "Looks good" comments often signify that the patch might require (more) testing.
+
+- Two core developers must agree to the merge before it is carried out and both should +1 the pull request.
+- Who intends to merge the pull-request should follow the commit rules:
+    - The title should follow the commit guidelines (title starts with a capital letter, present tense, descriptive).
+    - Don't modify history older than 10 minutes.
+    - Use rebase, not merge to get linear history:
+    - `curl -Ls https://github.com/luanti-org/luanti/pull/1.patch | git am`
+
+## Reviewing issues and feature requests
+
+- If an issue does not get a response from its author within 1 month (when requiring more details), it can be closed.
+- When an issue is a duplicate, refer to the first ones and close the later ones.
+- Tag issues with the appropriate [labels](https://github.com/luanti-org/luanti/labels) for devices, platforms etc.
+
+## Releasing a new version
+
+*Refer to [dev.luanti.org/Releasing_Luanti](https://dev.luanti.org/Releasing_Luanti)*
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,79 @@
+name: Bug report
+description: Create a report to help us improve
+labels: ["Unconfirmed bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please note the following:
+
+        1. **Please update Luanti to the latest stable or dev version** before submitting bug reports. Make sure the bug is still reproducible on the latest version.
+        2. This page is for reporting the bugs of **the engine itself**. For bugs in a particular game, please [search for the game in the ContentDB](https://content.luanti.org/packages/?type=game) and submit a bug report in their issue trackers.
+            * For example, you can submit issues about the Minetest Game [in its own repository](https://github.com/luanti-org/minetest_game/issues).
+        3. Please provide as many details as possible for us to spot the problem quicker.
+  - type: textarea
+    attributes:
+      label: Luanti version
+      description: |
+        Paste the Luanti version below.
+        If you are on a dev version, please also indicate the git commit hash.
+        Refer to the "About" tab of the menu or run `luanti --version` on the command line.
+      placeholder: |
+        Example:
+        Luanti 5.10.0-3ad6aee9b (Linux)
+        Using LuaJIT 2.1.1727870382
+        Built by GCC 14.2
+        Running on Linux/6.11.5 x86_64
+        BUILD_TYPE=Release
+        RUN_IN_PLACE=1
+        USE_CURL=1
+        USE_GETTEXT=1
+        USE_SOUND=1
+        STATIC_SHAREDIR="."
+        STATIC_LOCALEDIR="locale"
+      render: "true"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Operating system and version
+      description: It is recommended to upgrade your operating system to see if the problem persists.
+      placeholder: "Example: Ubuntu 22.04"
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: CPU model
+      description: Usually found in OS/system settings.
+      placeholder: "Example: Intel Core i5-2410M"
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: The GPU model and renderer can be omitted if the bug is not a graphical issue.
+  - type: input
+    attributes:
+      label: GPU model
+      description: Usually found in OS/system settings.
+      placeholder: "Example: NVIDIA GeForce GTX 1660"
+    validations:
+      required: false
+  - type: input
+    attributes:
+      label: Active renderer
+      description: You can find this in the "About" tab in the main menu.
+      placeholder: "Example: ES 3.2 / ogles2 / X11"
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: Summary
+      description: Describe your problem here.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Steps to reproduce
+      description: Explain how the problem has happened, providing a minimal test (e.g. a minimized code snippet) where possible.
+    validations:
+      required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Submit issues about Minetest Game
+    url: https://github.com/luanti-org/minetest_game/issues/new
+    about: Only submit issues of the engine in this repository's issue tracker. Submit those of Minetest Game in its own issue tracker.
+  - name: Search for issue trackers of third-party games
+    url: https://content.luanti.org/packages/?type=game
+    about: For issues of third-party games, search for the game in the ContentDB and then submit an issue in their issue tracker.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -0,0 +1,39 @@
+name: Feature request
+description: Suggest an idea for this project
+labels: ["Feature request"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please note the following:
+        1. Only submit a feature request if the feature does not exist on the latest dev version.
+        2. This page is for suggesting changes to **the engine itself**. To suggest changes to games, please [search for the game in the ContentDB](https://content.luanti.org/packages/?type=game) and submit a feature request in their issue trackers.
+  - type: textarea
+    attributes:
+      label: Problem
+      description: |
+        A clear and concise description of the problem, i.e. "Why is this needed?"
+        Example: I'm always frustrated when [...]
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Solutions
+      description: |
+        A clear and concise description of what you want to happen.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Alternatives
+      description: |
+        A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: |
+        Add any other context or screenshots about the feature request here.
+    validations:
+      required: false
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,20 @@
+Add compact, short information about your PR for easier understanding:
+
+- Goal of the PR
+- How does the PR work?
+- Does it resolve any reported issue?
+- Does this relate to a goal in [the roadmap](https://github.com/luanti-org/luanti/blob/master/doc/direction.md)?
+- If not a bug fix, why is this PR needed? What usecases does it solve?
+
+## To do
+
+This PR is a Work in Progress / Ready for Review.
+<!-- ^ delete one -->
+
+- [ ] List
+- [ ] Things
+- [ ] To do
+
+## How to test
+
+<!-- Example code or instructions -->
diff --git a/.github/SECURITY.md b/.github/SECURITY.md
@@ -0,0 +1,20 @@
+# Security Policy
+
+## Supported Versions
+
+We only support the latest stable version for security issues.
+See the [releases page](https://github.com/luanti-org/luanti/releases).
+
+## Reporting a Vulnerability
+
+We ask that you report vulnerabilities privately, by contacting a core developer,
+to give us time to fix them. You can do that by emailing one of the following addresses:
+
+* celeron55@gmail.com
+* rw@rubenwardy.com
+
+Depending on severity, we will either create a private issue for the vulnerability
+and release a patch version of Luanti, or give you permission to file the issue publicly.
+
+For more information on the justification of this policy, see
+[Responsible Disclosure](https://en.wikipedia.org/wiki/Responsible_disclosure).