Skip to content

Commit a1d81c6

Browse files
committed
docs: improvements
1 parent 6b25801 commit a1d81c6

6 files changed

Lines changed: 281 additions & 244 deletions

File tree

documentation/ecoscrolls/api.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,18 @@ title: "API"
33
sidebar_position: 7
44
---
55

6-
## Source Code
6+
This page is for developers who want to hook into EcoScrolls from their own plugin. EcoScrolls is open-source, so you can read the code, depend on it, and build against its API.
77

8-
The source code can be found [here](https://github.com/Auxilor/EcoScrolls):
8+
## Source code
99

10-
## API
10+
The full source is on GitHub at [Auxilor/EcoScrolls](https://github.com/Auxilor/EcoScrolls).
1111

12-
Add this to your build.gradle.kts:
12+
## Adding the dependency
1313

14-
```kts
14+
1. Add the Auxilor repository to your `build.gradle.kts`.
15+
2. Add EcoScrolls as a `compileOnly` dependency.
16+
17+
```kotlin
1518
repositories {
1619
maven("https://repo.auxilor.io/repository/maven-public/")
1720
}
@@ -21,4 +24,11 @@ dependencies {
2124
}
2225
```
2326

24-
The latest version available on the repo can be found [here](https://github.com/Auxilor/EcoScrolls/tags)
27+
The latest version available on the repo can be found [here](https://github.com/Auxilor/EcoScrolls/tags).
28+
29+
<hr/>
30+
31+
## Where to go next
32+
33+
- **eco framework:** the shared APIs EcoScrolls builds on live in [eco](https://github.com/Auxilor/eco).
34+
- **Make a scroll:** the config side of scrolls in [How to Make a Scroll](how-to-make-a-scroll).

documentation/ecoscrolls/commands-and-permissions.md

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,20 @@ title: "Commands and Permissions"
33
sidebar_position: 5
44
---
55

6-
| Command | Description | Permission |
7-
|--------------------------------------------------|---------------------------------------------------------|--------------------------------------|
8-
| `/ecoscrolls reload` | Reloads the plugin | `ecoscrolls.command.reload` |
9-
| `/inscribe` | Opens the inscription GUI | `ecoscrolls.command.inscribe` |
10-
| `/ecoscrolls inscribe <player> <scroll> [level]` | Inscribe the held item | `ecoscrolls.command.inscribedirect` |
11-
| `/ecoscrolls give <player> <scroll> [quantity]` | Give the player an EcoScroll | `ecoscrolls.command.give` |
12-
| `/ecoscrolls import <id>` | Import a scroll from [lrcdb](https://lrcdb.auxilor.io/) | `ecoscrolls.command.import` |
13-
| `/ecoscrolls export <id>` | Export a scroll to [lrcdb](https://lrcdb.auxilor.io/) | `ecoscrolls.command.export` |
6+
Every EcoScrolls command and the permission node that gates it. Op players have all of these by default; grant the individual nodes to give non-op players access.
7+
8+
| Command | Description | Permission |
9+
| --- | --- | --- |
10+
| `/ecoscrolls reload` | Reloads the plugin | `ecoscrolls.command.reload` |
11+
| `/inscribe` | Opens the Inscription Table GUI | `ecoscrolls.command.inscribe` |
12+
| `/ecoscrolls inscribe <player> <scroll> [level]` | Inscribes the held item | `ecoscrolls.command.inscribedirect` |
13+
| `/ecoscrolls give <player> <scroll> [quantity]` | Gives the player a scroll | `ecoscrolls.command.give` |
14+
| `/ecoscrolls import <id>` | Imports a scroll from lrcdb | `ecoscrolls.command.import` |
15+
| `/ecoscrolls export <id>` | Exports a scroll to lrcdb | `ecoscrolls.command.export` |
16+
17+
<hr/>
18+
19+
## Where to go next
20+
21+
- **Make a scroll:** build a scroll to give or inscribe in [How to Make a Scroll](how-to-make-a-scroll).
22+
- **Community configs:** import ready-made scrolls from [lrcdb](https://lrcdb.auxilor.io/).

0 commit comments

Comments
 (0)