TreeRibbons

TreeRibbons

Tie a red ribbon round a tree you want to keep, and nothing can harm it: not axes, creatures, falling trees, fire or explosions.

At a glance

• Clear land without losing the trees you meant to keep. A ribboned tree takes no damage from anything: stray swings, trolls, a felled neighbour falling the wrong way or a forest fire.
• Cheap to make. 1 Leather scraps and 2 Raspberries at a workbench.
• Aim, then tie. The ribbon shows on the trunk where you look; left click ties it there.
• From saplings to giants. Ribbons go on standing trees, small trees, stumps, old fallen logs and saplings. A sapling keeps its ribbon when it grows up.
• Easy to take back. Shift + E unties the ribbon and returns it.
• Shared and saved. Every player sees the ribbons, and they last through logouts and server restarts.

Needs Jotunn. Everyone on the server needs TreeRibbons, the host included.

Features

• Complete protection. A ribboned tree takes no damage from axes and other weapons, arrows, creatures, other trees falling on it, fire, explosions or other mods. A swing at it stops without chips or axe wear, and fire doesn't catch on it.
• A ribbon that fits. A thin red band, the width of tape, wrapped tight round the trunk where you tied it and following the bark, with a knot and two short hanging ends. The same size on every tree, from saplings to giants, and it sways with the tree in the wind.
• Wards respected. Tying and untying needs the permission of any ward covering the tree. Optionally, only the player who tied a ribbon (or an admin) can take it off.
• A marker, if you prefer. With protection turned off, ribbons only mark trees; a ribboned tree can be cut down and drops its ribbon.

How to use

The Tree ribbon is made at a Workbench. Default cost: 1 Leather scraps and 2 Raspberries.

1. Put a Tree ribbon on your hotbar.
2. Look at a tree within reach and press the ribbon's hotbar key. The ribbon appears on the trunk where you look.
3. Aim up or down the trunk to place it, then left click. The ribbon is tied there and one ribbon is used. Right click puts it away instead. Aiming stops by itself if you look away from trees for 6 seconds, walk away, take something else in hand, or sit down.
4. Look at the tree: its hover text says it is tied with a ribbon, and by whom.
5. To take the ribbon off, look at the tree and press Shift + E. The ribbon goes back to your inventory, or drops at your feet when the inventory is full.

| Key | Action | |---|---| | The ribbon's hotbar key (1-8), looking at a tree | Show the ribbon on the trunk, to aim it | | Left click, while aiming | Tie the ribbon where it shows | | Right click, while aiming | Put the ribbon away | | Shift + E on a ribboned tree | Take the ribbon off |

Hitting a ribboned tree shows "This tree has a ribbon; it can't be cut", at most every 3 seconds.

Configuration

Settings are in BepInEx/config/anwo.TreeRibbons.cfg and can be changed in game with a configuration manager.

1 - Ribbons

| Setting | Default | Scope | Description | |---|---|---|---| | Tree ribbon recipe | LeatherScraps:1,Raspberry:2 | Server | Cost of a ribbon, as Item:Amount pairs with prefab names (as in the game's files); applies without a restart | | Ribboned trees cannot be harmed | true | Server | Ribboned trees take no damage from anything. Off: ribbons only mark trees; a ribboned tree can be cut down and drops its ribbon | | Small trees, stumps and saplings | true | Server | Ribbons also go on small trees, stumps, old logs and saplings (a sapling's ribbon stays on the grown tree). Off: standing trees only; ribbons already tied keep working | | Who can take ribbons off | WardAccess | Server | WardAccess: anyone a ward there lets in. WhoTiedIt: only the player who tied it, or an admin, still with the ward's permission |

2 - Display

| Setting | Default | Scope | Description | |---|---|---|---| | Show ribbons | true | Client | Draws the ribbons on the trees. Off: none are drawn on your screen; the trees stay protected | | Message when you hit one | true | Client | A short message when you hit a ribboned tree, at most every 3 seconds | | Ribbons sway with the tree | true | Client | A ribbon moves with its trunk as the wind sways the tree. Off: ribbons stay still |

3 - Tying

| Setting | Default | Scope | Description | |---|---|---|---| | Aim the ribbon | true | Client | The ribbon shows on the trunk where you look; left click ties it, right click puts it away. Off: tied straight away at chest height |

Multiplayer

• Everyone needs TreeRibbons, the host or dedicated server included. Jotunn refuses a player without it, and the first two parts of the version must match (any 1.0.x with any 1.0.x).
• The host sets the rules. Every Server setting comes from the host or dedicated server, and a changed recipe reaches every player without a restart. Display and tying settings are each player's own.
• Everyone sees the same ribbons. A ribbon is saved with the tree in the world, so all players see it and it lasts through logouts and restarts. A hit on a ribboned tree is stopped on the attacker's game and again on the game that runs the tree.

Compatibility

• Works on every standing tree the game knows as a tree, including trees added by other mods that use the game's tree type.
• Mods that add their own hover text to trees may hide the ribbon's line in it; the protection is not affected.
• Removing an object outright (world-editing mods, admin removal commands) is not damage, and can still remove a ribboned standing tree.

Patches: tree and small-tree damage (TreeBase, Destructible), the melee hit list (Attack.AddHitPoint), Fire.DoDamage, Cinder.CanBurn, Plant.Grow, the hover text of trees and saplings, and Player.SetControls (only while you aim a ribbon, for its left and right click).

Uninstalling