Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.45 KB

readme.md

File metadata and controls

29 lines (22 loc) · 1.45 KB
Raw

BHMB Starter

This repo provides a prebuilt setup for easily creating extensions for the Blockheads MessageBot. By default it is configured for a TypeScript project, but can be easily modified to work with vanilla JavaScript.

Usage

Compiling

Compile with npm run build. Additionally, npm run build:watch or npm run build:watch can be used to watch files for changes and automatically recompile.

Setup

  1. Clone this repo using git clone --depth=1 https://github.com/Bibliofile/BHMB-Starter.git
  2. Remove the .git folder and run git init to create your own project.
  3. Alter the license to the license you want to use.
  4. Install dependencies with npm install
  5. Edit the name, author, and description in package.json
  6. Open src/index.ts and edit as desired
  7. If you don't use vscode, remove the .vscode directory

Setup without TypeScript

  1. Clone this repo using git clone --depth=1 https://github.com/Bibliofile/BHMB-Starter.git
  2. Remove typescript dependencies npm uninstall --save-dev typescript tslint rollup-plugin-typescript2
  3. Install remaining dependencies npm install
  4. Edit the name, author, and description in package.json
  5. Rename src/index.ts to src/index.js
  6. Delete tsconfig.json and tslint.json in the root directory and exports.d.ts in the src directory.
  7. In rollup.config.js remove all references to rollup-plugin-typescript2 and its imports
  8. If you don't use vscode, remove the .vscode directory