Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/0tickpulse/mythic-analyzer-vsc

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/0tickpulse/mythic-analyzer-vsc
Owner: 0tickpulse
License: agpl-3.0
Created: 2023-10-28T17:45:15.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-06-16T10:24:24.000Z (5 months ago)
Last Synced: 2024-06-16T11:39:26.783Z (5 months ago)
Language: TypeScript
Size: 229 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        




# Mythic Analyzer



MythicMobs configuration analysis




    

        

    

    

        

    

    

    

        

    



---

## 📖 Table of Contents

- [Mythic Analyzer](#mythic-analyzer)

  - [📖 Table of Contents](#-table-of-contents)

  - [🚀 Features](#-features)

    - [🎉 Current](#-current)

      - [YAML Validation](#yaml-validation)

      - [Simple Autocompletion](#simple-autocompletion)

      - [NPM Package/API](#npm-packageapi)

  - [⚠️ Limitations](#️-limitations)

  - [📝 License](#-license)

  - [❤️ Credits and Acknowledgements](#️-credits-and-acknowledgements)

## 🚀 Features

**Currently, these features are available on:**

- MythicMob Mob files

- MythicMob Item files

- MythicMob Skill files

### 🎉 Current

#### YAML Validation

The extension provides YAML validation for MythicMobs configurations.

This makes it easier to spot typos and other mistakes in your configuration files.

![YAML Validation Example](./assets/yaml_erroring.png)

#### Simple Autocompletion

The extension provides simple autocompletion for things like keys and enum values.

![YAML Keys Autocompletion Example](./assets/yaml_key_autocompletion.png)

![YAML Enum Autocompletion Example](./assets/yaml_enum_autocompletion.png)

#### NPM Package/API

The extension is also available as an NPM package, which can be found [here](https://www.npmjs.com/package/mythic-analyzer).

```bash

pnpm install mythic-analyzer

```

The package exposes an API and can be used to create custom tools that require MythicMobs configuration analysis.

## ⚠️ Limitations

The extension is still in beta and may have bugs. Here are some known limitations:

- The extension does not support YAML anchors and aliases.

- The extension does support Mythic submapping, where a key can be written like `A.B.C` instead of `A: { B: { C: ... } }`. However, this is quite buggy and may not work as expected.

## 📝 License

This project is licensed under AGPLv3. A copy can be found [here](./LICENSE).

## ❤️ Credits and Acknowledgements

- Microsoft and the VSCode team, for providing the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/), [VSCode Extension API](https://code.visualstudio.com/api), [YAML tmLanguage](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide), and more.

- [MythicMobs](https://www.mythicmobs.net/) and [its community](http://www.mythicmobs.net/discord), for creating and maintaining the plugin and its documentation.

- Every contributor on my discord server, for helping me with testing and providing feedback.