Skip to content

docs: add the 1.11 guides - #27

Merged
Kheartz merged 33 commits into
arcane-mp:mainfrom
Kheartz:1.11
Nov 5, 2026
Merged

Kheartz merged 33 commits into
arcane-mp:mainfrom
Kheartz:1.11

Conversation

@Kheartz

@Kheartz Kheartz commented Nov 4, 2026

Copy link
Copy Markdown
Member

Guides for what changed in the mod from 1.10.0 to 1.11.0, one commit per guide or update. Activities (#24) and post-processing (#25) are already on main, and spell composition (#23) waits for a later release.

New guides

  • Combat arenas: Arenas on the server and client, the arena events, and the arena reward policy
  • Vivarium beasts: beasts in a Room of Requirement layout, Sanctuary.beasts / addBeast, vivariumMove, feeding, byproducts and breeding, and their events
  • Text labels: TextLabel and every TextLabelOptions field, markup, styles, attaching, and who sees a label
  • Crowds: the client's population exclusions, density and scheduledEntities, with setAmbientPopulation and exemptions, which no guide covered
  • Field Guide progress: FieldGuide snapshots and restores, and the two Field Guide client events

Updated

  • NPCs, Moving NPCs and creatures, Beasts and characters:
    • the NPC.create options form, used in every sample now that the positional form is deprecated
    • follow for NPCs and characters, and the "targetGone" end reason
    • character looks, clips, wands and props
  • Rooms and unlocks: layout version 2 and its beasts, and the walls an opened expansion or biome loses. Catching beasts points at vivarium moves
  • Travel (Floo flames and playerFastTravelUnlocked), Join and spawn (join-link tickets, snapped teleports), Authority (discordName), Appearance (pronoun, #rrggbb hair, animal-form coat and sex), Inventory (gear capacity, useTool), Walking players (gravity holds in the flight sample)
  • Loot (World.setLootPolicy, LootSpots, take reach), Time and weather (Great Hall banners, client sky override), Doors (Doors.allowUnlock, common rooms), Objects and effects (effect streamRange / drawDistance)
  • Camera (distance scale), Brooms and mounts (free look, crosshair, aiming from a broom), Audio (dialogue policy and dialogueMuted), Map markers (MapIcons), Avatar preview (backdrop.match), Keys and menus (dodge and gravity holds, spell sets), PvP rules (curses: "crosshair"), Hits and defeat (client cooldowns), HUD (pointer to text labels)
  • The events table gains every 1.11 event. It also gains doorUnlocked and playerFastTravelRequest, which were missing from it. The overview lists the new guides

For review

  • The 1.11 contract declares every field of SanctuaryBeast required, though load needs only vivarium and species and addBeast only species. Two vivarium samples are fenced jsx to skip type-checking until the mod marks them optional, as the 1.10 guides did. The new AvatarPreview sample is fenced jsx for the same reason.
  • Aiming from a broom documents Spells.broomCastTry(slot, 5), the only way to cast at the crosshair. It isn't _-prefixed, but its aim mode is a bare number and it returns a diagnostic string, so confirm it is meant to be public, or that paragraph should go.
  • TextLabel has no map-aware setVirtualWorld(world, map), unlike NPCs, objects and effects. So a label that isn't attached is only seen in Overland, or from the global world. The guide says so and suggests attaching the label to an entity. Possibly a mod gap.

Checked against the published 1.11.0 contract:

  • docs:check passes (283 samples in 63 guides)
  • the build succeeds
  • docs:links finds every link and anchor on 64 pages
  • git diff --check is clean

@Kheartz
Kheartz merged commit 89055d8 into arcane-mp:main Nov 5, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant