mirror of
https://github.com/luanti-org/luanti.git
synced 2025-06-27 16:36:03 +00:00
Improve descriptions and use file name
This commit is contained in:
parent
ceca50aff9
commit
0b2631a17b
2 changed files with 29 additions and 25 deletions
|
@ -32,7 +32,6 @@ Further documentation
|
||||||
- Forum: https://forum.luanti.org/
|
- Forum: https://forum.luanti.org/
|
||||||
- GitHub: https://github.com/luanti-org/luanti/
|
- GitHub: https://github.com/luanti-org/luanti/
|
||||||
- [Developer documentation](doc/developing/)
|
- [Developer documentation](doc/developing/)
|
||||||
- [Documentation index](doc/README.md)
|
|
||||||
- [doc/](doc/) directory of source distribution
|
- [doc/](doc/) directory of source distribution
|
||||||
|
|
||||||
Default controls
|
Default controls
|
||||||
|
|
|
@ -1,37 +1,42 @@
|
||||||
# Documentation Index
|
# Documentation Index
|
||||||
|
|
||||||
The following is a list of documentation files and a brief description, if
|
The following is a list of documentation files and a brief description to aid
|
||||||
applicable, to aid in locating documentation (sorted alphabetically
|
in locating documentation (sorted alphabetically per-section).
|
||||||
per-section).
|
|
||||||
|
|
||||||
## Lua
|
## Lua
|
||||||
|
|
||||||
- [Builtin Entities](builtin_entities.md): Doc for predefined engine entities, i.e. dropped items and falling nodes.
|
- [builtin_entities.md](builtin_entities.md): Doc for predefined engine
|
||||||
- [Client-side API](client_lua_api.md): Client side enviorment's Lua API.
|
entities, i.e. dropped items and falling nodes.
|
||||||
- [Formspec Toolkit API](fst_api.txt)
|
- [client_lua_api.md](client_lua_api.md): Client side enviorment's Lua API.
|
||||||
- [Menu API](menu_lua_api.md): Lua API for the creation of engine menus, not the
|
- [fst_api.txt](fst_api.txt): Formspec Toolkit API, this is for the engine's
|
||||||
mod API.
|
menus (Manu menu, world creation dialogs, etc.)
|
||||||
- [Mod APIs](lua_api.md): Lua APIs avalible within the mod enviorment and mapgen
|
- [menu_lua_api.md](menu_lua_api.md): Lua API for the creation of engine menus,
|
||||||
enviorment. Contains infromation related to texturing and structure of games,
|
not the mod API.
|
||||||
mods, and texture packs. **Related**: [Texture Packs](texture_packs.md) and
|
- [lua_api.md](lua_api.md): Lua APIs for server mods. Documents the normal mod
|
||||||
[World Format](world_format.md).
|
enviorment and mapgen enviorment and contains infromation related to
|
||||||
|
texturing and structure of games, mods, and texture packs.
|
||||||
|
|
||||||
## Formats and Content
|
## Formats and Content
|
||||||
|
|
||||||
- [Texture Packs](texture_packs.md): Layout and description of Luanti's texture
|
- [texture_packs.md](texture_packs.md): Layout and description of Luanti's
|
||||||
packs structure and configuration. Related information can be found in the
|
texture packs structure and configuration. Related information can be
|
||||||
[mod API](lua_api.md).
|
found in the [mod API](lua_api.md).
|
||||||
- [World Format](world_format.md): Layout and description of Luanti's world
|
- [world_format.md](world_format.md): Layout and description of Luanti's world
|
||||||
format. Documents the structure of the dirrectories and the files therein,
|
format. Documents the structure of the dirrectories and the files therein,
|
||||||
including the structure of the internal world related databases.
|
including the structure of the internal world related databases.
|
||||||
|
**Important**: Due to incompleatness of this documentation, it is
|
||||||
## Protocals
|
recommended to read the serialize and deserialize functions in C++ to
|
||||||
|
better understand this documentation.
|
||||||
- [Protocol](protocol.txt): *Rough* outline of Luanti's network protocol.
|
- [protocol.txt](protocol.txt): *Rough* outline of Luanti's network protocol.
|
||||||
|
|
||||||
## Misc.
|
## Misc.
|
||||||
|
|
||||||
- [Android Information](android.md)
|
- [android.md](android.md) Android related information.
|
||||||
- [Docker Server](docker_server.md)
|
- [breakages.md](breakages.md) List of major breakages.
|
||||||
- [Luanti Development Direction](direction.md)
|
- [compiling/](compiling/) Compilation information and instructions.
|
||||||
- [List of Major Breakages](breakages.md)
|
- [developing/](developing/) Extra information about Luanti development, e.g.
|
||||||
|
OS-related information.
|
||||||
|
- [direction.md](direction.md) Information related to the future direction of
|
||||||
|
Luanti.
|
||||||
|
- [docker_server.md](docker_server.md) Infromation about Docker server images.
|
||||||
|
- [ides/](ides/) Information about IDE configuration.
|
Loading…
Add table
Add a link
Reference in a new issue