feat (ui): add a classic (0.97) theme

.gitignore

@@ -43,6 +43,12 @@ build-linux/
 !src/bin/Data/Interface/
 !src/bin/Data/Interface/RmlUi/
 !src/bin/Data/Interface/RmlUi/**
+# The classic theme's original interface and login art (themes/classic).
+!src/bin/Data/Interface/Classic/
+!src/bin/Data/Interface/Classic/**
+!src/bin/Data/Logo/
+!src/bin/Data/Logo/Classic/
+!src/bin/Data/Logo/Classic/**
 # Item data (JSON, written by the item editor) is source-controlled.
 !src/bin/Data/Items/
 !src/bin/Data/Items/**

docs/rmlui-ui-system/theming-and-modding.md

@@ -1,8 +1,8 @@
 # Theming & Modding
 
 How to edit and select themes, use shared design tokens, and supply custom assets. The client
-ships `legacy` and `modern`, plus `legacy-inherited-test` for checking inheritance without visual
-overrides. Additional theme folders work without recompilation and can inherit an existing theme.
+ships `legacy`, `modern` and `classic` (the 0.97 interface, below), plus `legacy-inherited-test`
+for checking inheritance without visual overrides. Additional theme folders work without recompilation and can inherit an existing theme.
 A separate user/mod override layer is not implemented.
 
 ## Shared markup and theme-specific structure
@@ -118,11 +118,19 @@ RML, templates, RCSS and theme-local images use the first matching whole file. A
 stylesheet replaces its ancestor's file; rules are not automatically combined. Paths to common
 assets outside the theme folder keep their ordinary meaning.
 
-`[Tokens]`, `[Capabilities]` and `[Fonts]` inherit individual keys. A child value wins, including
+`[Tokens]`, `[Capabilities]`, `[Fonts]` and `[Stacking]` inherit individual keys. A child value wins, including
 `NativeTextSize=0` or an empty font entry. Display names stay specific to the child. Names use
 letters, digits, `_` and `-` and are normalized to lowercase. Missing ancestors, invalid names
 and inheritance cycles make a theme unavailable for selection.
 
+`[Stacking]` moves one of the theme's documents in the stacking order, when its layout makes two
+documents overlap the other way round. The classic theme puts its HUD under the windows
+(`main_frame.rml=1.95`; the lowest window is 2.0), so a window docked or dragged over the bar's
+ends covers the dragons there, as in 0.97, and its chat input over the windows and under the
+tooltips (`chat_input.rml=10.65`; tooltips are 10.69). The depths are the original windows' layer
+depths, listed in `UI/RmlBridge/RmlStackingOrder.cpp`; a document the theme does not list keeps
+its own.
+
 1. Create `src/bin/Data/Interface/RmlUi/themes/<your-theme-name>/`.
 2. Declare `Base=legacy` or `Base=modern` in `[Theme]`, or supply your own complete stylesheets.
    Every window links `base.rcss` for shared rules such as buttons, checkbox states, backdrops
@@ -339,6 +347,40 @@ families for the session, so a family loaded by an earlier theme remains availab
 a theme retries optional files; restart the client to replace a font file whose family is
 already loaded. Referencing a player's installed font does not package it with the theme.
 
+## The classic (0.97) theme
+
+`RmlTheme=classic` gives the interface of the original 0.97 client, drawn with its own art. It
+inherits `legacy` and restyles the login box, server list, character select and creation, HUD,
+inventory, character, party, NPC shop, storage, trade, Chaos Machine, guild, event entries,
+message boxes, confirmations, the Esc menus, the command window (D) and chat. The NPC menus that
+share the Esc menu's document keep legacy's look, as 0.97 has none of them. Where the Season 1 and
+2 clients, which kept the classic interface, add a part for something MuMain has, the theme draws
+it as they did instead of hiding it: on the HUD the SD column and the command window and friend
+buttons, in the character window the quest and pet buttons, in the inventory the personal shop
+button. A window 0.97 does not have follows those clients, else the closest classic window. The
+art lives outside the RmlUi tree, in `Data/Interface/Classic` and `Data/Logo/Classic`, so its file
+names cannot collide with S6 files of the same name.
+
+What changes for the player, besides the look:
+
+- **Character creation:** the class is chosen with arrows, which step through the classes the
+  client enables.
+- **World:** no map title when entering a map.
+
+The HUD model also exposes what the classic bar shows and the S6 bar does not: `party_open` /
+`guild_open` / `command_open` with `mainframe_party_click` / `mainframe_guild_click` /
+`mainframe_command_click` (the command window under the D key's rules) and their tooltips, and
+`coord_x` / `coord_y`.
+
+The character creation model has `job_previous` / `job_next`: the enabled class before and after
+the selected one, or -1, for a theme that steps through the classes with arrows
+(`charmake_select_job(job_next)`) instead of a button per class.
+
+The pet / durability HUD (`item_endurance.rml`) marks `#pets` with `.in-party` while the hero is
+in a party, so a theme can keep the pet column clear of the party list. The classic theme also
+places the pet column, the party list and the event HUDs from `--world-left` / `--world-right`, so
+they move aside when windows open, as in 0.97.
+
 ## Coordinates, scaling, and positioning — what a theme actually controls
 
 ### Scaling: a global user setting, opt-in per element

src/bin/Data/Interface/RmlUi/guild_info.rml

@@ -36,10 +36,11 @@
 		      data-style-font-size="hint_line3.text_px + 'px'">{{hint_line3.text}}</span>
 		</div>
 
-		<!-- The tabs' hit areas: the original's 56-unit columns over the top 90 units. -->
-		<div class="gi-tab-hit" id="gi_tab_hit_0" data-event-mousedown="guild_info_tab(0)"></div>
-		<div class="gi-tab-hit" id="gi_tab_hit_1" data-event-mousedown="guild_info_tab(1)"></div>
-		<div class="gi-tab-hit" id="gi_tab_hit_2" data-event-mousedown="guild_info_tab(2)"></div>
+		<!-- The tabs' hit areas: the original's 56-unit columns over the top 90 units, only with a guild,
+		     as the tabs themselves. -->
+		<div class="gi-tab-hit" id="gi_tab_hit_0" data-if="!no_guild" data-event-mousedown="guild_info_tab(0)"></div>
+		<div class="gi-tab-hit" id="gi_tab_hit_1" data-if="!no_guild" data-event-mousedown="guild_info_tab(1)"></div>
+		<div class="gi-tab-hit" id="gi_tab_hit_2" data-if="!no_guild" data-event-mousedown="guild_info_tab(2)"></div>
 		<!-- The header every tab shares. -->
 		<div class="gi-page" data-if="!no_guild">
 		<span id="gi_title" class="sharp-text gi-line"

src/bin/Data/Interface/RmlUi/item_endurance.rml

@@ -14,7 +14,7 @@
 	     the theme places the column). The hovered icon's tooltip is in window pixels at the
 	     pointer. Behind the other documents of its context (the original drew it at layer depth
 	     3.5, under the panels). Takes no pointer events: C++ hit-tests the drawn frames and icons. -->
-	<div id="pets">
+	<div id="pets" data-class-in-party="in_party">
 		<div id="pet_column">
 			<div id="arrows_row" data-if="arrows != ''">
 				<span id="arrows" class="counter-scaled-xy" data-style-font-size="text_px + 'px'"

src/bin/Data/Interface/RmlUi/npc_quest.rml

@@ -25,7 +25,8 @@
 		</div>
 		<!-- The live 3D quest-condition items, drawn by C++ beside their rows over the frame. -->
 		<img id="nq_item" class="nq-item"/>
-		<span class="sharp-text" id="title" data-style-font-size="text_px + 'px'">{{npc_name}}</span>
+		<!-- .with-quest-title lets a theme place the name by whether the quest title shows under it. -->
+		<span class="sharp-text" id="title" data-class-with-quest-title="show_quest_title" data-style-font-size="text_px + 'px'">{{npc_name}}</span>
 		<div class="sharp-text nq-quest-title" data-class-hidden="!show_quest_title" data-style-font-size="text_px + 'px'">{{quest_title}}</div>
 
 		<div class="nq-divider" data-class-hidden="!show_conditions"></div>

src/bin/Data/Interface/RmlUi/themes/classic/README.md

@@ -0,0 +1,31 @@
+# Classic theme
+
+The interface of the original 0.97 client, drawn with its own art.
+
+- **Inherits from `legacy`** (`theme.ini`, `[Theme] Base=legacy`). Ship a window's `.rcss` (or a
+  `.rml` fork) here only when restyling that window; everything else, tokens included, comes
+  from `legacy`.
+- **Art** is the original files, unconverted:
+  - `Data/Interface/Classic/` — the 0.97 client's `Data/Interface`;
+  - `Data/Interface/Classic/099b/` — classic-era files the 0.99b client adds (not in 0.97);
+  - `Data/Interface/Classic/s1/`, `s2/` — files of the Season 1 and Season 2 clients, which kept
+    the classic interface, for the parts and windows 0.97 does not have (the bar's thirds with the
+    command window and friend buttons' boxes and the SD column, the quest, pet and personal shop
+    buttons, the duel crest, the quest book, Season 1's text button, the Season 2 cash shop's
+    pieces);
+  - `Data/Logo/Classic/` — the 0.97 login box and character select art.
+- **Paths** are relative to the stylesheet: from a stylesheet here, `../../../Classic/Menu01_new.jpg`
+  and `../../../../Logo/Classic/0box.jpg`. The engine opens `.jpg` as `.OZJ` and `.tga` as `.OZT`.
+- **Sizes**: an `@spritesheet` gives each sprite its real size.
+  `tools/classic_theme/oz_texture_sizes.py ../../../Classic --recursive` lists them.
+- **Derived textures**: where 0.97 tiles or stretches a texture over a known size, the result ships
+  beside the originals (`Nis_vframe_tall`, `Message_box2_268`, `Message_box2_230`); where the
+  original drew a texture additively (its black ground vanishing), a copy with that as alpha
+  (`Progress_add`, `s1/DuelWindow_add`). All built by
+  `tools/classic_theme/make_classic_derived_textures.py`.
+- **C++**: the HUD's extra parts are bound by `UI/HUD/MainFrameExtras`.
+
+Comments in each stylesheet name the 0.97 client function it follows (its address in `main.exe`)
+and the positions in the original 640x480 frame. A window 0.97 does not have follows the Season 1
+or Season 2 client when that client has it (the function's address in that client's `main.exe`),
+else it takes the parts of the closest classic window.

src/bin/Data/Interface/RmlUi/themes/classic/battle_soccer_score.rcss

@@ -0,0 +1,64 @@
+/* Classic theme for the guild war / battle soccer score (CBattleSoccerScore). The 0.97 client's
+   (004bc220): no frame, at the top of the area the open windows leave free, its x 20
+   left of that area's centre (the classic workspace centres the 640 frame on it, so x 300): two
+   rows at y 4 and 19, each the guild mark (8 x 8) at 0, the score at 13 and the name at 30, bold on
+   a black 50% box, red (255, 60, 0) or blue (0, 150, 255). Legacy's rules first, then the classic
+   ones. */
+
+/* Legacy theme for CBattleSoccerScore, reproducing the original's RenderBackImage()/
+   RenderContents(): the 131 x 70 figure-ground back, then two lines from (x + 30, y + 33), 22 apart:
+   the score, the guild mark at + 21 (8 x 8) and the name at + 33, in the bold font on a 50% black
+   text box (SetBgColor(0, 0, 0, 128)), red (255, 60, 0) or blue (0, 150, 255). Reference px relative
+   to the window's top-left, under .screen's W/640 x H/480 stretch (see battle_soccer_score.rml). */
+
+@spritesheet bss-back-sheet { src: "../../../newui_Figure_ground.tga"; bss-back: 0px 0px 131px 70px; }
+
+body { pointer-events: none; }
+
+.screen {
+	position: absolute;
+	left: 0;
+	top: 0;
+	width: 640px;
+	height: 480px;
+	transform-origin: left top;
+	pointer-events: none;
+}
+
+#panel { position: absolute; width: 131px; height: 70px; font-family: "token(font-body)"; }
+#back { position: absolute; left: 0; top: 0; width: 131px; height: 70px; decorator: image(bss-back); }
+
+.team { display: block; position: absolute; left: 30px; width: 100px; height: 8px; }
+.team-text {
+	display: block;
+	position: absolute;
+	top: 0;
+	transform-origin: left top;
+	white-space: nowrap;
+	font-weight: bold;
+	color: #0096ff;
+	background-color: #00000080;
+}
+.team.red .team-text { color: #ff3c00; }
+.team-score { left: 0; }
+.team-name { left: 33px; }
+
+.mark { position: absolute; left: 21px; top: 0; width: 8px; height: 8px; }
+.mark-cell { display: block; float: left; width: 1px; height: 1px; }
+
+/* RenderContents()'s own two rows. The container takes no space. */
+.teams { position: static; }
+.team:nth-child(1) { top: 33px; }
+.team:nth-child(2) { top: 55px; }
+
+/* The HUD takes no pointer events where it is placed (base.rcss gives a placed panel them). */
+#panel.slot-placed { pointer-events: none; }
+
+/* --- Classic ---------------------------------------------------------------------------------- */
+#back { display: none; }
+.team { left: 0; }
+.team:nth-child(1) { top: 4px; }
+.team:nth-child(2) { top: 19px; }
+.mark { left: 0; }
+.team-score { left: 13px; }
+.team-name { left: 30px; }

src/bin/Data/Interface/RmlUi/themes/classic/blood_castle_enter.rcss

@@ -0,0 +1,8 @@
+/* Classic (0.97) Blood Castle entry. 0.97: "Messenger of Archangel", the description from y 64,
+   and six plates 140x33 from y 170, 40 apart, tinted (0.7, 0.7, 0.9), labelled in pale blue
+   (190, 220, 255). MuMain: the description from y 46 to 156, its eight bands from y 160 to 388,
+   above the Close at 395; more content scrolls. */
+.entry-lines { top: 46px; height: calc(110px * var(--root-scale)); }
+.entry-buttons { top: 160px; height: calc(228px * var(--root-scale)); }
+.entry-btn.enabled .entry-btn-art { image-color: #b3b3e6; }
+.entry-btn.enabled .entry-label { color: rgb(190, 220, 255); }

src/bin/Data/Interface/RmlUi/themes/classic/buff_strip.rcss

@@ -0,0 +1,3 @@
+/* Classic (0.97): no buff icons -- 0.97 showed buffs only as their effects on the character. */
+
+#strip_slot, #panel { display: none; }