https://github.com/cao-awa/conium
Conium is a datapack and script framework for modern Minecraft, it provides very diverse features without Java coding, Conium lets you complete your mods only using datapacks.
https://github.com/cao-awa/conium
datapack fabric framework javascript kotlin-script minecraft minecraft-mod script scripting translation translator typescript
Last synced: 7 months ago
JSON representation
Conium is a datapack and script framework for modern Minecraft, it provides very diverse features without Java coding, Conium lets you complete your mods only using datapacks.
- Host: GitHub
- URL: https://github.com/cao-awa/conium
- Owner: cao-awa
- License: gpl-3.0
- Created: 2024-10-16T22:46:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-02T11:27:41.000Z (over 1 year ago)
- Last Synced: 2024-11-02T11:27:55.643Z (over 1 year ago)
- Topics: datapack, fabric, framework, javascript, kotlin-script, minecraft, minecraft-mod, script, scripting, translation, translator, typescript
- Language: Kotlin
- Homepage:
- Size: 513 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# What is Conium
> 新世代を呼ぶハロー、声はまだ途切れないだろう、 \
> 新世界の扉を、ほら叩き続けよう！
Conium is a datapack and script framework for modern Minecraft, it provides very diverse features without Java coding, Conium lets you complete your mods only using the datapacks.
## Warning
Conium is currently as 'on client' mode, the server needs to synchronize the datapacks and scripts to client but are not completed this feature now.
## Requirements
| Requirement | Version | Installs | Notes |
|-----------------------:|:---------------------:|:------------:|:----------------------------:|
| Java | 21+ | 21 Or higher | 21 Or higher is ok |
| Minecraft | >=1.21.6 | Need | 1.21.6 or higher can be use |
| Fabric language kotlin | 1.13.4+kotlin.2.2.0!! | Need | Only kotlin 2.2.0 can be use |
| Fabric API | ? | Need | Any version is ok |
| Fluxia | 1.1.4-fix4!! | Unnecessary | Built-in contents translator |
### Build requirements
Conium has configured whole project, just clone the repository, and reload project then run the gradle task ```remapJar```.
| Requirement | Version | Notes |
|------------:|:-------------:|:-----------------------------------:|
| Java | 21+ | 21 Or higher |
| Gradle | 8.14.2 | 8.14.2 or higher could be use |
| Kotlin | 2.2.0!! | Only 2.2.0 can be use |
| Fabric loom | 1.10-SNAPSHOT | 1.10-SNAPSHOT or other could be use |
| Minecraft | \>=1.21.6 | Only 1.21.6 or higher can be use |
### NeoForge
About supporting of NeoForge, currently cannot be completed because the secure jar handler in NeoForge has conflict to kotlin native.
And Conium cannot remove kotlin native because scripting running needs, Conium may try to run script evaluator without NeoForge environment in the future.
## Discord server
You can join ours [discord](https://discord.com/invite/BUY2xQr37N) server to chat with Conium community！
## Data driven
See the [Data driven](./document/data-driven/README.md)
## Conium script APIs
See the [Conium scripting](./document/script/kotlin/README.md).
## Bedrock script APIs
Not completed bedrock script APIs supports now, only framework able to run the samples.
### Grammars
About typescript grammar, supported by ```structring-translator``` or called ```fluxia```: [Typescript supports](https://github.com/cao-awa/structring-translator/tree/main/doc/typescript)
### APIs
Currently, there APIs are available:
In context:
| Name | Conium API type | Gametest API type | Status |
|-------:|:-------------------------------------------------------------------------------------------------------------------:|:-----------------:|:----------------:|
| system | [AbstractBedrockSystem](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/system/AbstractBedrockSystem.kt) | System | Alpha (Unstable) |
| world | [AbstractBedrockWorld](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/AbstractBedrockWorld.kt) | World | Alpha (Unstable) |
In APIs:
+ world
+ [AbstractBedrockWorld](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/AbstractBedrockWorld.kt) impl by [BedrockWorld](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/BedrockWorld.kt) as known as 'World' in SAPI
+ player
+ [BedrockPlayer](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/BedrockPlayer.kt) as known as 'Player' in SAPI
+ delegate
+ [BedrockPlayerDelegate](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/delegate/BedrockPlayerDelegate.kt) as known as 'Player[]' in SAPI
+ screen
+ [BedrockOnScreenDisplay](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/screen/BedrockOnScreenDisplay.kt) as known as 'ScreenDisplay' in SAPI
+ dimension
+ [BedrockDimensionLocation](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/dimension/BedrockDimensionLocation.kt) as known as 'DimensionLocation' in SAPI
+ system
+ [AbstractBedrockSystem](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/system/AbstractBedrockSystem.kt) impl by [BedrockSystem](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/system/BedrockSystem.kt) as known as 'System' in SAPI
+ item
+ stack
+ [BedrockItemStack](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/item/stack/BedrockItemStack.kt) as known as 'ItemStack' in SAPI
+ script
+ [BedrockScriptAnonymousObjectMap](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/item/stack/BedrockItemStack.kt) as known as 'anonymous object' in Javascript
+ event
+ [BedrockBeforeEvents](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/event/BedrockBeforeEvents.kt) as known as 'WorldBeforeEvents' in SAPI
+ context
+ [BedrockEventContext](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/event/context/BedrockEventContext.kt)
+ item
+ use
+ [BedrockItemUseOnEventContext](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/event/context/item/use/BedrockItemUseOnEventContext.kt) as known as 'ItemUseOnBeforeEvent' and 'ItemUseOnAfterEvent' in SAPI
+ item
+ use
+ [BedrockItemUseOnBeforeEvent](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/event/before/item/use/on/BedrockItemUseOnBeforeEvent.kt) as known as 'ItemUseOnBeforeEventSignal' in SAPI
By bedrock script APIs:
+ [world](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/AbstractBedrockWorld.kt)
+ ```fun``` [getPlayers()](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/AbstractBedrockWorld.kt): [BedrockPlayerDelegate](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/delegate/BedrockPlayerDelegate.kt)
+ ```operator fun``` [get](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/delegate/BedrockPlayerDelegate.kt): [BedrockPlayer](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/BedrockPlayer.kt)(index: Int)
+ ```val``` [onScreenDisplay](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/delegate/BedrockPlayerDelegate.kt): [BedrockOnScreenDisplay](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/screen/BedrockOnScreenDisplay.kt)
+ ```fun``` [setTitle](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/screen/BedrockOnScreenDisplay.kt)(title: String, properties: [BedrockScriptAnonymousObjectMap](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/script/BedrockScriptAnonymousObjectMap.kt))
+ ```fun``` [updateSubtitle](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/player/screen/BedrockOnScreenDisplay.kt)(title: String)
+ ```val``` [eventsBefore](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/world/AbstractBedrockWorld.kt) = ```get()```: [BedrockBeforeEvents](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/event/BedrockBeforeEvents.kt)
+ ```val``` [itemUseOn](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/event/BedrockBeforeEvents.kt): [BedrockItemUseOnEvent](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/event/item/use/BedrockItemUseOnBeforeEvent.kt)
+ ```fun``` [subscribe](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/event/item/use/BedrockItemUseOnBeforeEvent.kt)(action: ([BedrockItemUseOnEventContext](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/event/context/item/use/BedrockItemUseOnEventContext.kt)) ->
Unit)
+ [system](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/system/AbstractBedrockSystem.kt)
+ ```fun``` [runInterval](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/system/AbstractBedrockSystem.kt)(callback: () -> Unit, tickInterval: Int): IntegerReceptacle
+ ```fun``` [clearRun](./common/src/main/kotlin/com/github/cao/awa/conium/bedrock/system/AbstractBedrockSystem.kt)(runId: IntegerReceptacle)
# Source code and commit
Conium has large and complex source codes and architectures.\
Read source codes still very challenging even though we are completing documents and comments try we best.
So if you are willing to contribute to Conium, please do conversations with Conium developers to learn the details and specifications.\
We will reject all pull requests that not after discussion.
If it is not necessary, avoid directly reading source codes.
## Hitokoto
Conium will randomly roll a [Hitokoto](https://en.wiktionary.org/wiki/%E4%B8%80%E8%A8%80#Japanese) in console every time launching, the list of Hitokotos receives pull requests, only allow in English and Japanese, don't take other languages, don't accept nonsense sentences.
For the list, see [ConiumHitokoto.kt](/common/src/main/java/com/github/cao/awa/conium/hitokoto/ConiumHitokoto.kt).
# Chinese wiki
The [Hyacinth wiki](https://www.hyacinthwiki.com/index.php?title=Conium_(模组)).