Skip to content

Commit c0169d3

Browse files
committed
chore: readme and descripion changes
1 parent f52a81b commit c0169d3

3 files changed

Lines changed: 24 additions & 13 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
!gradle/wrapper/gradle-wrapper.jar
1515

1616
kls_database.db
17+
AGENTS.md
1718

1819

1920
velocity/bin/

DESCRIPTION.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,38 +33,46 @@ Everything runs through scripts. You create a `.yml` file, define the command na
3333
Here is a quick example. This registers `/alert` on the proxy and broadcasts a message to two backends as console:
3434

3535
```yaml
36-
version: 3
37-
name: alert
38-
description: Broadcast an alert to all servers
36+
version: 4
37+
38+
name: example
39+
description: An example command script - edit or replace this with your own
40+
enabled: false
41+
aliases: [ex]
3942

4043
permissions:
41-
enabled: true
44+
enabled: true
4245
silent: false
4346

4447
register:
45-
- id: "proxy-1"
48+
- id: "client-1"
4649
location: VELOCITY
4750

4851
defaults:
4952
run-as: CONSOLE
5053
execute:
51-
- id: "lobby"
52-
location: BACKEND
53-
- id: "survival"
54+
- id: "survival-1"
5455
location: BACKEND
5556
server:
5657
target-required: false
5758
schedule-online: false
58-
delay: 0s
59+
player-arg: ""
60+
delay: 0s
5961
cooldown: 0s
6062

6163
args:
64+
- name: player
65+
required: true
66+
type: STRING
67+
suggestions: []
68+
6269
- name: message
6370
required: true
64-
type: GREEDY_STRING
71+
type: TEXT
72+
suggestions: []
6573

6674
commands:
67-
- command: "say [Alert]: ${message}"
75+
- command: "msg ${player} ${message}"
6876
```
6977
7078
That's a real script. You can do a lot more than that, but this shows how simple the basics are.

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,12 @@ git checkout v3
108108
- [x] `/cb list`
109109
- [x] `/cb ping`
110110
- [x] `/cb debug`
111-
- [ ] `/cb dump`
111+
- [x] `/cb dump`
112+
- [x] `/cb migrate`
112113
- [x] Dual-mode output (chat and console)
113114
- [x] Automatic update checker
114-
- [ ] Dump export to file or paste service
115+
- [x] Dump export to file or paste service
116+
- [x] Migration implementation for scripts
115117
- [x] bstats
116118

117119
- [ ] **Web Interface**

0 commit comments

Comments
 (0)