9
0
mirror of https://github.com/WiIIiam278/HuskSync.git synced 2025-12-22 08:09:20 +00:00
Files
HuskSync/docs/Commands.md
William 105f65c93a v3.0: New modular, more compatible data format, new API, better UX (#160)
* Start work on v3

* More work on task scheduling

* Add comment to notification display slot

* Synchronise branches

* Use new HuskHomes-style task system

* Bump to 2.3

* Remove HuskSyncInitializationException.java

* Optimise database for MariaDB

* Update libraries, move some around

* Tweak command registration

* Remove dummyhusksync

* Fixup core synchronisation logic to use new task system

* Implement new event dispatch subsystem

* Remove last remaining future calls

* Remove `Event#fire()`

* Refactor startup process

* New command subsystem, more initialization improvements, locale fixes

* Update docs, tweak command perms

* Reduce task number during data setting

* add todo

* Start work on data format / serialization refactor

* More work on Bukkit impl

* More serialization work

* Fixes to serialization, data preview system

* Start legacy conversion skeleton

* Handle setting empty inventories

* Start on-the-fly legacy conversion work

* Add advancement conversion

* Rewrite advancement get / apply logic

* Start work on locked map persistence

* More map persistence work

* More work on map serialization

* Move around persistence logic

* Add testing suite

* Fix item synchronisation

* Finalize more reliable locked map persistence

* Remove deprecated method call

* remove sync feature enum

* Fix held item slot syncing

* Make data types modular and API-extensible

* Remove some excessive debugging, minor refactor

* Fixup date formatting, improve menu UIs

* Finish up legacy data converting

* Null safety in item stack serializaiton

* Fix relocation of nbtapi, update dumping docs

* Add v1/MPDB Migrators back in

* Fix pinning/unpinning data not working

* Consumer instead of Function for editing data

* Show file size in DataSnapshotOverview

* Fix getIdentifier always returning empty

* Re-add items and inventory GUI commands

* Improve config file, fixup data restoration

* Add min time between backups (more useful backups!)

* More work on backups

* Fixup backup rotation frequency

* Remove stdout debug print in `#getEventPriority`

* Improve sync complete locale logic, fix synchronization spelling

* Remove `static` on exception

* Use dedicated thread for Redis, properly unsubscribe

* Refactor `player` package -> `user`

* `PlayerDataHolder` -> `UserDataHolder`

* Make `StatisticsMap` public, but `@ApiStatus.Internal`

* Suppress unused warnings on `Data`

* Add option to disable Plan hook

* Decompress legacy data before converting

* Decompress bytes in fromBytes

* Check permission node before serving TAB suggestions

* Actually convert legacy item stack data

* Fix syntax errors

* Minor method refactor in items command

* Fixup case-sensitive parsing in HuskSync command

* Start API work

* More work on API, fix potion effects

* Fix cross-server, config formatting for auto-pinned issue

* Fix confusion with UserData command, update docs images

* Update commands docs

* More docs updating

* Fix sync feature enabled/disabled checking logic

* Fix `#isCustom()`

* Enable persistent_data syncing by default

* docs: update Sync-Features config snippet

* docs: correct typo in Sync Features

* More API work

* bukkit: slightly optimized schedulers

* More API work, various refactorings

* docs: Start new API docs

* bump dependencies

* Add some basic unit tests

* docs: Correct typos

* More docs work, annotate DB methods as `@Blocking`

* Encapsulate `RedisMessage`, minor optimisations

* api: Simplify `#getCurrentData`

* api: Simplify `editCurrentData`, using `ThrowingConsumers` for better error handling

* docs: More Data Snapshot API documenting

* docs: add TOC to Data Snapshot API page

* bukkit: Make data types extend BukkitData

* Move where custom data is stored, finish up Custom Data API docs

* Optimise imports

* Fix `data_manager_advancements_preview_remaining` locale

* Fix advancement and playtime previews

* Fix potion effect deserialization

* Make snapshot_backup_frequency default to 4, more error handling/logging

* docs: Add ToC to Custom Data API

* docs: Minor legacy API tweaks

* Remove some unneeded catch logic

* Suppress a few warnings

* Fix Effect constructor being supplied in wrong order
2023-09-20 14:02:26 +01:00

97 lines
3.7 KiB
Markdown

This page contains a table of HuskSync commands and their required permission nodes. You can also use wildcard patterns for each command, such as `husksync.command.<command_name>.*` to grant access to all sub-commands.
<table>
<thead>
<tr>
<th colspan="2">Command</th>
<th>Description</th>
<th>Permission</th>
</tr>
</thead>
<tbody>
<!-- /husksync command -->
<tr>
<td rowspan="5"><code>/husksync</code></td>
<td><code>/husksync</code></td>
<td>View & manage plugin system information</td>
<td><code>husksync.command.husksync</code></td>
</tr>
<tr>
<td><code>/husksync about</code></td>
<td>View information about the plugin</td>
<td><code>husksync.command.husksync.about</code></td>
</tr>
<tr>
<td><code>/husksync reload</code></td>
<td>Reload the plugin configuration</td>
<td><code>husksync.command.husksync.reload</code></td>
</tr>
<tr>
<td><code>/husksync migrate</code></td>
<td>Migrate data from other plugins/legacy versions</td>
<td><i>(Console-only)</i></td>
</tr>
<tr>
<td><code>/husksync update</code></td>
<td>Check for plugin updates</td>
<td><code>husksync.command.husksync.update</code></td>
</tr>
<!-- /userdata command -->
<tr>
<td rowspan="7"><code>/userdata</code></td>
<td><code>/userdata</code></td>
<td>View & manage user data snapshots</td>
<td><code>husksync.command.userdata</code></td>
</tr>
<tr>
<td><code>/userdata list</code></td>
<td>View a list of a player's data snapshots</td>
<td><code>husksync.command.userdata.list</code></td>
</tr>
<tr>
<td><code>/userdata view</code></td>
<td>View a player's user data snapshot</td>
<td><code>husksync.command.userdata.view</code></td>
</tr>
<tr>
<td><code>/userdata restore</code></td>
<td>Restore a data snapshot for a user</td>
<td><code>husksync.command.userdata.restore</code></td>
</tr>
<tr>
<td><code>/userdata delete</code></td>
<td>Delete user data snapshots</td>
<td><code>husksync.command.userdata.delete</code></td>
</tr>
<tr>
<td><code>/userdata pin</code></td>
<td>Pin and unpin a user data snapshots</td>
<td><code>husksync.command.userdata.pin</code></td>
</tr>
<tr>
<td><code>/userdata dump</code></td>
<td>Dump a user data snapshot</td>
<td><code>husksync.command.userdata.dump</code></td>
</tr>
<!-- /inventory command -->
<tr>
<td rowspan="2" colspan="2"><code>/inventory</code></td>
<td>View the inventory of a user/a data snapshot</td>
<td><code>husksync.command.inventory</code></td>
</tr>
<tr>
<td>Edit the contents of a user's current inventory</td>
<td><code>husksync.command.inventory.edit</code></td>
</tr>
<!-- /enderchest command -->
<tr>
<td rowspan="2" colspan="2"><code>/enderchest</code></td>
<td>View the Ender Chest of a user/a data snapshot</td>
<td><code>husksync.command.enderchest</code></td>
</tr>
<tr>
<td>Edit the contents of a user's current Ender Chest</td>
<td><code>husksync.command.enderchest.edit</code></td>
</tr>
</tbody>
</table>