https://github.com/o7studios/octopus-plugin
Paper plugin for o7studios product Octopus
https://github.com/o7studios/octopus-plugin
Last synced: 6 months ago
JSON representation
Paper plugin for o7studios product Octopus
- Host: GitHub
- URL: https://github.com/o7studios/octopus-plugin
- Owner: o7studios
- License: gpl-3.0
- Created: 2025-08-01T09:50:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-11-27T18:48:02.000Z (7 months ago)
- Last Synced: 2025-11-30T10:33:27.670Z (7 months ago)
- Language: Java
- Homepage: https://docs.o7.studio/docs/octopus
- Size: 169 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Octopus Paper plugin
**Paper plugin with API for wrapper around Octopus SDK for o7studios product Octopus**
- Runs on [Paper](https://papermc.io/software/paper)
## Usage
Add dependency to plugin:
```kotlin
dependencies {
compileOnly("studio.o7:octopus-plugin-api:X.Y.Z")
}
```
Add _depend_ inside `plugin.yml`:
```yaml
depend:
- Octopus
```
## Development
Full development setup available as [Development Container](https://containers.dev/).
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`:
```text
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.