Git Product home page Git Product logo

bdsx-dynamic-properties-test's Introduction

How to make a plugin

Make the plugin project with the bootstrap

> npm run newplugin ./path/to/plugin
# it will install the generated plugin as a local package
# Please execute this on the bdsx directory

Build the plugin

  • With VSCode Ctrl+Shift+B -> tsc: watch

  • With the command line

> npm run watch

Install the plugin without npm publishing

Copy the plugin to plugins/ directory

Publish the plugin as a npm module

  1. Create an npm account if you don't have one yet. NPM Sign Up
  2. Request for joining @bdsx organization at #npm-bdsx-org-member-request channel of the discord server with npm ID or EMail.
  3. Login with the command line.
> npm login
npm notice Log in on https://registry.npmjs.org/
Username: # Enter Username
Password: # Enter Password
Email: (this IS public) # Enter Email
  1. Publish with the command line
> cd path/to/plugin # move to the plugin directory
> npm publish --access=public # publish the plugin

Install the npm module plugin

  • With the command line
> npm i @bdsx/pluginname
  • With the plugin manager
    Run plugin-manager.bat/sh.
    Search and select the plugin.
    Select the version.

Remove the npm module plugin

  • With the command line
> npm r @bdsx/pluginname
  • With the plugin manager
    Run plugin-manager.bat/sh.
    Search and select the plugin.
    Select Remove.

Remark

I don't recommend using low-level APIs like hooking. it can be broken by updating BDS. if you need the low-level feature I hope you contribute the code to BDSX about it. I will maintain it as I as possible.

bdsx-dynamic-properties-test's People

Contributors

tutinoko2048 avatar kaito02020424 avatar

Watchers

 avatar

Forkers

kaito02020424

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.