Skip to content

Commit

Permalink
Organize getting started flows, remove WIP banner (#203)
Browse files Browse the repository at this point in the history
* Shorten homepage to just link to its 5 child pages

* Change open source to open-source

* Move mod content to creating-mods

* Cleanup creating-texture-packs.md

* Organize translation pages and links to it

* Fixup licensing

* Change `client` to `app` in intro documentation

* Update luanti.md

* Cleanup some index pages

* Add app vs client note

* Add "formerly Minetest" notes on a couple pages

* Add formerly Minetest to homepage

* PR review updates

* Open VSX vs Marketplace docs

* Remove WIP banner
  • Loading branch information
mark-wiemer authored Feb 27, 2025
1 parent e2c75d0 commit 5ba3a20
Show file tree
Hide file tree
Showing 15 changed files with 59 additions and 142 deletions.
16 changes: 7 additions & 9 deletions content/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@ aliases:

# Luanti Documentation

Welcome to the **Luanti Documentation** website. This is a work-in-progress effort with the purpose of acting as a central hub for well-maintained documentation about the Luanti engine, for players as well as for developers.
Welcome to **Luanti Documentation**. Luanti (formerly [Minetest](https://blog.luanti.org/2024/10/13/Introducing-Our-New-Name/)) is an open-source voxel game engine that includes a client for players and a distribution platform for convenient mod and game installation.

Content from the Luanti Developer Wiki as well as content from the Luanti Wiki relating to the Luanti engine in general have been migrated here, and now redirect to their new location.
{{% comment %}} Keep this list matching the table of contents ordering {{% /comment %}}

For more information about Luanti as well as how to contribute to this site, see [About](/about/).

## Contents

All pages currently available are listed in the left sidebar, accessible through the hamburger menu to the left on mobile. Some pages are listed under categories and sub-categories, which can be expanded by clicking on the arrow icons to the right. The search bar also allows you to discover what is currently available.

The structure of the documentation is subject to change and a more proper content index will be available in the future.
- [About](/about) contains more info about Luanti, its history, and how to contribute
- [For Creators](/for-creators) has info about creating your own game, mod, texture pack, translation, or other creation with or for Luanti
- [For Engine Devs](/for-engine-devs) has guidance for contributing to the engine powering all Luanti games
- [For Players](/for-players) has info about how to download the client, install a game, join a multiplayer server, and more
- [For Server Hosts](/for-server-hosts) has info about setting up your own public or private multiplayer server
11 changes: 10 additions & 1 deletion content/about/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ aliases:

# About

Luanti is a free and open-source voxel game engine with its own [distribution platform](/about/contentdb) and [client](/about/luanti). Players, creators, server hosts, and engine developers can find more information here about how to get started with Luanti.
Luanti (formerly [Minetest](https://blog.luanti.org/2024/10/13/Introducing-Our-New-Name/)) is a free and open-source voxel game engine with its own [distribution platform](/about/contentdb) and [client](/about/luanti). Players, creators, server hosts, and engine developers can find more information here about how to get started with Luanti.

This site is created using [Hugo](https://gohugo.io/), with theme [Hugo Book](https://themes.gohugo.io/themes/hugo-book/). The site's source content can be found [on GitHub](https://github.com/luanti-org/docs.luanti.org/tree/master/content), and we welcome contributions from everyone. To contribute, see [Contributing to Docs](/about/contributing-to-docs).

Expand All @@ -31,3 +31,12 @@ Documentation will cover:
- Server and platform (player-facing) usage and guides

This project began in December 2024. Our roadmap can be found at [GitHub issue #113: Roadmap](https://github.com/luanti-org/docs.luanti.org/issues/113).

## Other Luanti sites

- [luanti.org](https://luanti.org)
- [Luanti Blog](https://blog.luanti.org/)
- [Luanti API Documentation](https://api.luanti.org/)
- [Luanti Forums](https://forum.luanti.org/)
- [ContentDB](https://content.luanti.org/)
- [Annual Luanti Game Jam](https://jam.luanti.org/)
4 changes: 2 additions & 2 deletions content/about/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ Another reason is that we have limited time, and we do not have a core developer

Luanti is a volunteer project with limited time and resources. Supporting a new platform takes a lot of effort, and we're only able to officially support platforms with a core developer using it.

In terms of consoles, if someone is willing to make a homebrew port for a game console then it can be done, and this port can be submitted to upstream given that the changes aren't intrusive and some kind of maintenance is kept. Putting Luanti onto a games console in any official capacity is not possible due to NDAs preventing an open source release, which is incompatible with the LGPLv2.1 license.
In terms of consoles, if someone is willing to make a homebrew port for a game console then it can be done, and this port can be submitted to upstream given that the changes aren't intrusive and some kind of maintenance is kept. Putting Luanti onto a games console in any official capacity is not possible due to NDAs preventing an open-source release, which is incompatible with the LGPLv2.1 license.

Luanti is open source. We welcome contributors to port Luanti to other platforms (providing they follow the licenses of course). Contributors are also welcome to contribute their changes back upstream as well, providing that they're not too intrusive.
Luanti is open-source. We welcome contributors to port Luanti to other platforms (providing they follow the licenses of course). Contributors are also welcome to contribute their changes back upstream as well, providing that they're not too intrusive.

### Where can I ask questions?

Expand Down
2 changes: 1 addition & 1 deletion content/about/luanti-edu.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Minecraft is much better known and many children and teenagers are already playi

**Pro:**

- It's free because it's open source and it's going to stay open.
- It's free because it's open-source and it's going to stay open.
- It runs on almost all operating systems and devices ... _except iOS systems_.
- From all versions (also from the tablet) you can usually visit the same servers.

Expand Down
10 changes: 5 additions & 5 deletions content/about/luanti.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ aliases:

![Luanti logo](/images/luanti/Luanti_logo.png)

**Luanti** is a [free software](https://en.wikipedia.org/wiki/Free_software) [game engine](https://en.wikipedia.org/wiki/Game_engine) to create various games based on [voxel](https://en.wikipedia.org/wiki/Voxel) gameplay, inspired by InfiniMiner, Minecraft, and the like. Luanti was originally created by Perttu Ahola (alias “[celeron55](/about/history/celeron55)”).
**Luanti** (formerly [**Minetest**](https://blog.luanti.org/2024/10/13/Introducing-Our-New-Name/)) is a [free software](https://en.wikipedia.org/wiki/Free_software) [game engine](https://en.wikipedia.org/wiki/Game_engine) to create various games based on [voxel](https://en.wikipedia.org/wiki/Voxel) gameplay, inspired by InfiniMiner, Minecraft, and the like. Luanti was originally created by Perttu Ahola (alias “[celeron55](/about/history/celeron55)”).

The basic idea of each game is always the same: The [player](/for-players/player) is thrown into a huge [world](/for-players/worlds) made out of cubes/[blocks](/for-players/nodes). Most of the time, these cubes make the landscape and these blocks can be removed and placed almost entirely freely. Using the collected [items](/for-players/items), new [tools](/for-players/tool) and other items can be crafted. Games in Luanti can, however, be much more complex than this.

Expand Down Expand Up @@ -42,7 +42,7 @@ As Luanti is an engine, the actual in-game appearance heavily depends on the act

### Mods

There exists several hundred of mods, most for Minetest Game and some for other games. The largest list of mods can be found on [ContentDB](https://content.luanti.org/packages/?type=mod)
Thousands of mods are available for free on [ContentDB](https://content.luanti.org/packages/?type=mod)

### More screenshots

Expand Down Expand Up @@ -71,7 +71,7 @@ Luanti is free software, without advertisements and free of charge. It is licens

## Name

In the beginning, Luanti was called “**Minetest-c55**”. The “c55” stands for “celeron55”, the original creator. The “Minetest” was chosen simply because he wanted to test how far he could come with a Minecraft clone. (But today, Luanti is a game engine for all sorts of voxel games, not just Minecraft clones.)
In the beginning, Luanti was called “**Minetest-c55**”. The “c55” stands for “celeron55”, the original creator. The “Minetest” was chosen simply because he wanted to test how far he could come with a Minecraft clone.

As the project attracted a larger following, the ”-c55” was dropped and so the new name was “**Minetest**” and that name stuck for many years. But many people didn’t like the name because of the “test” in the name.

Expand All @@ -83,9 +83,9 @@ After years of brainstorming and discussion, a decision has finally been made: O
{{% comment %}} cspell:enable {{% /comment %}}

Today, Luanti is a game engine for all sorts of voxel games, not just Minecraft clones.

## See also

- [Download Luanti](http://www.luanti.org/downloads/)
- [Getting Started](/for-players/getting-started)
- [Version Number](/for-engine-devs/version-number)
- [Main Page](/)
36 changes: 7 additions & 29 deletions content/for-creators/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,41 +11,19 @@ bookCollapseSection: true

Luanti is a platform for creating and sharing games, mods, texture packs, and more. This section also hosts information about translating content for other audiences.

Luanti has a scripting API, which is used to program games and mods, creating whole new experiences or extending existing ones. The API is accessed using Lua, an easy-to-use programming language. Version 5.1 of Lua is used, but many people run LuaJIT for greater performance. The only thing you will need is _basic_ programming knowledge.
Here are some getting started guides:

## Documentation

### Tutorials

The [Luanti Modding Book](https://rubenwardy.com/minetest_modding_book/) is a friendly introduction to Luanti modding and game creation, introducing you to various aspects of the API.

It is recommended you start here, even if you are already apt at programming, to get a good understanding of how Luanti mods work and are structured.

### Lua API Reference

The official Lua API documentation is `lua_api.md`. It's available as [markdown](https://github.com/luanti-org/luanti/blob/master/doc/lua_api.md) or [HTML](https://api.luanti.org/). You can find the plaintext version in your Luanti installation, in the `doc` directory.

This is a concise description of the entire API, explaining functions, data structures, registration templates & more. The core developers of Luanti maintain it, changes going through a quality control process.

Any functions not listed here are subject to change and not guaranteed to be compatible across versions, though usually they are.

### The minetest_docs Project

minetest_docs was a project to create new, more detailed documentation. The final contents from the project can currently be found under the [/api/](/for-creators/api/) directory here.

## Useful tools

Here are some useful tools that most modders use when making Luanti mods:

- [Visual Studio Code](https://code.visualstudio.com/)/[VSCodium](https://vscodium.com/), powerful code editor with a [Minetest extension](https://marketplace.visualstudio.com/items?itemName=GreenXenith.minetest-tools) available for code completion.
- [luacheck](https://github.com/lunarmodules/luacheck), static analysis tool for Lua. See [this modding book chapter](https://rubenwardy.com/minetest_modding_book/en/quality/luacheck.html) for more information on how to use it with Luanti.
- [Creating mods](/for-creators/creating-mods)
- [Creating texture packs](/for-creators/creating-texture-packs)
- [Distributing games outside ContentDB](/for-creators/distributing-games-outside-contentdb)
- [Translation](/for-creators/translation)

## Other useful links

- Check out [ContentDB](https://content.luanti.org/) to see mods that have been published by the community.
- Check out [ContentDB](https://content.luanti.org/) to see mods and games by the community.
- Get mod help from the community:
- [Forums](https://forum.luanti.org/viewforum.php?f=47)
- [Discord](https://discord.gg/minetest)
- [Matrix](https://matrix.to/#/#minetest:tchncs.de)
- ...[more](https://www.luanti.org/get-involved/)
- [...more](https://www.luanti.org/get-involved/)
- Suggest a mod idea in the [mod request thread](https://forum.luanti.org/viewtopic.php?f=9&t=2434).
19 changes: 16 additions & 3 deletions content/for-creators/creating-mods.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,23 @@ title: Creating mods

# Creating mods

[Mods](/for-players/mods) are written in the scripting language [Lua](https://www.lua.org/). The official Lua API documentation can be found at [lua_api.md](https://github.com/luanti-org/luanti/blob/master/doc/lua_api.md) or in HTML format at [api.luanti.org](https://api.luanti.org/).
Luanti has a scripting API which is used to program games and [mods](/for-players/mods), allowing creators to create new experiences or extend existing ones with mods. The API is accessed using [Lua](https://www.lua.org/), an easy-to-use programming language. Version 5.1 of Lua is used, but many people run LuaJIT for greater performance. The only thing you will need is _basic_ programming knowledge.

The official Luanti Lua API reference can be found at [api.luanti.org](https://api.luanti.org/), with guides hosted in the [API section of this site](/for-creators/api).

## Modding tutorials

- [Minetest Modding Book](https://rubenwardy.com/minetest_modding_book/en/index.html) by [rubenwardy](https://rubenwardy.com/) with editing by [Shara](https://forum.luanti.org/memberlist.php?mode=viewprofile&u=19807).
- [For Creators page on this site](/for-creators)
The best way to create your first Luanti mod or game is with the [Luanti Modding Book](https://rubenwardy.com/minetest_modding_book/en/index.html) by [rubenwardy](https://rubenwardy.com/) with editing by [Shara](https://forum.luanti.org/memberlist.php?mode=viewprofile&u=19807).

Games use the same system as mods, and can be thought of as simply a collection of mods. See the [Games chapter of the Luanti Modding Book](https://rubenwardy.com/minetest_modding_book/en/games/games.html) for more details.

## Recommended tools

Here are some useful tools that most modders use when making Luanti mods:

- [Visual Studio Code](https://code.visualstudio.com/)/[VSCodium](https://vscodium.com/), a powerful code editor. We've also published Minetest Tools, an extension for Luanti code completion available on [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=GreenXenith.minetest-tools) and [Open VSX Registry](https://open-vsx.org/extension/GreenXenith/minetest-tools).
- [luacheck](https://github.com/lunarmodules/luacheck), a static analysis tool for Lua. See the [luacheck chapter of the Luanti Modding Book](https://rubenwardy.com/minetest_modding_book/en/quality/luacheck.html) for more information on how to use it with Luanti.

## See also

- [Modding Tips on this site](/for-creators/modding-tips)
2 changes: 1 addition & 1 deletion content/for-creators/creating-texture-packs.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ There is a small text file named `texture_packs_here.txt` in the correct locatio
Windows:

- Browse to your Luanti folder
- Enter the `games/minetest_game` folder
- Enter the `games/minetest_game` folder (or whatever game you want to make a texture pack for)
- Then hit Ctrl+F to invoke the search function,
- In the search box, enter `*.png` to find all the image files (or directly use the “Images” option in the search page),
- Next Select All Ctrl+A,
Expand Down
2 changes: 1 addition & 1 deletion content/for-creators/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ The code of both the Luanti engine and Minetest Game are licensed under [LGPL 2.
- You must not mix proprietary and LGPLv2.1+ code, see _"what if I use proprietary source code/libraries?"_.
- You should place the following attribution on any pages where the software can be downloaded, including but not limited to Google Play or a website:

> This \[app/game/...\] uses the Luanti engine \[and Minetest Game\], Copyright 2010-2018 Perttu Ahola and contributors, licensed under LGPLv2.1+
> This [app/game/...] uses the Luanti engine [and Minetest Game], Copyright 2010-2018 Perttu Ahola and contributors, licensed under LGPLv2.1+
**It is an infringement to only link back to the original source code if you made modifications**

Expand Down
8 changes: 4 additions & 4 deletions content/for-creators/translation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ bookCollapseSection: true

This page explains how to translate Luanti.

## Translating mods and games

To learn how Luanti mods and games are translated, go to [Translating Mods and Games](/for-creators/translation/mods-and-games).

## Translating the engine

Translations of the Luanti engine are [automated using Weblate](https://hosted.weblate.org/projects/minetest/minetest/). Register an account, select the “Minetest” project (or “Luanti” if it has been renamed) and start translating. Translation is a continuous effort and the texts will change almost at every version.
Expand Down Expand Up @@ -113,10 +117,6 @@ To update the builtin locale files, run `../util/mod_translation_updater.py` fro

To start a new translation, copy `template.txt` to create `__builtin.<LANGUAGE_CODE>.tr`.

## Translating mods and games

To learn how Luanti mods and games are translated, go to [Translating Mods and Games](/for-creators/translation/mods-and-games).

## Untranslatable texts

Please note: A couple of things in Luanti can **not** be translated yet:
Expand Down
2 changes: 1 addition & 1 deletion content/for-engine-devs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ bookCollapseSection: true

# For Engine Devs

This section contains all rules and guidelines that developers, contributors, and others working on the project should follow.
This section contains all rules and guidelines that developers, contributors, and others working on the engine should follow.

## Core developers

Expand Down
2 changes: 1 addition & 1 deletion content/for-players/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ For more information, see [Getting Started](/for-players/getting-started/).
## General information

- [Controls](/for-players/controls)
- [Server commands](/for-players/server-commands)
- [Server Commands](/for-players/server-commands)
- [Privileges](/for-players/privileges)
- [minetest.conf](/for-players/minetest-conf)

Expand Down
2 changes: 1 addition & 1 deletion content/for-players/server-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ aliases:
- /server/commands
---

# Server commands
# Server Commands

**Server commands** (also called “**chat commands**”) are special commands to the server that can be entered by any player via the [chat](/for-players/chat) to cause the server to do something.

Expand Down
4 changes: 2 additions & 2 deletions content/for-server-hosts/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ Server hosts setup and manage multiplayer Luanti servers.

## Managing a server

See [Setting up a server](/setting-up-a-server) for information running your own server.
See [Setting up a server](/for-server-hosts/setup) for information running your own server.

## See also

- [Server tool mods (ContentDB)](https://content.luanti.org/packages/?tag=server_tools)
- [Servers (for players)](/for-players/servers)
- [Server commands](/for-players/server-commands)
- [Server Commands (for players)](/for-players/server-commands)
81 changes: 0 additions & 81 deletions layouts/partials/docs/inject/content-before.html

This file was deleted.

0 comments on commit 5ba3a20

Please sign in to comment.