mirror of
https://github.com/luanti-org/luanti.git
synced 2025-06-27 16:36:03 +00:00
DOCS: replace Minetest -> Luanti, minetest.
-> core.
(#15292)
Co-authored-by: grorp <gregor.parzefall@posteo.de>
This commit is contained in:
parent
aa273119f2
commit
d52e4cdbdb
23 changed files with 873 additions and 865 deletions
|
@ -6,7 +6,7 @@ Some important development docs are found in the wiki: https://dev.minetest.net/
|
|||
|
||||
Notable pages:
|
||||
|
||||
- [Releasing Minetest](https://dev.minetest.net/Releasing_Minetest)
|
||||
- [Releasing Luanti](https://dev.minetest.net/Releasing_Minetest)
|
||||
- [Engine translations](https://dev.minetest.net/Translation#Maintaining_engine_translations)
|
||||
- [Changelog](https://dev.minetest.net/Changelog)
|
||||
- [Organisation](https://dev.minetest.net/Organisation)
|
||||
|
|
|
@ -21,7 +21,7 @@ After that installing it will work:
|
|||
adb install -r -d ./app-arm64-v8a-release-unsigned.apk
|
||||
```
|
||||
|
||||
## How to get debug output from Minetest on Android
|
||||
## How to get debug output from Luanti on Android
|
||||
|
||||
In case debug.txt isn't enough (e.g. when debugging a crash), you can get debug
|
||||
output using logcat:
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
# Miscellaneous
|
||||
|
||||
## Profiling Minetest on Linux with perf
|
||||
## Profiling Luanti on Linux with perf
|
||||
|
||||
We will be using a tool called "perf", which you can get by installing `perf` or `linux-perf` or `linux-tools-common`.
|
||||
|
||||
To get usable results you need to build Minetest with debug symbols
|
||||
To get usable results you need to build Luanti with debug symbols
|
||||
(`-DCMAKE_BUILD_TYPE=RelWithDebInfo` or `-DCMAKE_BUILD_TYPE=Debug`).
|
||||
|
||||
Run the client (or server) like this and do whatever you wanted to test:
|
||||
|
@ -48,20 +48,20 @@ It allows one to annotate important functions and generate traces, where one can
|
|||
see when each individual function call happened, and how long it took.
|
||||
|
||||
Tracy can also record when frames, e.g. server step, start and end, and inspect
|
||||
frames that took longer than usual. Minetest already contains annotations for
|
||||
frames that took longer than usual. Luanti already contains annotations for
|
||||
its frames.
|
||||
|
||||
See also [Tracy's official documentation](https://github.com/wolfpld/tracy/releases/latest/download/tracy.pdf).
|
||||
|
||||
### Installing
|
||||
|
||||
Tracy consists of a client (Minetest) and a server (the gui).
|
||||
Tracy consists of a client (Luanti) and a server (the gui).
|
||||
|
||||
Install the server, e.g. using your package manager.
|
||||
|
||||
### Building
|
||||
|
||||
Build Minetest with `-DDBUILD_WITH_TRACY=1`, this will fetch Tracy for building
|
||||
Build Luanti with `-DDBUILD_WITH_TRACY=1`, this will fetch Tracy for building
|
||||
the Tracy client. And use `FETCH_TRACY_GIT_TAG` to get a version matching your
|
||||
Tracy server, e.g. `-DFETCH_TRACY_GIT_TAG=v0.11.0` if it's `0.11.0`.
|
||||
|
||||
|
@ -74,7 +74,7 @@ See Tracy's documentation for more build options.
|
|||
|
||||
### Using in C++
|
||||
|
||||
Start the Tracy server and Minetest. You should see Minetest in the menu.
|
||||
Start the Tracy server and Luanti. You should see Luanti in the menu.
|
||||
|
||||
To actually get useful traces, you have to annotate functions with `ZoneScoped`
|
||||
macros and recompile. Please refer to Tracy's official documentation.
|
||||
|
@ -82,7 +82,7 @@ macros and recompile. Please refer to Tracy's official documentation.
|
|||
### Using in Lua
|
||||
|
||||
Tracy also supports Lua.
|
||||
If built with Tracy, Minetest loads its API in the global `tracy` table.
|
||||
If built with Tracy, Luanti loads its API in the global `tracy` table.
|
||||
See Tracy's official documentation for more information.
|
||||
|
||||
Note: The whole Tracy Lua API is accessible to all mods. And we don't check if it
|
||||
|
|
|
@ -2,7 +2,7 @@ OS/library compatibility policy
|
|||
===============================
|
||||
|
||||
This document describes how we decide which minimum versions of operating systems, C++ standards,
|
||||
libraries, build tools (CMake) or compilers Minetest requires.
|
||||
libraries, build tools (CMake) or compilers Luanti requires.
|
||||
|
||||
Most important is that we do not increase our minimum requirements without a reason or use case.
|
||||
A reason can be as simple as "cleaning up legacy support code", but it needs to exist.
|
||||
|
@ -54,7 +54,7 @@ OpenGL ES 2.0 is supported for the sake of mobile platforms.
|
|||
It has been [proposed](https://irc.minetest.net/minetest-dev/2022-08-18) moving to OpenGL 2.x or 3.0 with shaders required.
|
||||
|
||||
General **system requirements** are not bounded either.
|
||||
Being able to play Minetest on a recent low-end phone is a reasonable target.
|
||||
Being able to play Luanti on a recent low-end phone is a reasonable target.
|
||||
|
||||
## On totality
|
||||
|
||||
|
@ -71,7 +71,7 @@ Sound is optional at build-time but nobody would call an engine build without so
|
|||
|
||||
In general also consider:
|
||||
* Is the proposition important enough to warrant a new dependency?
|
||||
* Can we make it easier for users to build the library together with Minetest?
|
||||
* Can we make it easier for users to build the library together with Luanti?
|
||||
* Maybe even vendor the library?
|
||||
* Or could the engine include a transparent fallback implementation?
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue