Titles: the later client's title system (name-line title, option toggles, title window)

Open
#3,502 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
12/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
go, typescript
Domain
backend, game-dev

Research direction

Start from the disassembly notes in the issue, which point to a Binary Ninja database for build 1696 that a newcomer likely cannot access, and from overhead-layout.ts, the port's existing name-line layout. The unresolved parts are the title and achievement tables in Media.pk2 and the spawn and select packets that carry the title id, so the scope needs a maintainer decision first. Done means the title id rides spawn data, the name line prints through the title format, both option toggles work, and the title window posts the chat notice.

Written by the indexing model from the issue text.

Description

area: client area: server enhancement priority: high

Split from #3256 (Title Manager and Achievements). The later native client, build 1696, has a full title system. That turns these two epic items from port-only into later-native features.

What the later client does (disassembly read, build 1696 database)

Behaviour Evidence Checked by
A character's title is printed inside the name line: the title's text is a format string that the name prints through, so with no title the format is "%s" CICharactor_BuildDisplayNameWithTitle 0x9689B0: title id at this+0x910 to GlobalDataManager_FindTitleById 0x877CA0, record +0x28 to the text manager, then WString_FormatBuffer(buf, 0x200, titleFormat, name) disassembly read
Two game options hide titles: your own (config +0x1F) and other players' (config +0x20) same function; option labels UIIT_STT_CHAR_TITLE_SIGN / UIIT_STT_OTHER_TITLE_SIGN in CIFOptionGame_OnCreate 0xB16060 disassembly read
Chat prints a titled sender as <Title>Name (UIIT_STT_TITLE_TITLE + "<%s>%s") with line colour 0xFFFFFF00 CIFChatViewer_FormatLinePrefix 0xBFE5B0 disassembly read
Choosing a title posts <Title> to chat CIFTitle_PostCurrentTitleNotice 0xE31840 disassembly read
A title window with categories 0-4, the title name, use time, feat and "untitled" (UIIT_STT_TITLE_CATEGORY_0..4, _NAME, _NAME2, _USE_TIME, _FEAT, _UNTITLE), plus achievement rewards that grant titles (UIIT_STT_ACHIEVE_UI_COMPLETE_REWARD) CIFTitle_BuildTitleTooltip 0xE2D180, CIFAchievement_BuildRewardText 0xE2A400 disassembly read
The guild row is unchanged from v1.150: [Guild * Grant(Officer)], with the officer title only while the guild owns a fortress or fortress-war revival is active CICUser_RenderOverheadBoardPass 0x969A40 = v1.150 0x86B95B disassembly read; the port already matches (overhead-layout.ts)

These functions are labelled in the build 1696 Binary Ninja database.

Still to read

  • The title and achievement tables in that client's Media.pk2 (the title format strings and the categories): not extracted yet.
  • The wire: how a spawn and the select packet carry this+0x910, and the v1.188 server rule for granting titles.

Done when

The title id rides the spawn data. The name line prints through the title format, and both option toggles work. The title window lists owned titles, and choosing one posts the chat notice. The port's Contributor title (#3358, #3497) is drawn the same way, as a title on the name line.

Dominant language
Go
Stars
97
Forks
61
Avg merge
4h 14m
Merged PRs (30d)
913

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from opensro-dev/opensro

All issues in opensro-dev/opensro

Similar issues

More Go issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.