Awakening Client Mod

The Awakening Client mod is open source, and the project is hosted on Bitbucket:

https://bitbucket.org/spirangle-studio/awakening-client/

Download here:

https://awakening.spirangle.net/download/awakening-client-1.0.0.zip

Options

These live in awakening.properties.

Turning showExtraTooltips off does not remove field, flower, tree, or surface-slope text. Those are not gated on that flag.

Reading the ground

Hover text is added to the main body of a tile. A tile border is labelled Tile border, and a corner Tile corner, instead of the tile’s own name. Extra text is skill-gated. Each further tile asks for another 15 points. The checks are strict: the skill must be greater than the threshold, not equal to it.

Slopes

Shown only while the active item is one that already shows slopes. Digging is the skill.

On the body of the tile, the only addition is (flat), and only when all four corners are the same height. A sloped tile body keeps its ordinary name. There is no slope number there.

On a border or a corner the suffix is (flat), or (N slope up) / (N slope down). N is the height difference between the two corners of that edge, multiplied by 10 and rounded. Up and down are from the side of the edge you are standing on: at the low side it says up, at the high side it says down.

Digging required is (distance − 1) × 15. On the tile itself this is always met. One tile out needs any digging above 0. Two tiles out needs more than 15. Three needs more than 30.

Fields

Farming, and only the main tile of a field. If the field has not aged, the crop reads Seeds. Otherwise it is the crop name. If the field has not been tended, the text adds , untended. That part is not on a higher skill check.

The growth stage is included on the tile you are reading at distance 0, and further out only if farming clears the next band.

• Crop name: farming greater than distance × 15.
• Growth stage as well: farming greater than (distance + 1) × 15, or distance 0.

So at farming 20 the tile under you shows crop, stage, and tended state. One tile out shows the crop, and untended if it is, but not the stage. Two tiles out shows nothing extra.

Flowers

Gardening, main tile, grass only, and only if that grass has a flower. The flower name is added when gardening is greater than distance × 15. Plain grass is unchanged.

Trees and bushes

Forestry, main tile. The growth stage is shown when forestry is greater than (distance + 1) × 15. Standing on the tile already needs more than 15. One tile out needs more than 30.

On a lingonberry bush, the words , sprouting are removed from that stage name if they are present.

, harvestable is added only when all of these are true: the tree is a normal tree on the newer tile data, its age is past young-four and not yet overaged, and the harvestable bit on the tile is set. It is not a guess from the age alone.

Caves

Floor and roof keep their own name. With a pickaxe activated, and mining high enough, a level floor or roof gains (flat). A sloped floor or roof does not gain a number. The range here is the greater of the north-south and east-west distance, and the next tile out counts the same as the one you are on. Mining must be greater than 15 for that near range, then another 15 for each tile beyond it.

A cave corner is labelled Tile corner. With extra tooltips on, and mining greater than (distance + 1) × 15, it also shows the raw difference between ceiling and floor at that tile, in parentheses. That number is not scaled the way surface slopes are.

A cave border is labelled Tile border. The slope suffix is added if you are holding an item whose name contains pickaxe, concrete, trowel, mallet, or hammer, and mining clears the same (distance + 1) × 15 check. The suffix is (flat) or (N slope up) / (N slope down), using the adjusted floor height. With extra tooltips on, the ceiling is described the same way. If floor and ceiling read the same, it is shown once. If they differ, both are shown, floor first. With extra tooltips off, only the floor is shown.

Creatures

The hover name stays the creature’s name. Two additions are possible.

If it is not an item and its health is under 100%, a health band is appended. These words are bands of remaining health. They are not wound types. Bleeding does not mean the creature has a bleeding wound. Dying does not mean it is down.

A full-health creature has no health word. A creature at 90% is Healthy. The word means damaged, but not below 85%.

With extra tooltips on, a model whose name marks it male or female gets that sex. Horses and foals also get a coat, read from the model name. Sex and coat are one parenthesis: female, chestnut. The health band, if any, is a second parenthesis.

Hell-horse coats, as labelled: cinder, envious, shadow, pestilential, nightshade, incandescent, molten. Anything else in that set is labelled Ash.

Other horse and foal coats, as labelled: brown, skewbald pinto, bold buckskin, black silver, appaloosa, chestnut, gold, black, white, piebald pinto, blood bay, ebony black. Anything else is labelled Gray.

The gold buckskin model is the one labelled bold buckskin. That is the string the client shows. Other creatures are not given a coat. With extra tooltips off, sex and coat disappear; the health band does not.

Tool belt

With autoSaveToolBelt on, dropping an item onto the tool belt saves that belt’s arrangement immediately, to the belt the client already treats as the current one. Rearranging without a drop is not what this hook saves.

Window

Off by default. With useWindowedFullscreenSizeAndPosition on, windowed fullscreen uses the width and height from the client’s screen settings, placed at the origin. If both width and height are 0, the maximized case, the mod leaves the vanilla size alone.

Updates, and what the server is told

With autoUpdate on, startup asks awakening.spirangle.net which client mods are current. Installed mod jars are compared with that list. If one does not match, the client copies the Awakening mod aside, starts an updater, and exits. The game does not keep running while this happens.

If the updater installs anything, it opens a window titled Client Mod Update, with the sunrise banner, and the text: “Your client mods have been updated, please restart your Wurm Unlimited client.” Restart the client after that. If the site cannot be reached, or nothing is newer, play continues on the mods already installed. Setting autoUpdate to false skips the replacement; the check itself still runs at startup.

When the world connection comes up, the mod sends the server the names of the installed client mods. That is how the server can tell the Awakening client mod is present. It is not a gameplay message, and it does not change the character.

What it will not do

It will not show a slope number on the body of a surface tile, or on a cave floor or roof that is not flat. It will not show crop, flower, or tree text past the skill band for that distance, and it will not show a flower on grass that has none. It will not call a full-health creature Healthy, and it will not describe wounds, only the health band. It will not save the tool belt except on a drop onto the belt. It will not resize the window unless that option is turned on, and it will not touch a maximized window. It does not change the server.