Ziggfreed's CommonLib

The shared library behind Ziggfreed's Hytale mods. It runs their menus, quests, shops, titles and seasonal events, so install it whenever one of them asks for it.

MMO Skill Tree, RPG Stations, MMO Mob Scaling, Seasons of Orbis, Kweebec Nightmare and the MMO Skill Tree content packs all need it. Parties, Records, the quest book and the Claims tab work with CommonLib alone, but most of what you see comes from the mods and packs built on it.

What you see in game

• The Objective Book, your menu for quests, achievements, the Almanac, Records, reputation and Claims. Craft it by hand from leather and plant fiber, or type /ziggui.
• A Claims tab where the rewards you earn wait until you take them, so a full bag never costs you one, and nothing on it runs out. A boss you beat leaves a chest where it fell with your share in it, a mod or pack can have a rare kill or a rare block drop one too, and whatever you leave in a chest waits on the tab. Every card in a chest says where its reward came from, and a rolled reward shows how rare it was. Claim something and a notice lists everything you got.
• Dungeons, when a mod or pack adds one, such as the Horseman's Graveyard in Seasons of Orbis. Go in through a block, a character or a line in a conversation, and your party gets an area of its own. Clear it and a results screen shows your time, with a reward to claim. Die in one and you keep your items, though your gear still loses some durability.
• Parties. Type /zigparty to start one and invite up to four players who are online. It works with CommonLib alone.
• Records ranks every player by numbers like Mobs Defeated, Blocks Broken and Playtime, for this week, this month, each season and all time. On the Bosses tab, pick a boss to see its wins and fastest times, and who beat it first. The Dungeons tab ranks the runs you start, clear and fail, and each dungeon's fastest clear. The game's own Deepworks counts too.
• Titles. Earn them from quests and achievements, then pick one in Settings, under Title, to show beside your name.
• Reputation with characters and factions, from Hated to Exalted. A bar fills as you earn it, and a notice marks each new rank. Gear can make you earn it faster.
• The shop, bounty board and conversation screens that open when you press F on a trader, a board or a character.
• A bounty board opens on the same quest page as the characters who give out work, with its wallets and a countdown to new contracts.
• Quest lists that show what kind each quest is, with the main quests first, and quest items that drop only for you while you're on that step.
• Your boosts on the buff bar, each with a ring that runs down. A gear set's bonus shows there too while you wear it.
• Damage resistance for gear from the mods and packs that use it: Fire Resistance, Ice Resistance and the rest each cut the damage you take of their type, up to 80%.
• An Almanac page for each seasonal event, with your keepsakes and tallies.
• A Settings tab to hide or move the quest tracker and pick how many notices you see. /zighud hide hides them all at once.
• Every screen in nine languages: English, German, Spanish, French, Hungarian, Italian, Brazilian Portuguese, Russian and Turkish.

Install

Drop the CommonLib jar into your server's Mods/ folder, next to the mod that needs it. If a mod asks for a minimum version, use that one or newer. Hytale loads CommonLib first, so there is no load order to manage.

This version needs a Hytale Update 7 server. On Update 6, use 2.2.0.

For server owners

• CommonLib's settings live in mods/ziggfreedcommon/. Switch a seasonal event off in calendar.json, show titles in chat with "$Chat": true in titles.json, turn Records off with "$Enabled": false in stats.json, switch a dungeon off or let more players in with dungeons.json, or change what a reward chest holds and how long it stays with reward-chests.json.
• The admin commands, such as /zigprogress, /zigcommerce, /zignpc, /zigcalendar, /zigdungeon and /zigclaims, need a permission nobody holds until you grant it.

For mod authors

CommonLib depends on the Hytale server and nothing else. Add it as a compileOnly dependency and list Ziggfreed:ZiggfreedCommon in your manifest's dependencies so it loads first. Quests, achievements, conversations, shops, boards, placed characters, calendar events, reputations, gear sets, loot, reward chests, boss fights and dungeons are plain JSON in your asset pack, with no Java needed, and the Asset Editor knows every one of them. Start with the CommonLib docs.

Patch notes for every version are on GitHub.

Made by Ziggfreed / Wintergreen Solutions.