From ab2f6c89120dafdeff53d2a89962db8dd3178211 Mon Sep 17 00:00:00 2001 From: Claude Date: Sun, 4 Oct 2026 20:42:30 +0000 Subject: [PATCH] docs: README opening shows the full feature set at a glance Co-Authored-By: Claude Sonnet 5.5 Claude-Session: https://claude.ai/code/session_013YMgYLeDK1ax5ei4swLJSo --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6b55d24..6cc8e36 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,28 @@ # src2mc -Convert Source Engine maps (`.bsp`) into Minecraft 1.21.1, so that recreating a -game's geometry does not start with days of manual blocking-out. +Bring Source Engine maps (`.bsp`) into Minecraft 1.21.1 -- not just their +shape, but how they look, sound and behave -- so that recreating a game does +not start with days of manual blocking-out. Built for recreating the Half-Life 2 universe (Half-Life 2, **Entropy: Zero** and **Entropy: Zero 2**). Portal, Portal 2 and INFRA convert as well, and are the current in-game test maps. +**At a glance** -- a Rust converter plus a NeoForge companion mod that give you: + +| | | +|---|---| +| **Geometry** | Exact Source surfaces drawn on ordinary, editable blocks; sub-block (1/16) collision; displacement terrain | +| **Looks** | Real Source textures (own atlas, mipmaps), every prop as its real mesh with skins and tints, Minecraft lighting, Iris shaderpacks | +| **Performance** | Source's PVS, frustum and GPU occlusion culling, batched props, threaded mesh building | +| **Sound** | Soundscapes, ambient sounds and per-material footsteps, re-encoded to Ogg; captions | +| **Logic** | Source's entity I/O on the server: triggers, buttons, doors, relays, timers, level changes, `point_template`, scripted text and screen effects | +| **Motion** | Doors, lifts, trains and conveyors as Sable sub-levels you can ride; animated props | +| **Input** | BSP v19/20/21/22, loose files or inside VPKs; in-game tested on Portal, Portal 2 and INFRA maps | +| **Scale** | ~66k lines (Rust converter, Java mod), 600+ Rust tests, campaigns of many maps in one bundle | + +Not yet: VScript, breakable movers, `.phy` prop collision. + There are two ways to get a map into Minecraft: - **The companion mod (current).** `src2mc mod export` writes one campaign