Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yancey2023/chelper-core
A command IDE for Minecraft Bedrock Edition.
https://github.com/yancey2023/chelper-core
bedrock-edition minecraft minecraft-command
Last synced: 2 months ago
JSON representation
A command IDE for Minecraft Bedrock Edition.
- Host: GitHub
- URL: https://github.com/yancey2023/chelper-core
- Owner: Yancey2023
- License: gpl-3.0
- Created: 2023-12-01T17:40:08.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-29T02:18:57.000Z (5 months ago)
- Last Synced: 2024-08-29T03:31:37.543Z (5 months ago)
- Topics: bedrock-edition, minecraft, minecraft-command
- Language: C++
- Homepage:
- Size: 2.91 MB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CHelper
I want to make a command helper for Minecraft Bedrock Edition , so here is CHelper, which means Command Helper.
## Clone Project
```bash
git clone --recursive https://github.com/Yancey2023/CHelper-Core
# if you clone it without --recursive, you should run the following:
cd CHelper-Core
git submodule update --init --recursive --progress
```
## Multi-platform
| project | description |
|:----------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------:|
| [CHelper-Core](https://github.com/Yancey2023/CHelper-Core) | CHelper-Core is the core of CHelper, written in c++ |
| [CHelper-Android](https://github.com/Yancey2023/CHelper-Android) | CHelper-Android is the Android version of the app, depends on [CHelper-Core](https://github.com/Yancey2023/CHelper-Core) |
| [CHelper-Web](https://github.com/Yancey2023/chelper_web) | CHelper-Web is the web version of the app, depends on [CHelper-Core](https://github.com/Yancey2023/CHelper-Core) |
| [CHelper-Qt](./CHelper-Qt) | maintain in [CHelper-Core](https://github.com/Yancey2023/CHelper-Core) for development and debugging purpose |
## Usage
### Help in editing command
When you are inputting command, the app will show you command structure, meaning of the command param you are editing,
errors of the command, and suggestions to help you complete command. It also supports syntax highlight.
### Help in converting old version command to new version command
Dur to the Minecraft updates, some command has been changed.
It supports convert block data value to block state, and so on.
old command example:
```mcfunction
execute @a ~ ~-1 ~ detect ~ ~-1 ~ stone 2 setblock ~ ~ ~ command_block 2
```
new command example:
```mcfunction
execute as @a at @s positioned ~ ~-1 ~ if block ~ ~-1 ~ stone["stone_type"="granite_smooth"] run setblock ~ ~ ~ command_block["facing_direction"=2,"conditional_bit"=false]
```
## Try it
> Note: This app is mainly aimed at Chinese users, so the language is Chinese. You can help me support more languages.
CHelper-Web:
CHelper-Web lacks some function. To experience more complete functions, please
use [CHelper-Android](https://github.com/Yancey2023/CHelper-Android).
## CPack Document
Cpack(Command Pack) is the resource pack of CHelper(Command Helper).
[English](CHelper-Resource/doc/README.md)
[Chinese](CHelper-Resource/doc/README_CN.md)
## Plan
The desired function has been completed, and the new function to be developed is yet to be determined.
- [x] **CPack** - a resource pack containing IDs and commands
- [x] **Lexer** - transforms command strings into a token list
- [x] **Parser** - builds an Abstract Syntax Tree (AST) and find structural errors
- [x] **ID Error** - finds ID errors based on the AST
- [x] **Description** - get the description of the currently written command param based on the AST
- [x] **Suggestion** - get completion suggestions based on the AST
- [x] **Structure** - get command structure string based on the AST
- [x] **Target Selector Support** - support target selector command param
- [x] **Json Support** - support json command param
- [x] **Block State Support** - support block states command param
- [x] **Old 2 New** - convert old command to new command
- [x] **Syntax Highlight** - get the highlight color for displayed commands
## Third-party
### CHelper-Core
| project | description | license |
|:----------------------------------------------:|:----------------------------------------------------------------------------------:|:------------------------------------------------------------------------:|
| [fmt](https://github.com/fmtlib/fmt) | formatting library | [MIT license](https://github.com/fmtlib/fmt/blob/master/LICENSE) |
| [json](https://github.com/nlohmann/json) | JSON for Modern C++ | [MIT license](https://github.com/nlohmann/json/blob/master/LICENSE.MIT) |
| [utfcpp](https://github.com/nemtrif/utfcpp) | UTF-8 with C++ in a Portable Way | [BSL-1.0 license](https://github.com/nemtrif/utfcpp/blob/master/LICENSE) |
| [Hedley](https://github.com/Yancey2023/hedley) | enable compiler-specific features while retaining compatibility with all compilers | [CC0 1.0](https://github.com/Yancey2023/hedley/blob/master/LICENSE) |
### CHelper-Qt
| project | description | license |
|:------------------------:|:-----------------------------:|:------------------------------------------------:|
| [Qt](https://www.qt.io/) | desktop application framework | [LGPL license](https://doc.qt.io/qt-6/lgpl.html) |
### CHelper-Android
| project | description | license |
|:----------------------------------------:|:------------------------------:|:------------------------------------------------------------:|
| [NDK](https://developer.android.com/ndk) | android native development kit | [Apache License](http://www.apache.org/licenses/LICENSE-2.0) |
### CHelper-Web
| project | description | license |
|:------------------------------------:|:------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------:|
| [Emscripten](https://emscripten.org) | complete compiler toolchain to WebAssembly | [the MIT license and the University of Illinois/NCSA Open Source License](https://github.com/emscripten-core/emscripten/blob/main/LICENSE) |
### CHelper-Test
| project | description | license |
|:--------------------------------------------------:|:---------------------------:|:-------------------------------------------------------------------------------------------------:|
| [GoogleTest](https://github.com/google/googletest) | Google's C++ test framework | [BSD 3-Clause "New" or "Revised" License](https://github.com/google/googletest/blob/main/LICENSE) |
## Special Thanks
| project | description | license |
|:---------------------------------------------------:|:----------------------------------------------------------:|:----------------------------------------------------------------------------:|
| [caidlist](https://github.com/XeroAlpha/caidlist) | provide IDs and descriptions for Minecraft Bedrock Edition | [GPL-3.0 license](https://github.com/XeroAlpha/caidlist/blob/master/LICENSE) |
| [chinese minecraft wiki](https://zh.minecraft.wiki) | provide information in Minecraft | [CC BY-NC-SA 3.0](https://creativecommons.org/licenses/by-nc-sa/3.0) |
- JetBrains License for Open Source Development
