/cactbot-user-template

A template repository for customising cactbot with user directory

Primary LanguageJavaScriptMIT LicenseMIT

Cactbot User Template

English | 简体中文 | 日本語

This project is a template project for creating Cactbot customized triggers/timelines or custom user configurations, extending the scope and possibilities of customization based on the functionality of Cactbot's user folder override.

Instructions

  1. Download and install Node.js, in normal situation just choose the Windows installer. If you have already installed it, please skip this step..
  2. Download and install Git. If you have already installed it, please skip this step..
  3. Click the Use This Template button to create a new project under your account.
  4. Run the git clone <your GitHub account name>/<your project name>.git command to clone this project locally.
  5. Run the cd <your project name> command to enter the project directory.
  6. Install yarn if you haven't already done so: npm install -g yarn.
  7. Run yarn install to install the required dependencies for the project.
  8. Run the yarn run build command to package the project into the dist directory.
  9. Start ACT and navigate to OverlayPlugin > Cactbot > User Folder, set the path to the project's dist directory.
  10. Test the project whether it was compiled and loaded successfully by Cactbot.
    • Teleport to the Summerford Farms.
    • Start the test timeline by using the "/countdown" command or "/bow" to the striking dummy.
    • Type /e test user in the chat window to ensure the functions are working properly.

Note

Every time you changed source files, you should run yarn run build to update the code in the dist directory.

You can also use yarn run watch, which will automatically update the code in the dist directory when you change any file.

Differences from Cactbot

  • Default configuration entry for all modules is src/<module name>/index.js, so that you can split your code into multiple files and import them into index.js.

Raidboss module

  • All trigger files in raidboss must be placed in the data directory
  • All trigger sets must be exported as export default { ... }

TypeScript support

Use cactbot-user-typescript-template instead.

Examples

Associated Projects

Feedback and Support

  • If you find any problems using this project, please submit an issue on GitHub.

    • If the problem is with Cactbot itself, please submit an issue to the Cactbot repository.

  • If you have any suggestions, please submit a pull request on GitHub.

License

This project is published under MIT license. See LICENSE for details.