Go to file

Lars Mueller 67263c0fd8 Code quality: use new modlib functionality		2020-07-30 00:07:26 +02:00
textures	Optimize images	2020-05-24 13:09:58 +02:00
Readme.md	rolling-3	2020-02-13 20:33:43 +01:00
default_config.json	rolling-2	2020-02-13 11:16:34 +01:00
init.lua	Code quality: use new modlib functionality	2020-07-30 00:07:26 +02:00
main.lua	Set timer on_remove = on_complete to comply with hud_timers breaking changes	2020-07-01 16:48:40 +02:00
mod.conf	rolling-2	2020-02-13 11:16:34 +01:00
settingtypes.txt	Add autogenerated settingtypes	2020-06-02 23:08:13 +02:00

Readme.md

Magic Potions (`magic_potions`)

Magic potions which grant the player temporary effects.

About

Depends on the latest modlib and hud_timers.

Code licensed under the MIT license. Media license is CC0. Written by Lars Mueller alias LMD or appguru(eu).

Screenshots

Setup

Install the mod like any other, using git clone https://github.com/appgurueu/magic_potions.git or installing via ContentDB & the in-game content manager. Enable it, modlib & hud_timers and you're ready to enjoy some potions!

Features

There are 3 levels of strength, from minor (weak) over ordinary (medium) to strong (best).

5 different potion types provide flying (antigravity), jumping (higher), (running) speed, healing (regeneration) and air (breathing, breath regen).

This makes for a total of 15 colorful potions. All effects are lost on death, and you can only use 3 at a time. They all have limited durations.

Configuration

Locations

JSON Configuration: <worldpath>/config/magic_potions.json

Text Logs (none): <worldpath>/logs/magic_potions/<date>.json

Readme (this): <modpath/gamepath>/magic_potions/Readme.md

Default Configuration

Located under <modpath/gamepath>/magic_potions/default_config.json

{
  "tiers": {
    "minor": 3,
    "ordinary": 5,
    "strong": 7
  },
  "max_in_use": 3
}

Settings

`tiers`

Key-value lookup, keys are tier names ("minor", "ordinary" and "strong") and values are strength (number > 0 and <= 7)

`max_in_use`

How many potions can be used at a time. Number > 0 and < 10.

API

Mostly self-documenting code. Mod namespace is magic_potions, containing all variables & functions.