Skip to Content
Haven Documentation is the shared home for product guides, plugin setup, and release docs.
PluginsStaff HandbookSetup

Staff Handbook Setup

Requirements

  • AthenaBot 2.2.0 or newer
  • The core plugin enabled
  • Staff role IDs for access control, if you want to restrict the handbook
  • No extra Node packages

Installation

  1. Place the plugin folder at plugins/staff_handbook.
  2. Start AthenaBot once so it generates:
    • configuration/staff_handbook.json5
    • configuration/staff_handbook_content.json5
    • configuration/staff_handbook_lang.json5
  3. Stop AthenaBot and review the generated content.
  4. Add staff role IDs to access.allowed_role_ids.
  5. Add management role IDs to access.senior_role_ids if the handbook includes senior-only content.
  6. Check that permissions.handbook_command and permissions.handbook_components match keys in configuration/permission.json5.
  7. Restart AthenaBot and run /handbook.

Empty global access lists allow anyone with the configured Athena permission level to open the handbook. Add staff role or user IDs before launch if /handbook should remain staff-only.

{
  config: {
    access: {
      allowed_role_ids: ["STAFF_ROLE_ID"],
      allowed_user_ids: [],
      senior_role_ids: ["MANAGEMENT_ROLE_ID"],
      senior_user_ids: []
    },
    permissions: {
      handbook_command: "member",
      handbook_components: "member"
    }
  }
}

The global access lists and Athena permission levels both apply. A member must pass the command permission check and the handbook allowlist.

Review the Starter Content

The included handbook covers example situations such as chat offenses, cheating, griefing, player reports, and staff escalation. Replace those pages with your own server rules and escalation paths before release.

For each page, check:

  • The summary and steps match current policy.
  • Punishment guidance names the correct action.
  • Evidence requirements match the tools your staff use.
  • Sensitive links and exploit details stay on restricted pages.
  • Senior-only pages use senior_only: true.

First Test

  1. Run /handbook from a staff account.
  2. Open a category and a situation.
  3. Use Back and Main Menu.
  4. Run /handbook search:<keyword>.
  5. Confirm a non-staff account cannot open the handbook.
  6. Confirm normal staff cannot see senior-only content.

Safe Launch Checklist

  • Review or replace every starter page.
  • Configure staff and senior access lists.
  • Test both command and component permissions.
  • Keep private responses enabled for internal guidance.
  • Check links and custom emoji names in the rendered embeds.
OverviewConfiguration