nalc/gauges
1
0
Fork 0
forked from minetest-mods/gauges
Code Issues Pull Requests Releases Wiki Activity
Minetest mod that adds health and breath gauges above players
28 Commits 1 Branch 3 Tags 124 KiB
Lua 100%
29a7dabe8d
Go to file
Hugo Locurcio 29a7dabe8d
Add a preview screenshot at the top of the README
2020-01-01 17:53:37 +01:00
textures Optimize the mod code 2020-01-01 17:29:16 +01:00
.editorconfig Set EditorConfig to use tabs in .luacheckrc 2019-02-22 00:49:27 +01:00
.luacheckrc Add a Luacheck configuration file 2019-02-21 13:44:35 +01:00
.pre-commit-config.yaml Update pre-commit hooks to 2.3.0 2019-09-25 23:19:13 +02:00
.travis.yml Travis CI: Use the bionic distribution 2019-07-29 00:52:08 +02:00
CHANGELOG.md Add a project changelog 2020-01-01 17:38:24 +01:00
init.lua Optimize the mod code 2020-01-01 17:29:16 +01:00
LICENSE.assets.md Add a README 2019-03-02 18:59:59 +01:00
LICENSE.md Update copyright statements to 2020 2020-01-01 04:11:04 +01:00
mod.conf Use mod.conf for name and description (#1) 2019-09-28 20:14:56 +02:00
README.md Add a preview screenshot at the top of the README 2020-01-01 17:53:37 +01:00

README.md

Gauges

Preview

Gauges for Minetest, a free and open source infinite world block sandbox game.

Forum topic

Installation

Download the mod

To install Gauges, clone this Git repository into your Minetest's mods/ directory:

git clone https://github.com/minetest-mods/gauges.git

You can also download a ZIP archive of Gauges. If you do so, you will need to extract the archive then rename the resulting folder from gauges-master to gauges – this is absolutely required, as the mod won't work otherwise.

Enable the mod

Once you have installed Gauges, you need to enable it in Minetest. The procedure is as follows:

Using the client's main menu

This is the easiest way to enable Gauges when playing in singleplayer (or on a server hosted from a client).

  1. Start Minetest and switch to the Local Game tab.
  2. Select the world you want to enable Gauges in.
  3. Click Configure, then enable gauges by double-clicking it (or ticking the Enabled checkbox).
  4. Save the changes, then start a game on the world you enabled Gauges on.
  5. Gauges should now be running on your world.

Using a text editor

This is the recommended way to enable the mod on a server without using a GUI.

  1. Make sure Minetest is not currently running (otherwise, it will overwrite the changes when exiting).
  2. Open the world's world.mt file using a text editor.
  3. Add the following line at the end of the file:
load_mod_gauges = true

If the line is already present in the file, then replace false with true on that line.

  1. Save the file, then start a game on the world you enabled Gauges on.
  2. Gauges should now be running on your world.

Version compatibility

Gauges is currently primarily tested with Minetest 5.1.0. It may or may not work with newer or older versions. Issues arising in versions older than 5.0.0 will generally not be fixed.

License

Copyright © 2014-2020 4aiman, Hugo Locurcio and contributors

  • Code is licensed under the MIT license, see LICENSE.md for details.
  • Textures are licensed under CC0 1.0 Universal, see LICENSE.assets.md for details.