docs_skyrim_platform.md

Skyrim Platform

This information is for mod creators. For general details, please read the README.

Skyrim Platform is a modding tool for Skyrim allowing writing scripts with JavaScript/TypeScript.

printConsole("Hello Platform");

on("update", () => {
  const gold = Game.getForm(0xf);
  const target = Game.getDialogueTarget();
  const player = Game.getPlayer();
  if (target && player && player.getItemCount(gold) >= 100) {
    player.removeItem(gold, 100, true, target);
    Debug.notification("You have just paid to an NPC");
  }
});

One of the mods built on Skyrim Platform is skymp client.
Yes, client of Skyrim Multiplayer is technically a mod for Skyrim Special Edition implemented using Skyrim Platform.

Here you will find documentaiton aimed for you to create your own mods using Skyrim Platform.

The documentation is versioned up-to-date with SkyrimPlatform itself. If you read this page on GitHub, it's probably docs on latest SP revision. We release SkyrimPlatform updates from time to time. See here what is included in the upcoming SP update.

You can get Skyrim Platform from Nexus: https://www.nexusmods.com/skyrimspecialedition/mods/54909

Create your first Skyrim Platform plugin!

Table of contents

• Skyrim integration
  • Papyrus objects
  • Native functions
  • Hooks (events)
• Content added by Skyrim Platform
  • Exclusive features
  • New methods and properties
  • New types
  • New events
  • Browser / UI
  • HTTP
  • Texts
  • Win32
  • Settings
• Cook Book

Versioning Notes

SP follows Semantic Versioning for JavaScript, but not for TypeScript.

It means that non-major updates won't break compiled TypeScript plugins or plugins written in JavaScript. If they do, treat it as an SP bug then.

On the other hand, updating skyrimPlatform.ts may break the compilation of your TypeScript plugins. You likely will be able to easily fix these problems, or ask for help in our Discord server, or just use skyrimPlatform.ts from one of the previous versions.