Octopus Paper plugin

Paper plugin with API for wrapper around Octopus SDK for o7studios product Octopus

• Runs on Paper

Usage

Add dependency to plugin:

dependencies {
    compileOnly("studio.o7:octopus-plugin-api:X.Y.Z")
}

Add depend inside plugin.yml:

depend:
  - Octopus

Development

Full development setup available as Development Container. Please use it for being able to tell "It works on my machine".

Docker is required to be installed on your machine!

Create ~/dev.env

The development container is using a local env file on your host machine for reading e.g. GitHub Tokens, Usernames, Email. So please make sure it exists with your credentials in ~/dev.env:

GITHUB_EMAIL=your-mail@your-domain.com
GITHUB_USERNAME=YOUR_GITHUB_USERNAME
GITHUB_TOKEN=ghp_***

The GITHUB_TOKEN must've set following permission:

• repo
• read:packages
• read:user
• user:email

IntelliJ IDEA

• Open IntelliJ (Welcome screen)
• Navigate to Remote Development - Dev Containers
• Press New Dev Container
• Select From VCS Project
• Select and connect with Docker
• Select IntelliJ IDEA
• Enter Git Repository: https://github.com/o7studios/octopus-plugin
• Select Detection for devcontainer.json file Automatic
• Press Build Container and Continue

Development Container Issues

If you encounter an issue with setting up a development container, please try to rebuild it first before opening a GitHub Issue. It's not uncommon that some issues may fix themselves after a fresh container rebuild.