Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

v3.0: New modular, more compatible data format, new API, better UX #160

Merged
merged 114 commits into from
Sep 20, 2023
Merged

v3.0: New modular, more compatible data format, new API, better UX #160

merged 114 commits into from
Sep 20, 2023

Conversation

WiIIiam278
Copy link
Owner

@WiIIiam278 WiIIiam278 commented Aug 30, 2023 •
edited
Loading

This is the working PR for the v3-work branch, which will update HuskSync to v3.0

HuskSync v3.0 consists of a fairly large rewrite of a significant slice of the plugin. It aims to bring:

  • A new data format - v4 - which is more modular, should better support custom item plugins (such as MMOItems) through the use of NBTAPI, features improved Locked Map syncing, and help pave the way for a fabric port of the plugin
  • A new, more expansive API to support the above -- including the ability to allow developers to register custom data serializers to sync their data in HuskSync's tried and tested Data Snapshot format
  • A better user experience, including an option to ensure snapshots are only made every x number of hours, and improved menus
  • (Maybe -- depending on various things) Folia support

Other stuff:

  • There's now a test suite (/test/) for much more easy and reproducible debugging of the plugin through a script to spin up a network.
  • The plugin now uses HuskHomes' improved Task system, with much more stable asynchronous offloading of expensive logic. No more CompletableFuture#runAsync.
  • On-the-fly conversion from the v3 data format.

WiIIiam278 added 24 commits May 10, 2023 13:49
@WiIIiam278
Start work on v3
ad42a4e
@WiIIiam278
Merge branch 'master' into v3-work
4d6950e 
# Conflicts:
#	bukkit/src/main/java/net/william278/husksync/player/BukkitPlayer.java
#	common/src/main/java/net/william278/husksync/HuskSync.java
#	common/src/main/java/net/william278/husksync/command/EnderChestCommand.java
#	common/src/main/java/net/william278/husksync/command/InventoryCommand.java
#	common/src/main/java/net/william278/husksync/command/UserDataCommand.java
#	common/src/main/java/net/william278/husksync/config/Settings.java
#	common/src/main/java/net/william278/husksync/data/StatusDataFlag.java
#	common/src/main/java/net/william278/husksync/database/MySqlDatabase.java
#	common/src/main/java/net/william278/husksync/player/OnlineUser.java
@WiIIiam278
More work on task scheduling
3bc7476
@WiIIiam278
Add comment to notification display slot
d5483ec
@WiIIiam278
Merge branch 'master' into v3-work
1838689 
# Conflicts:
#	bukkit/src/main/java/net/william278/husksync/BukkitHuskSync.java
#	common/src/main/java/net/william278/husksync/config/Settings.java
#	common/src/main/java/net/william278/husksync/data/StatusDataFlag.java
#	common/src/main/java/net/william278/husksync/database/MySqlDatabase.java
@WiIIiam278
Synchronise branches
e227ec9
@WiIIiam278
Use new HuskHomes-style task system
5b41eb2
@WiIIiam278
Bump to 2.3
f54c740
@WiIIiam278
Remove HuskSyncInitializationException.java
c208410
@WiIIiam278
Optimise database for MariaDB
0af5b6e
@WiIIiam278
Update libraries, move some around
41f4ac9
@WiIIiam278
Tweak command registration
63ac769
@WiIIiam278
Remove dummyhusksync
41cfad1
@WiIIiam278
Merge branch 'master' into v3-work
ee734e3 
# Conflicts:
#	bukkit/src/main/java/net/william278/husksync/player/BukkitPlayer.java
#	common/src/main/java/net/william278/husksync/HuskSyncInitializationException.java
#	common/src/main/java/net/william278/husksync/database/Database.java
#	common/src/main/java/net/william278/husksync/database/MySqlDatabase.java
#	gradle.properties
@WiIIiam278
Fixup core synchronisation logic to use new task system
7a5a0c7
@WiIIiam278
Implement new event dispatch subsystem
22b6b44
@WiIIiam278
Remove last remaining future calls
4d3b3f7
@WiIIiam278
Remove Event#fire()
26660b9
@WiIIiam278
Merge branch 'master' into v3-work
cf6eb39 
# Conflicts:
#	gradle.properties
@WiIIiam278
Refactor startup process
4bb8cc2
@WiIIiam278
New command subsystem, more initialization improvements, locale fixes
9df5f37
@WiIIiam278
Update docs, tweak command perms
bb6766b
@WiIIiam278
Reduce task number during data setting
cc829f8
@WiIIiam278
add todo
e9d21d0
@WiIIiam278 WiIIiam278 self-assigned this Aug 30, 2023
@WiIIiam278
Enable persistent_data syncing by default
fa2ed18
@WiIIiam278
docs: update Sync-Features config snippet
6d9d50d
@WiIIiam278
docs: correct typo in Sync Features
6badf47
@WiIIiam278
More API work
e5dd287
@WiIIiam278
bukkit: slightly optimized schedulers
5d34b5d
@WiIIiam278
More API work, various refactorings
06ef4cb
@WiIIiam278
docs: Start new API docs
a3e414f
@WiIIiam278
bump dependencies
be695ab
@WiIIiam278
Add some basic unit tests
a1b14a7
@WiIIiam278
docs: Correct typos
bedd622
@WiIIiam278
More docs work, annotate DB methods as @Blocking
3f6952e
@WiIIiam278
Encapsulate RedisMessage, minor optimisations
f28e4e1
@WiIIiam278
api: Simplify #getCurrentData
3bb5074
@WiIIiam278
api: Simplify editCurrentData, using ThrowingConsumers for better…
67877d8 
… error handling
@WiIIiam278
docs: More Data Snapshot API documenting
b721e17
@WiIIiam278
docs: add TOC to Data Snapshot API page
e97c366
@WiIIiam278
bukkit: Make data types extend BukkitData
9e2aec7
@WiIIiam278
Move where custom data is stored, finish up Custom Data API docs
38b1fcd
@WiIIiam278
Optimise imports
a8c31c9
@WiIIiam278
Fix data_manager_advancements_preview_remaining locale
b0755a8
@WiIIiam278
Fix advancement and playtime previews
12e4f29
@WiIIiam278
Fix potion effect deserialization
97e61ad
@WiIIiam278
Make snapshot_backup_frequency default to 4, more error handling/logging
06b70b1
@WiIIiam278
docs: Add ToC to Custom Data API
496a55e
@WiIIiam278
docs: Minor legacy API tweaks
4d94a5e
@WiIIiam278
Remove some unneeded catch logic
46afc8f
@WiIIiam278
Suppress a few warnings
30c13c3
@WiIIiam278
Fix Effect constructor being supplied in wrong order
166e5ed
@WiIIiam278 WiIIiam278 merged commit 105f65c into master Sep 20, 2023
1 check passed
@WiIIiam278 WiIIiam278 deleted the v3-work branch September 22, 2023 12:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@WiIIiam278 WiIIiam278

Labels
status: in progress This issue is in progress
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@WiIIiam278