Mods / VTML Editor

Tags: #Other #QoL #Utility
Author: jayu
Side: Client
Created: Mar 16th at 7:22 PM
Last modified: Oct 9th at 10:22 PM
Downloads: 519
Follow Unfollow 40

Latest release (for Vintage Story 1.21.0 - 1.21.4, potentially outdated):
vtmleditor_1.1.3.zip  1-click install


Enjoy my work? You can support me on Ko-fi or Patreon. Thank you!

Support me on Ko-fi   Support me on Patreon

VTML Editor is a tool designed to simplify the creation and previewing of VTML language entries in Vintage Story. With an in-game interface, accessible via the U key by default, the editor lets you quickly search for language entries (complete with wildcard support) and view them in multiple languages. A preview window is included, which replicates the exact dimensions of the handbook to ensure you get an accurate preview of your content.

In-game, you can open the editor by entering either the command .vtmleditor or .vtmle.

Recent enhancements include:

  • Syntax Highlighting & Customizable Themes:
    • Easily switch between themes directly in the UI (Load any theme asset from assets/<modid>/config/vtmleditor/themes.json).
    • Comes with a variety of default themes to choose from.
  • Revamped Vanilla Text Editing Classes:
    • Selectable Text:
      • Use mouse drag to select text.
      • Double-click to select a word and triple-click to select an entire line.
      • Keyboard shortcuts (shift + movement keys) for more control.
    • Standard Keyboard Shortcuts: Copy (Ctrl+C), paste (Ctrl+V), cut (Ctrl+X), select all (Ctrl+A), and even Ctrl+Backspace (delete word) for efficient editing.
    • Undo/Redo System: Reverse up to 100 edits with Ctrl+Z and restore them using Ctrl+Y or Ctrl+Shift+Z.
    • Style Shortcuts: Quickly apply formatting with Ctrl-I (italic) and Ctrl-B (bold).
    • Enhanced Miscellaneous Interactions: Improved handling of keys such as Tab and better caret tracking.
  • Additional Functionality:
    • Convenient buttons to insert VTML tags such as hotkey tags (selectable from a dropdown) and link tags (automatically wraps around selected text).
    • And more features are on the way!
Example Theme Configuration
[{
"Code": "default",
"FontName": "sans-serif",
"FontSize": "16",
"TokenColors": {
"TagDelimiter": "#8F8F8FFF",
"TagName": "#8F8F8FFF",
"AttributeName": "#CC9966FF",
"EqualsSign": "#8F8F8FFF",
"AttributeValue": "#6BA6CEFF",
"Text": null
}
}]

Current Issues

Should work fine as it uses separate code from the game's base text fields, but the code needs some refactoring to uniform with the the 1.21 text editing changes. Text selection dragging and other improvements have also been implemented in a dev build but they still need to be added here.

More modding tools and libraries

image

ExtraCode

Adds extra classes and behaviors for content modders

image

Vintage Mod Templates [Code][Content]

Custom templates for code and content mods

image

BlockPatch Patcher

Dynamically patch block patches. Allows wildcards and multiplication of values.

Mod Version For Game version Downloads Released Changelog Download 1-click mod install*
1.1.3
1.21.0 - 1.21.4
83 Oct 9th at 10:22 PM vtmleditor_1.1.3.zip 1-click install
  • [Update] 1.21 Update
  • [Fixed] Language locale defaulting to EN on selection instead of current locale
1.1.2
1.20.5 - 1.20.7
196 Mar 21st at 1:46 AM vtmleditor_1.1.2.zip 1-click install
  • Change default hotkey binding to U
  • Allow selection and advanced keyboard shortcuts in editor
  • Fix vanilla crash from incomplete hotkey tags
  • Resized viewer page to be identical to handbook page
  • Improved editor page
  • Some auto tag insertion buttons
  • Fix theme not loading by default
1.1.1 65 Mar 18th at 1:04 PM vtmleditor_1.1.1.zip 1-click install
  • Custom theme support
1.1.0 60 Mar 17th at 10:46 PM vtmleditor_1.1.0.zip 1-click install
  • Add syntax highlighting
  • Add font options
  • Add syntax highlighting theme support
1.0.1 60 Mar 16th at 11:50 PM vtmleditor_1.0.1.zip 1-click install
  • Add scrollbars and standardise dialog size
  • Add commands to open the dialog: .vtmleditor and .vtmle
1.0.0 54 Mar 16th at 7:23 PM Empty vtmleditor_1.0.0.zip 1-click install

19 Comments (oldest first | newest first)

💬 jayu , Nov 15th at 3:49 AM

Lord_Hagen what's the crash?

💬 Lord_Hagen, Nov 14th at 4:24 PM (modified Nov 14th at 4:24 PM)

Don't press H or u be crashed when u use VTMLEdit

💬 RoyalBlue, Nov 11th at 2:03 AM

Found a bug it seems: when making a big enough document, around 506 lines, the editor turns completely black.

 

The functionality basically remains, additions or edits still show up in the preview, it's just impossible to see what you're doing.

Highlighting doesn't help by the way.

💬 Poveraccio, Nov 10th at 1:39 PM

jayu Thank you so much for the update, this is a huge lifesaver and makes editing books and papers way easier.  Keep on being amazing!

💬 El_Neuman, Oct 10th at 7:54 AM

Wow, thank you very much for this mod, it's amazing 😍

💬 NeoB, Oct 10th at 1:11 AM

Great, this will make things much easier for me, thank you!

💬 jayu , Oct 9th at 10:25 PM

Poveraccio poretto it took a while for me to remember to update this unfortunately

💬 Poveraccio, Sep 17th at 11:03 AM (modified Sep 17th at 11:04 AM)

I need this really bad to make my books.  Hope this gets an update here soon!

💬 Rythillian, Jun 3rd at 3:43 PM

Is this still being updated? This seems super super handy. I assume it works with books?

💬 HJVT, Apr 29th at 2:07 AM

jayu
ctrl+left/right to jump over entire words, home/end to jump to the start/end of the line, del and ctrl+del to delete to the right
You could go on listing handy editor features forever

💬 sneezerstein, Apr 23rd at 9:36 PM

this saved my life

💬 jayu , Apr 2nd at 5:44 PM

DejFidOFF what do you mean with move in exactly? The mod supports copy/paste, selection, movement arrows to more around the text, etc

💬 DejFidOFF, Apr 2nd at 5:23 PM

jayu

I like it, but hell, it´s too slow to move in text..

💬 jayu , Mar 23rd at 9:47 PM

Vinter_Nacht I'm not sure what you meant by automatic tbh, what did you have in mind?

💬 Vinter_Nacht, Mar 23rd at 7:21 PM

jayu - I shouldn't have said "just" an editor, that's already a god send.  Probably best it isn't automagic.

💬 jayu , Mar 19th at 1:56 PM

Ok I will change that

💬 DanaCraluminum, Mar 18th at 5:16 PM

Y hotkey is taken by time switch by default

💬 jayu , Mar 17th at 3:58 PM

Vinter_Nacht it's just an editor, you copy your result and paste it in your lang file. I couldn't find a nice way to save it automatically as the game loads lang entries from multiple files. Easier to just copy it and paste it where you need it.

💬 Vinter_Nacht, Mar 17th at 2:13 PM

Is it necessary to have this as a dependency for the mod, or is it just a utility for writing handbook entries?

 (edit comment delete)
Основной веб-сайт | Почтовый сервер | FTP сервер | Административная панель | API интерфейс | Content Delivery Network | Статические файлы | Ресурсы сайта | Изображения | Файловое хранилище | Блог | Интернет-магазин | Техническая поддержка | Справочная система | Документация | Форум | Новости | Загрузки | Демонстрация | Тестовая среда | Приложение | Медиа контент | Разработка | Промежуточная среда | Бета версия | Безопасная зона | Вход в систему | Панель управления | Портал | Система управления контентом