Skip to content

Commit 8382919

Browse files
dmccoystephensondmccoystephenson
authored
Merge pull request #142 from Dans-Plugins/copilot/align-documentation-medieval-factions
Align documentation with Medieval Factions plugin conventions
2 parents 602146b + a3c614a commit 8382919

File tree

4 files changed

+500
-27
lines changed

4 files changed

+500
-27
lines changed

‎COMMANDS.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
# SimpleSkills - Commands Reference
2+
3+
This document provides a comprehensive list of all commands available in the SimpleSkills plugin.
4+
5+
## Table of Contents
6+
7+
- [Command Aliases](#command-aliases)
8+
- [General Commands](#general-commands)
9+
- [Admin Commands](#admin-commands)
10+
11+
## Command Aliases
12+
13+
The main SimpleSkills command can be accessed using any of the following aliases:
14+
15+
- `/simpleskills`
16+
- `/ss`
17+
- `/skills`
18+
19+
---
20+
21+
## General Commands
22+
23+
### `/ss help`
24+
25+
**Permission:** `ss.help` (default: true)
26+
**Description:** Displays a list of helpful commands and usage information.
27+
**Usage:** `/ss help`
28+
29+
---
30+
31+
### `/ss info [player]`
32+
33+
**Permission:** `ss.info` (default: true)
34+
**Description:** Displays skill levels and experience for a player. If no player name is provided, shows your own skills.
35+
**Usage:**
36+
- `/ss info` – View your own skills
37+
- `/ss info <playerName>` – View another player's skills
38+
39+
---
40+
41+
### `/ss skill <skillName>`
42+
43+
**Permission:** `ss.skill` (default: true)
44+
**Description:** Displays detailed information about a specific skill, including its active status, max level, base experience requirement, and experience increase factor.
45+
**Usage:** `/ss skill <skillName>`
46+
**Example:** `/ss skill Mining`
47+
48+
---
49+
50+
### `/ss top [skillName]`
51+
52+
**Permission:** `ss.top` (default: true)
53+
**Description:** Displays the top players ranked by skill level. If a skill name is provided, shows the leaderboard for that skill specifically.
54+
**Usage:**
55+
- `/ss top` – View top players overall
56+
- `/ss top <skillName>` – View top players in a specific skill
57+
58+
**Example:** `/ss top Farming`
59+
60+
---
61+
62+
### `/ss stats`
63+
64+
**Permission:** `ss.stats` (default: true)
65+
**Description:** Displays server-wide statistics, including the total number of skills, player records, and unknown skills.
66+
**Usage:** `/ss stats`
67+
68+
---
69+
70+
## Admin Commands
71+
72+
### `/ss reload`
73+
74+
**Permission:** `ss.reload` (default: op)
75+
**Description:** Reloads the plugin configuration and language files without restarting the server.
76+
**Usage:** `/ss reload`
77+
78+
---
79+
80+
### `/ss force wipe`
81+
82+
**Permission:** `ss.force.wipe` (default: op, console only)
83+
**Description:** Clears all player skill records from the server. **This action is irreversible.**
84+
**Usage:** `/ss force wipe`
85+
**Notes:** This command can only be run from the console.
86+
87+
---
88+
89+
### `/ss force activate <skillName>`
90+
91+
**Permission:** `ss.force.activate` (default: op)
92+
**Description:** Activates a skill so it can be gained by players and its benefits can trigger.
93+
**Usage:** `/ss force activate <skillName>`
94+
**Example:** `/ss force activate Mining`
95+
96+
---
97+
98+
### `/ss force deactivate <skillName>`
99+
100+
**Permission:** `ss.force.deactivate` (default: op)
101+
**Description:** Deactivates a skill so players cannot gain experience in it and its benefits will not trigger.
102+
**Usage:** `/ss force deactivate <skillName>`
103+
**Example:** `/ss force deactivate Mining`
104+
105+
---
106+
107+
## Permissions Summary
108+
109+
| Permission | Default | Description |
110+
|---|---|---|
111+
| `ss.help` | Everyone | Use `/ss help` |
112+
| `ss.info` | Everyone | Use `/ss info` |
113+
| `ss.skill` | Everyone | Use `/ss skill` |
114+
| `ss.top` | Everyone | Use `/ss top` |
115+
| `ss.stats` | Everyone | Use `/ss stats` |
116+
| `ss.reload` | Op | Use `/ss reload` |
117+
| `ss.force` | Op | Use `/ss force` |
118+
| `ss.force.wipe` | Op | Use `/ss force wipe` |
119+
| `ss.force.activate` | Op | Use `/ss force activate` |
120+
| `ss.force.deactivate` | Op | Use `/ss force deactivate` |

‎CONFIG.md‎

Lines changed: 171 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,171 @@
1+
# SimpleSkills - Configuration Guide
2+
3+
This document provides detailed information about all configuration options available in SimpleSkills.
4+
5+
## Table of Contents
6+
7+
- [config.yml](#configyml)
8+
- [General Settings](#general-settings)
9+
- [Alert Settings](#alert-settings)
10+
- [Skill Activation](#skill-activation)
11+
- [message.yml](#messageyml)
12+
13+
---
14+
15+
## config.yml
16+
17+
The `config.yml` file is located in `plugins/SimpleSkills/config.yml` on your server.
18+
19+
### General Settings
20+
21+
#### `config-version`
22+
23+
**Type:** String
24+
**Default:** `0.1`
25+
**Description:** Internal version identifier for the config file. Do not modify this manually. If this does not match the expected version, you will see an error in the server console prompting you to update your config.
26+
27+
---
28+
29+
#### `debugMode`
30+
31+
**Type:** Boolean
32+
**Default:** `false`
33+
**Description:** When `true`, enables additional debug logging to help diagnose issues.
34+
35+
---
36+
37+
#### `defaultMaxLevel`
38+
39+
**Type:** Integer
40+
**Default:** `100`
41+
**Description:** The maximum level a skill can reach.
42+
**Range:** Any positive integer
43+
44+
---
45+
46+
#### `defaultBaseExperienceRequirement`
47+
48+
**Type:** Integer
49+
**Default:** `10`
50+
**Description:** The amount of experience required to reach level 2. Each subsequent level requires more experience based on the `defaultExperienceIncreaseFactor`.
51+
**Range:** Any positive integer
52+
53+
---
54+
55+
#### `defaultExperienceIncreaseFactor`
56+
57+
**Type:** Float
58+
**Default:** `1.2`
59+
**Description:** The multiplier applied to the experience requirement at each level. For example, with a base requirement of 10 and a factor of 1.2, level 2 requires 10 XP, level 3 requires 12 XP, level 4 requires ~14.4 XP, and so on.
60+
**Range:** Any value greater than 1.0
61+
62+
---
63+
64+
### Alert Settings
65+
66+
#### `levelUpAlert`
67+
68+
**Type:** Boolean
69+
**Default:** `true`
70+
**Description:** When `true`, players receive a chat message when they level up a skill.
71+
72+
---
73+
74+
#### `benefitAlert`
75+
76+
**Type:** Boolean
77+
**Default:** `true`
78+
**Description:** When `true`, players receive a chat message when a skill benefit triggers.
79+
80+
---
81+
82+
### Skill Activation
83+
84+
Each skill can be individually activated or deactivated. Skills that are deactivated will not grant experience and will not trigger their benefits.
85+
86+
Skill activation states are stored under the `skills` key in `config.yml`:
87+
88+
```yaml
89+
skills:
90+
Mining:
91+
active: true
92+
Farming:
93+
active: false
94+
```
95+
96+
**Available skills and their config keys:**
97+
98+
| Skill | Config Key |
99+
|---|---|
100+
| Athlete | `skills.Athlete.active` |
101+
| Boating | `skills.Boating.active` |
102+
| Breeding | `skills.Breeding.active` |
103+
| Cardio | `skills.Cardio.active` |
104+
| Crafting | `skills.Crafting.active` |
105+
| Digging | `skills.Digging.active` |
106+
| Dueling | `skills.Dueling.active` |
107+
| Enchanting | `skills.Enchanting.active` |
108+
| Farming | `skills.Farming.active` |
109+
| Fishing | `skills.Fishing.active` |
110+
| Floriculture | `skills.Floriculture.active` |
111+
| Gliding | `skills.Gliding.active` |
112+
| Hardiness | `skills.Hardiness.active` |
113+
| Mining | `skills.Mining.active` |
114+
| Monster Hunting | `skills.Monster Hunting.active` |
115+
| Pyromaniac | `skills.Pyromaniac.active` |
116+
| Quarrying | `skills.Quarrying.active` |
117+
| Riding | `skills.Riding.active` |
118+
| Strength | `skills.Strength.active` |
119+
| Woodcutting | `skills.Lumberjack.active` |
120+
121+
> **Note:** Skill names with spaces (e.g., Monster Hunting) must be quoted as YAML keys, but the config path used by the plugin does **not** include quotes:
122+
> ```yaml
123+
> skills:
124+
> "Monster Hunting":
125+
> active: false
126+
> ```
127+
128+
> **Note:** The Woodcutting skill uses `Lumberjack` as its internal config key. Use `Lumberjack` when referencing it in `config.yml`. The `/ss force activate` and `/ss force deactivate` commands currently only accept single-word skill keys (e.g., `Lumberjack`, `Mining`) and cannot target skills whose names contain spaces such as `Monster Hunting`; toggle those via `config.yml` instead.
129+
130+
Skills can also be toggled at runtime using the admin commands `/ss force activate <skillName>` and `/ss force deactivate <skillName>` without restarting the server.
131+
132+
---
133+
134+
## message.yml
135+
136+
The `message.yml` file is located in `plugins/SimpleSkills/message.yml` on your server. It controls all user-facing messages displayed by the plugin.
137+
138+
### `message-version`
139+
140+
**Type:** String
141+
**Default:** `0.2`
142+
**Description:** Internal version identifier for the message file. Do not modify this manually.
143+
144+
---
145+
146+
### Message Keys
147+
148+
All message strings support Minecraft color codes using the `&` prefix (e.g., `&a` for green, `&b` for aqua, `&c` for red).
149+
150+
The following placeholders are available in specific messages:
151+
152+
| Placeholder | Used In | Description |
153+
|---|---|---|
154+
| `%version%` | `Default-Command` | The plugin version |
155+
| `%author%` | `Default-Command` | The plugin author |
156+
| `%nos%` | `Stats` | Number of skills |
157+
| `%nopr%` | `Stats` | Number of player records |
158+
| `%uns%` | `Stats` | Number of unknown skills |
159+
| `%skill%` | `NoTop`, `Top-Header` | Skill name |
160+
| `%rank%` | `Top-Body` | Player rank position |
161+
| `%player%` | `Top-Body`, `SendInfo-Header` | Player name |
162+
| `%top%` | `Top-Body` | Top player's level |
163+
| `%skill%` | `SendInfo-Body` | Skill name |
164+
| `%level%` | `SendInfo-Body`, `LevelUp` | Current skill level |
165+
| `%min%` | `SendInfo-Body` | Current experience |
166+
| `%max%` | `SendInfo-Body` | Experience required for next level |
167+
| `%skillname%` | `Skill-Info` | Skill name |
168+
| `%active%` | `Skill-Info` | Whether the skill is active |
169+
| `%mlevel%` | `Skill-Info` | Max level of the skill |
170+
| `%ber%` | `Skill-Info` | Base experience requirement |
171+
| `%eif%` | `Skill-Info` | Experience increase factor |

0 commit comments

Comments
 (0)