You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+2-47
Original file line number
Diff line number
Diff line change
@@ -11,49 +11,9 @@
11
11
12
12
#### This project consists on an advanced Skyblock core made to scale massively.
13
13
14
-
To start, the plugin requires a SQL connection, used to store the islands and all the player data If you do not have/need a SQL connection, change the storage type to SQLITE on the config.yml file
15
-
16
-
Best paired with my [DataSync Plugin](https://github.com/IllusionTheDev/DataSync), which handles inventory, food, enderchest, potion synchronization and more!
17
-
18
-
------------
19
-
20
-
### Known issues:
21
-
- Default .mca file is 1.17.1+ (Possible fix: Start the server on 1.17.1, replace start-schematic/r.0.0.mca file with a new island schematic, delete all worlds and change versions)
22
-
- FAWE doesn't work (Has to do with versioning)
23
-
24
-
I am aware of both issues, and aim to release fixes soon, please do not annoy me about them.
25
-
26
-
------------
27
-
28
-
### Setup instructions:
29
-
- Load the plugin into an empty server
30
-
- Set the storage database info into the config.yml file (Available types: Amazon S3, MySQL, SQLite, MongoDB, Flat-file (creates multiple files on a folder))
31
-
- Restart
32
-
- Configure to your liking
33
-
34
-
#### If you're running SlimeWorldManager:
35
-
- Ensure that SlimeWorldManager saves to `file`, as SkyblockCore handles world serialization automatically
36
-
- Set the pasting type to SLIME, otherwise things will break
37
-
- Restart
38
-
- Test thoroughly
39
-
40
-
#### If on a proxy:
41
-
- Put the plugin on the proxy's plugins folder, as well as set-up each instance with the steps above.
42
-
- Set the storage info into the bungee-config.yml file (note that instances should also be running on the same database, file-based databases are naturally unsupported in bungee mode)
43
-
- Restart
44
-
45
-
#### If you're running multiple proxies (Requires Redis):
46
-
- Put the plugin on each proxy and instance
47
-
- Set them all to use the same database
48
-
- On each proxy, also set the communication database details (Redis by default, RabbitMQ and a native Socket-based system coming soon)
49
-
- Restart all proxies (If you don't have database drivers, you're going to have to restart twice)
50
-
51
-
------------
52
-
53
-
## Technical Aspects:
54
-
55
-
Now available on the [Wiki](https://github.com/IllusionTheDev/SkyblockCore/wiki#technical-aspects)!
14
+
This project is currently being rewritten. This rewrite is due to just a massive change in code architecture with new knowledge that I've learned by writing scalable plugins for the past 3 years.
56
15
16
+
This project's backbone is [Cosmos](https://github.com/IllusionTheDev/Cosmos/), and at the moment is under heavy development, with no builds available.
57
17
58
18
------------
59
19
@@ -67,21 +27,16 @@ Now available on the [Wiki](https://github.com/IllusionTheDev/SkyblockCore/wiki#
67
27
- MongoDB
68
28
69
29
#### Plugin Hooks
70
-
- Vault
71
30
- FastAsyncWorldEdit
72
-
- SlimeWorldManager
73
31
74
32
75
33
------------
76
34
77
35
### Some thoughts:
78
36
SkyblockCore is incredibly difficult to develop, unlike a regular core, there is a lot of thought put into every line of code, the plugin is supposed to expect players switching across servers, proxies, players leaving mid-loading, different proxies for the same team members, all of it while handling all of the commands on the spigot side, so players on a survival server can't run skyblock commands.
79
37
80
-
It might not seem like it, but this project is absolutely massive on its current state, and I'd say it's about 20% done.
81
-
82
38
If you'd like to help with the project, even as someone without any code experience, here are some things that would greatly help me out:
0 commit comments