Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevertus/objd
objD is a framework for developing Datapacks for Minecraft. It uses the Dart programming language.
https://github.com/stevertus/objd
commands dart datapack framework generator mapmaking minecraft
Last synced: 3 days ago
JSON representation
objD is a framework for developing Datapacks for Minecraft. It uses the Dart programming language.
- Host: GitHub
- URL: https://github.com/stevertus/objd
- Owner: Stevertus
- License: bsd-2-clause
- Created: 2019-02-03T14:57:58.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-04T21:04:23.000Z (4 months ago)
- Last Synced: 2025-01-30T03:11:34.646Z (3 days ago)
- Topics: commands, dart, datapack, framework, generator, mapmaking, minecraft
- Language: Dart
- Homepage: https://objd.stevertus.com
- Size: 1.15 MB
- Stars: 47
- Watchers: 6
- Forks: 13
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# objD
### **O**bjective **B**uilder **J**ust for **D**atapacks
[objD](https://objd.stevertus.com) is an object oriented toolkit for building/generating Datapacks for Minecraft. It uses the [Dart](https://www.dartlang.org/guides/language/language-tour) programming language and thus integrates into popular editors like [Visual Studio Code](https://code.visualstudio.com) or [IntelliJ](https://www.jetbrains.com/idea/).
You are able to write **modular** Datapacks, get suggestions with **linting**, **auto completion**, extensive [documentation](https://objd.stevertus.com) and **syntax highlighting**.
No need to remember which parameters commands take, automatic checking of your code and a ton of [utility widgets](https://objd.stevertus.com/utils/) help you to get more efficient creating Datapacks.
## Resources
objD has many components. But there are a few things that can accelerate your start.
- [Introductory Video](https://youtu.be/0GfuCUNI1pw) showing everything from project structure, editor setup to installation.
- [Officical Documentation](https://objd.stevertus.com)
- YouTube [Playlist](https://www.youtube.com/playlist?list=PL5AxRIlgrL5GnKz69w4AUyqpZC35BlxdD) containing over 40 videos on best practices, widgets, generators and more.
- Starter Guide as written form: https://objd.stevertus.com/guide/
- [Discord Server](https://discord.gg/mKFrqfA) for general questions and interaction
- GitHub [Discussions](https://github.com/Stevertus/objD/discussions) for ideas, issues and questions
## Installation
You need the Dart SDK for this library. Download and install it from https://www.dartlang.org/tools/sdk
I would also recommend Visual Studio Code along with the [dart plugin](https://marketplace.visualstudio.com/items?itemName=Dart-Code.dart-code) to edit dart files very conveniently.
To get started, it is the easiest to use the _objD CLI_ for generating a sample project, make small changes and let it run with hot reload.
Install it using
```bash
dart pub global activate objd_cli
```
You can then invoke the new command to create your project, follow the instructions:
```bash
dart pub global run objd_cli new
```
Go into the created directory `cd ` and to install all dependencies run
```bash
dart pub get
```
For further explanations, refer to the [Intro Video](https://youtu.be/0GfuCUNI1pw), where this is presented in depth.
## Example
objD is all about nesting, abstracting the sequential nature of commands into so called [Widgets](https://objd.stevertus.com/basics/#widget) and allowing powerful combinations.
```dart
For(
from: 0,
to: n,
create: (i) => ArmorStand(
Location.rel(x: i.toDouble()),
name: TextComponent("Number $i"),
nameVisible: true,
pose: Pose(
head: [360 * i / n - 180],
),
),
),
```
This simple example creates n armor stands(depending on a variable) each with custom names and pose.
Where in vanilla commands you would have to change multiple commands, this approach is **flexible** and can easily controlled by parameters.
## Updating
When updating to a new version, change the version tag of objD in the `pubspec.yaml` file.
> *Note:* also make sure the dart version requirements match the version requirements of objD. For 0.4.5 onwards, Dart `3.0.0` is required.
```yaml
name:
environment:
sdk: ">=3.0.0 <4.0.0"
dependencies:
objd: ^0.4.7
dev_dependencies:
build_runner:
objd_gen: ^0.0.4
```
## Contributing & Bugs
New and fresh ideas are always welcome and greatly appreciated. Please create a [pull request](https://github.com/Stevertus/objD/pulls)to organize new additions.
Bugs can be reported using [GitHub Issues](https://github.com/Stevertus/objD/issues).
Huge thanks to everyone who participated and made objD a better tool ❤.