README file from
GithubLancer Companion
Lancer-OS is a comprehensive suite designed specifically for Game Masters running the Lancer RPG in Obsidian. This is the Companion Plugin that provides powerful tracking and importing features.
[!NOTE] Companion Theme: This plugin is designed to be used alongside the Lancer-OS Obsidian Theme, which transforms your standard markdown vault into a fully functional, dark sci-fi COMP/CON style terminal!
🚀 Features
1. Glossary & Status Tooltips
Never look up status effects during combat again. The plugin automatically scans your notes for official Lancer keywords (e.g., PRONE, STUNNED, SHREDDED, INVISIBLE).
- Keywords are subtly highlighted in Reading View.
- Hover over them to instantly see the full rule definition in a slick UNION_OS tooltip!
2. Integrated Dice Roller
Roll dice directly inside your notes without switching to another app.
- Syntax:
[Roll: 1d20+2]or[Roll: 2d6] - Click the button to roll, and the result (and math) is displayed inline instantly.
3. Advanced Encounter & Combat Tracker (V2)
A dedicated right-sidebar view that tracks all characters in your scene and manages combat resources directly within Obsidian!
- Persistent State: The tracker state persists across Obsidian tabs. Once you hit
Start Combat, the tracker securely locks to your encounter file. - Multiple Instances: Deploy multiples of the same NPC. They will automatically be assigned alphabetic suffixes (e.g., Assault A, Assault B).
- NPC Templates: Apply official Lancer templates directly in the tracker via a dropdown. Select
Gruntand watch the HP scale down to 1. SelectEliteorUltraand receive bonus Structure and Stress! - Interactive Stat Grid: Each combatant gets a gorgeous, interactive mini-grid. Manage their HP, Structure (STR), Stress (STRS), and Heat (HEAT) dynamically with dedicated
+and-buttons. - Dynamic Tier Scaling: Click the [T1] [T2] [T3] buttons inside the tracker to instantly scale a Mech's stats (Armor, Evasion, etc.) mid-combat. Max HP adjusts dynamically while preserving current damage!
4. Automated PC & LCP Importers
Bridging the gap between COMP/CON and Obsidian with powerful data extractors.
- NPC LCP Importer: Upload
.lcpfiles via an intuitive UI menu. Selectively import NPC Classes, Templates, or Player Data, with full English/German (i18n) localization support out of the box. - PC JSON Importer: Upload your players' COMP/CON Pilot exports (
.json). Automatically extracts their active Mech, Weapons, Systems, Licenses, Talents, and Lore! - Dynamic Template Engine: Both importers read your own Obsidian templates (e.g.,
99_TEMPLATES/Template_Mech.md). Just place the{{LANCER_STATS}}tag in your template, and the plugin will seamlessly inject the crunch while keeping your beautiful YAML and layout intact!
5. Interactive Clocks & Progress Bars
Manage your mission timers and progress directly in Reading View.
- Syntax:
[Clock: Mission Timer 4/8]or[Bar: Health 15/20] - Interactive: Click the
[-]and[+]buttons next to the clock in Reading View to automatically update the markdown source file!
6. Dynamic Statblocks
Create beautiful, COMP/CON style stat grids for your mechs in any standard note using the lancer-stats code block. Provide comma-separated values for Tiers (e.g., HP: 10, 12, 14). The plugin will render the base layout seamlessly.
📦 Installation
1. Install the Plugin
- Copy the
pluginfolder contents into<Your Vault>/.obsidian/plugins/lancer-companion. - Open Obsidian > Settings > Community Plugins, and enable
Lancer Companion Plugin.
3. Add the Templates
- Choose either the English or German templates from the
templates/enortemplates/defolder in this repository. - Copy them into your Vault's template folder (e.g.,
99_TEMPLATES/).
⚙️ Requirements
- Obsidian v1.4.0+
📝 License
This project is an independent creation and is not affiliated with Massif Press. Lancer is a trademark of Massif Press.