Skip to content

Crawls through the admin commands class to generate a list of admin commands, for Swordie-based MapleStory private servers.

Notifications You must be signed in to change notification settings

TEAM-SPIRIT-Productions/SpiritMS-Admin-Commands-Spider

Repository files navigation

SpiritMS-Admin-Commands-Spider

This script crawls through the admin commands class in Swordie-like MapleStory private servers, to generate a list of admin commands available in the server.

This project is adapted from ascii_checker, which was initially made for filtering non-ASCII text from Azure v316 style source code (e.g. ElectronMS).

Note: This script requires Python 3.6+, and is written/tested using Python 3.10


How To Use

  1. Run setup.bat (optional, if you already have ruamel.yaml installed in your global Python environment)
    • This script creates a new virtual environment in the repository root, and installs all dependencies
  2. Configure config.py
    • E.g. REPOSITORY_ROOT = "E:\Downloads\SpiritMS"
    • E.g. DOCS = "E:\Downloads\SpiritSuite\SPIRITCOMMANDS.md"
  3. Run start.bat
  4. Input whether to check admin commands list against SpiritSuite docs
  5. Check the /output/ folder of this repository for the results

  • AdminCommands.yaml
    • List of all admin commands found in the target repository
  • DeadCommands.txt
    • List of command aliases recorded in the SpiritSuite docs that are no longer part of the SpiritMS repository
  • NewCommands.yaml
    • List of commands that are either not recorded inside of the docs, or have the wrong permission level

About

Crawls through the admin commands class to generate a list of admin commands, for Swordie-based MapleStory private servers.

Resources

Stars

Watchers

Forks