Fogtools PLUGIN

# FogTools Plugin

Server plugin for [FogTools]https://www.curseforge.com/minecraft/mc-mods/fogtools Use it to send custom fogs, gradients and auroras to players on your server, and to set automatic fogs and auroras per biome.

**Players need the FogTools mod installed to see the fogs and auroras.** Players without the mod can still join and play normally.

---

## What's new in 1.5.1

- **Biome auroras**: players get an aurora automatically when they enter a biome, and it fades out when they leave
- A biome can now have **a fog, an aurora or both**
- `/fogtoolsplugin aurora clear` brings back the biome aurora if the player is in a biome that has one
- `/fogtoolsplugin biome list` now shows fogs and auroras
- The FogTools mod is now available for **Fabric, Forge and NeoForge**

---

## Features

- Send fogs to **every player (@a)** or to **specific players**
- Solid fogs, gradients with custom rotation, animated colors and translucent NONE color
- **Paste fogs** created in the FogTools editor with a single command
- **Auroras** in the sky for any player
- **Biome fogs and auroras**: players get them automatically when they enter a biome, and they fade out when they leave
- Works with **custom and datapack biomes**. Just type the exact biome id, even if it does not show up in tab completion.
- Smooth transitions between fogs and auroras
- Compatible with **Minecraft 1.20.1 - 26.2**

---

## Permissions

- `fogtools.admin`: use all `/fogtoolsplugin` commands (default: OP)

---

## Commands

Targets can be a player name, @a, @p, @r or @s. Fade times are in ticks (20 ticks = 1 second).

### Fog

- `/fogtoolsplugin set `: single-color fog
- `/fogtoolsplugin gradient set

<center>`: 3-color gradient fog
- `/fogtoolsplugin paste `: applies a fog copied from the FogTools editor
- `/fogtoolsplugin clear `: removes the fog with a smooth fade

 

### Auroras

- `/fogtoolsplugin aurora set [height] [intensity] [speed] [fadeIn] [fadeOut]`: creates an aurora. Everything after the colors is optional.
- `/fogtoolsplugin aurora paste `: applies an aurora from text
- `/fogtoolsplugin aurora clear `: removes the aurora (the biome aurora comes back if there is one)

### Biome fogs and auroras

- `/fogtoolsplugin biome set `: single-color fog for a biome
- `/fogtoolsplugin biome gradient

<center>`: gradient fog for a biome
- `/fogtoolsplugin biome paste `: pasted fog for a biome
- `/fogtoolsplugin biome clear `: removes a biome's fog
- `/fogtoolsplugin biome aurora set [height] [intensity] [speed] [fadeIn] [fadeOut]`: aurora for a biome. Everything after the colors is optional.
- `/fogtoolsplugin biome aurora paste `: pasted aurora for a biome
- `/fogtoolsplugin biome aurora clear `: removes a biome's aurora
- `/fogtoolsplugin biome list`: lists every biome with a fog or an aurora

 

Biome fogs and auroras are saved in `plugins/FogToolsPlugin/biome-fogs.yml`. Biomes can be written as plains, minecraft:plains or a custom id like terralith:moonlight_grove.

---

## Arguments

- **radius**: how far the fog starts
- **density**: 0 to 1
- **color**: a color name (RED, GOLD, AQUA…), a HEX like FF5500, a HEX with alpha like 80FF5500, or NONE
- **sky**: true to also color the sky, false for the fog only
- **opacity**: 0 to 1
- **rotation**: radial (top to bottom), lineal (left to right) or custom (for example custom45)
- **colors** (aurora): joined with + and no spaces, for example GREEN+AQUA+PURPLE
- **height** (aurora): 0 to 80
- **intensity** (aurora): 0 to 1
- **speed** (aurora): 0 to 10

---

## Examples

```
/fogtoolsplugin set @a 100 1 GOLD true 0.6 40 40
/fogtoolsplugin gradient set Steve radial 100 1 GOLD ORANGE BLACK false 1 50 50
/fogtoolsplugin gradient set @a custom45 150 0.8 PINK NONE BLUE true 1 40 40
/fogtoolsplugin paste @a {(radius:200,density:0.8,rotation:radial,colors:[RED@0,NONE@0.5,BLUE@1],sky:false,opacity:1,fadein:40,fadeout:40)}
/fogtoolsplugin aurora set @a GREEN+AQUA+PURPLE
/fogtoolsplugin biome gradient minecraft:dark_forest radial 80 1 BLACK PURPLE BLACK true 0.8 60 60
/fogtoolsplugin biome set terralith:moonlight_grove 120 0.7 AQUA true 0.5 40 40
/fogtoolsplugin biome aurora set minecraft:snowy_plains GREEN+AQUA+PURPLE
/fogtoolsplugin biome aurora set terralith:moonlight_grove PINK+PURPLE+BLUE 30 0.8 1 60 60
```

---

## Tips

- Create your fog in the FogTools editor (press **G** in game), copy it and use it with `/fogtoolsplugin paste`.
- Minecraft chat only allows 256 characters. For long fogs, run the command from the **server console** or a **command block**.
- Auroras are easiest to see at night.

---

## Compatibility

- Paper 1.20.1 - 26.2
- Requires the [FogTools]https://www.curseforge.com/minecraft/mc-mods/fogtools mod on the client (Fabric, Forge or NeoForge)

</center></center>