https://github.com/icedragon200/mt-yatm

Minetest version of YATM
https://github.com/icedragon200/mt-yatm

automation decorations fluids-system foundation items-system mesecons minetest minetest-mod nokore tech

Last synced: 2 months ago
JSON representation

Minetest version of YATM

• Host: GitHub
• URL: https://github.com/icedragon200/mt-yatm
• Owner: IceDragon200
• License: apache-2.0
• Created: 2019-03-11T00:31:41.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-02-17T05:34:24.000Z (10 months ago)
• Last Synced: 2024-10-11T12:05:49.913Z (2 months ago)
• Topics: automation, decorations, fluids-system, foundation, items-system, mesecons, minetest, minetest-mod, nokore, tech
• Language: Lua
• Homepage: https://yatm.icedragon.space/
• Size: 21.5 MB
• Stars: 4
• Watchers: 5
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ![YATM Logo](logo.png) YATM

YATM - Yet Another Tech Mod.

While YATM was originally made as a minecraft mod, I never did enjoy working in Java, so I ported the (incomplete) mod over to minetest and lived happily ever after.

Check each mod for it's own README on what it does.

## Requirements

* Minetest 5.4.x (optionally with LuaJIT for some mods (needed for `bit` and `ffi` modules))

## Dependencies

* [`foundation`](https://github.com/IceDragon200/mt-foundation)

* [`nokore`](https://github.com/IceDragon200/mt-nokore-mods)

## Optional

* `mesecons`

* `mobkit`

* `default`

## Tests

You may notice a tests/ directory in some of the mod directories, this uses the 'Luna' test module that I originally wrote for a love2d game.

Luna was then ported to minetest (along with the Class modules).

It's a rather simple unit test framework that runs during startup, for now tests run on startup, and usually complete within milliseconds, but this will be toggable later once everything has stabilized.

## Installation

Grab the latest release or master, master tends to be playable.

Add `yatm_core` and `yatm_oku` to your trusted_mods list in minetest's settings.

Or you can just not add them, the mods will disable certain sections and post warnings in the logs.

Some sections will have slower fallback implementations while some features are just completely impossible.

__Why does yatm_core and yatm_oku require an insecure_environment?__

yatm_core needs bit and ffi, same with yatm_oku.

yatm_core needs it for it's binary buffers which is a faster alternative to its string buffers.

These buffers are used to load binary encoded files used by some of the other mods.

The bit module is needed for bit operations in various parts of the code especially in oku which needs to perform bit manipulation.

A lua implementation is provided for the bit module and will allow the binary buffer to exist, however it will be slower than a more native version.

I can promise the worse that will happen is minetest crashes due to a reading mistake.

## Game and Modpack creators

YATM has an optional dependency called `yatm_prelude`, which is purposely not present in this codebase.

It is intended to be used to preconfigure YATM for a game or modpack, simply create a `yatm_prelude` mod in the game or modpack's mods directory and add the configuration settings in the init.lua.

As of this writing YATM doesn't really have any settings that can be preconfigured to affects its behaviour

## `yatm_prelude` Configuration

This section will be populated when there are actual options to configure.