bc-deeplib 1.1.2 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -2
- package/dist/deeplib.d.ts +386 -31
- package/dist/deeplib.js +447 -88
- package/dist/deeplib.js.map +3 -3
- package/dist/public/dl_translations/en.lang +10 -0
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/dist/vendored_types/declarations.d.ts +40 -0
- package/lib/build.js +13 -0
- package/package.json +1 -1
- package/dist/3rd_party_types/bcmodsdk.d.ts +0 -184
- package/dist/3rd_party_types/declarations.d.ts +0 -4
- package/dist/index.js +0 -2556
- package/dist/index.js.map +0 -7
- package/dist/public/dl_images/cog.svg +0 -1
- package/dist/public/dl_images/round_arrow_left.svg +0 -1
- package/dist/public/dl_images/round_arrow_right.svg +0 -1
- package/dist/public/dl_images/round_transfer.svg +0 -7
package/README.md
CHANGED
|
@@ -1,2 +1,26 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
# ${{\color{#440171}\Large{\textsf{DeepLib}}}}$
|
|
2
|
+
## Active development (there might be a lot of breaking changes)
|
|
3
|
+
|
|
4
|
+
## What is DeepLib?
|
|
5
|
+
|
|
6
|
+
DeepLib is an opinionated library for easier development of BC mods, which strives to be a framework :D
|
|
7
|
+
|
|
8
|
+
## What it has to offer
|
|
9
|
+
|
|
10
|
+
* **Mod Initialization**: The `initMod()` function allows you to initialize a mod, which includes setting up the Mod SDK, initializing localization, and registering modules and migrators.
|
|
11
|
+
|
|
12
|
+
* **Modules**: provides a modular architecture, allowing you to create modules for different aspects of your mod.
|
|
13
|
+
|
|
14
|
+
* **Settings GUI**: provides an easily configurable HTML-based GUI system for creating different sorts of settings screens with a lot of built-in features.
|
|
15
|
+
|
|
16
|
+
* **Localization**: provides a localization system for creating different languages for your mod.
|
|
17
|
+
|
|
18
|
+
* **Migrators**: provides a migrator system for creating different migrations for your mod for easy transition between versions.
|
|
19
|
+
|
|
20
|
+
* **Hidden Events**: provides a hidden event system for sending and listening to events with help of `EventChannel`.
|
|
21
|
+
|
|
22
|
+
* **Out-Of-Box Themed Support**: custom elements support Themed customizations.
|
|
23
|
+
|
|
24
|
+
* **Build System**: provides a build system for easily building your mod with `esbuild`.
|
|
25
|
+
|
|
26
|
+
Take a look at [QUICKSTART.md](docs/QUICKSTART.md) for more information on how to get started.
|