# @skyrim-platform/skyrim-platform

> TypeScript type definitions for Skyrim Platform

Latest version **2.9.0** (published 2024-05-14) · GPLV3 license · 0 weekly downloads

## Install

```sh
npm install @skyrim-platform/skyrim-platform
pnpm add @skyrim-platform/skyrim-platform
yarn add @skyrim-platform/skyrim-platform
bun add @skyrim-platform/skyrim-platform
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.9.0 |
| Published | 2024-05-14 |
| First published | 2021-12-23 |
| Weekly downloads | 0 |
| License | GPLV3 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 164 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Maintainers | shevernitskiy, mrowrpurr |
| Keywords | skyrim, skyrim platform |

## Links

- npm: https://www.npmjs.com/package/@skyrim-platform/skyrim-platform
- Repository: https://github.com/skyrim-platform/skyrim-platform
- Issues: https://github.com/skyrim-platform/skyrim-platform/issues
- npm.io page: https://npm.io/package/@skyrim-platform/skyrim-platform

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 2.9.0 (latest) — 2024-05-14
- 2.8.0 — 2024-01-09
- 2.7.1 — 2023-09-11
- 2.7.0 — 2023-06-03
- 2.6.0 — 2022-04-24
- 2.5.0 — 2022-02-10
- 2.4.0 — 2022-01-01
- 2.3.2 — 2021-12-27
- 2.3.1 — 2021-12-23
- 2.3.0 — 2021-12-23

## README

## `@skyrim-platform/skyrim-platform`

TypeScript type definitions for Skyrim Platform (_released with permission_)

- Skyrim Platform on GitHub: https://github.com/skyrim-multiplayer/skymp
- Skyrim Platform on Nexus: https://www.nexusmods.com/skyrimspecialedition/mods/54909
- Skyrim Platform documentation: https://github.com/skyrim-multiplayer/skymp/blob/main/docs/docs_skyrim_platform.md

## Getting Started

You can find an example Skyrim Platform plugin with documentation on how to get started here: https://github.com/skyrim-multiplayer/skymp/tree/main/skyrim-platform/tools/plugin-example

## License

Your plugin is your own software and can be licensed however you like even if it uses Skyrim Platform types!

Skyrim Platform itself is distributed under the GNU General Public License v3.0.

---
_Source: https://npm.io/package/@skyrim-platform/skyrim-platform · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._