diff --git a/README.md b/README.md index aa08592..4333e31 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,23 @@ -# real_g +# Real Gravity [![](https://github.com/minetest-mods/real_g/workflows/build/badge.svg)](https://github.com/minetest-mods/real_g/actions) [![License](https://img.shields.io/badge/license-MIT-purple.svg)](https://mit-license.org/) Minetest mod that creates an imatation of real-world gravity. The farther away you get from sea level, the lower your gravity, and the closer you get to the sea, the higher your gravity. -*NOTE:* ***The mod should work for most versions of minetest.*** +## Dependencies +- `default` (included in [Minetest Game](https://github.com/minetest/minetest_game)). + +## Installation +- Unzip the archive, rename the folder to `real_g` and +place it in .. minetest/mods/ + +- GNU/Linux: If you use a system-wide installation place + it in ~/.minetest/mods/. + +- If you only want this to be used in a single world, place + the folder in .. worldmods/ in your world directory. + +For further information or help, see:\ +https://wiki.minetest.net/Installing_Mods + +## Requirements +- Recommended: MT 5.0.0+ +- Minimum: MT 0.4.16+