yams RPG
========

yams RPG, or "yams" for short, is a work-in-progress game for Luanti. It uses
Minetest Game as a base while adding light RPG elements. This game is geared
towards those who are familiar with other voxel survival games.

This game includes a variety of mods created by the Luanti community, and
many of them have been modified to various degrees for better integration
with the rest of the game.

As the game is incomplete, expect bugs and unfinished content. In particular,
mod compatibility is not very good. Making a public server using this game
is discouraged, and making mods for yams RPG is not recommended either.

Installing
----------

Luanti 5.11.0 or later is required to play yams RPG. It is recommended to
install the game from within Luanti by going to the Content tab in-game.

Alternatively, it can be downloaded from
[ContentDB](https://content.luanti.org/packages/jara25/yams/)
or from the [Releases](https://codeberg.org/jara25/yams/releases) page. Unzip
the archive to the `games/` folder within the Luanti user data directory.

Do not download the zip archive of the source code from Codeberg, as it will
be missing many files required to run the game.

Features
--------

* A vanilla MTG world augmented with the Extra Biomes mod
* Many melee, ranged, and magical weapons to fight mobs with
* Rebalanced armor stats
* Sprinting and hunger mechanics
* Gain EXP and level up by defeating mobs and mining ores
* A simple stat system that allows players to choose what to prioritize
* Progressive crafting guide that uses the Craft Lookup mod as a base
* Familiar mobs that have been tweaked specifically for this game
* Many types of food to make and eat
* Status effects that can help or hinder players
* Many tools provided by various mods that aid in exploration
* A detailed in-game manual
* Over 50 awards to aim for
* ...and some other things for players to discover

Beginner Tips
-------------

- Generally, it is best to craft a wooden pickaxe first, then make stone tools
shortly after.
- The **Craft Lookup** tab is where the crafting guide is located. Add blocks
and items to the guide by discovering them, which can be done by picking them
up or punching them.
- Make sure to gather enough food while exploring. Look for crops growing
throughout the world. Certain mobs also drop raw meat when defeated.
- Chopping trees, mining ores, and defeating mobs gives EXP. Use stat points
gained from leveling up in the **Level Up** tab. Dying causes some loss of
progress towards reaching the next level, but inventory is kept.
- Many mosters spawn during the night. It is recommended to have a shelter
before the sun goes down.
- It is very important to know that monsters become stronger at lower depths.
Make sure to be prepared!
- View the in-game manual for more details. Go to the **More** tab and click
**Help**.

Getting the source code
-----------------------

You can clone the Git repository with the following command:

```
git clone --recurse-submodules https://codeberg.org/jara25/yams.git
```

Keep in mind that cloning will take several minutes because of the
many submodules within this repository.

Licensing
---------

The game as a whole is licensed under the GPLv3, but individual mods
and assets have their own licenses. See LICENSE.txt and CREDITS.txt
for a general overview.

