Skip to content

Commit 2042686

Browse files
Updated README
1 parent 0ed376f commit 2042686

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
11
<img width="1024" height="220" alt="image" src="https://github.com/user-attachments/assets/00c872f3-836f-4403-81d1-c750c96bd2b2" />
2+
3+
# Octopus Paper plugin
4+
5+
**Paper plugin with API for wrapper around Octopus SDK for o7studios product Octopus**
6+
7+
- Runs on [Paper](https://papermc.io/software/paper)
8+
9+
## Development
10+
11+
Full development setup available as [Development Container](https://containers.dev/).
12+
Please use it for being able to tell "It works on my machine".
13+
14+
**Docker is required to be installed on your machine!**
15+
16+
### IntelliJ IDEA
17+
18+
- Open IntelliJ (Welcome screen)
19+
- Navigate to `Remote Development` - `Dev Containers`
20+
- Press `New Dev Container`
21+
- Select `From VCS Project`
22+
- Select and connect with `Docker`
23+
- Select `IntelliJ IDEA`
24+
- Enter `Git Repository`: `https://github.com/o7studios/cheetah`
25+
- Select `Detection for devcontainer.json file` `Automatic`
26+
- Press `Build Container and Continue`
27+
28+
### Development Container Issues
29+
30+
If you encounter an issue with setting up a development container, please
31+
try to rebuild it first before opening a GitHub Issue. It's not uncommon
32+
that some issues may fix themselves after a fresh container rebuild.

0 commit comments

Comments
 (0)