Skip to content

Commit db7f1e6

Browse files
committed
readme and header updates
1 parent e5bae83 commit db7f1e6

File tree

2 files changed

+20
-33
lines changed

2 files changed

+20
-33
lines changed

README.md

Lines changed: 10 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,14 @@ Denizen Models
33

44
**Denizen Models**, aka **dModels**, is a tool that can take [BlockBench](https://www.blockbench.net/) "generic" models and render them in minecraft, including with full animations, by spawning sets of armor stands.
55

6-
This takes the form of two components:
7-
8-
- DenizenModelsConverter
9-
- `DenizenModelsConverter.sln` and the `DenizenModelsConverter` directory
10-
- External program, written in C#
11-
- Needs to be compiled via Visual Studio 2022
12-
- Only tested on Windows 11 currently, but theoretically works anywhere
13-
- Requires .NET 6 to run
14-
- takes the `.bbmodel` file and converts it into two output files
15-
- A resource pack for clients
16-
- A `.dmodel.yml` file for the Minecraft server to read
17-
- Planned to eventually be replaced by entirely on-server Denizen scripts eventually, with automated pack location selection and all, instead of the manual process with external programs
18-
- USAGE: Command line!
19-
- `./DenizenModelsConverter.exe make_pack [bbmodel_file] [pack_path] [model_path] [texture_path]` Puts a model into a resource pack, must specify model and texture path within the pack.
20-
- Example: `./DenizenModelsConverter.exe make_pack goat.bbmodel creaturepack creatures/goat creatures/goat` This example parses a 'goat' model and puts it in reasonable paths, using by default `arrow` as the item to add onto.
21-
- The Denizen script
22-
- `scripts/` directory `.dsc` files
23-
- Runs on your minecraft server using [Denizen](https://github.com/DenizenScript/Denizen)
24-
- Reads the `.dmodel.yml` file
25-
- Can spawn the models and animate them
6+
As the name implies, this relies on [Denizen](https://github.com/DenizenScript/Denizen).
7+
8+
There are three scripts:
9+
10+
- `dmodels_main.dsc` is the 'main' file - it contains a detailed informational header with usage details, and a configuration section.
11+
- Look through that file to learn how to use dModels.
12+
- `dmodels_loader.dsc` is the script that handles loading in `.bbmodel` files to Denizen and building the resource pack.
13+
- `dmodels_spawning.dsc` is the API script that actually handles the spawning/moving/animating/etc of models in-game.
2614

2715
### Related Links
2816

@@ -32,11 +20,11 @@ This takes the form of two components:
3220

3321
### Script Usage
3422

35-
Documented in the header of the `dmodels.dsc` script.
23+
Documented in the header of the `dmodels_main.dsc` script.
3624

3725
### Status
3826

39-
Initial beta release. Functions for testing purposes, but not the most user friendly. A lot more is planned for this.
27+
Secondary beta release. Functions for testing purposes, but not the most user friendly. A lot more is planned for this. Some things are currently being changed around from what they were in the prior beta.
4028

4129
### Licensing pre-note:
4230

scripts/dmodels_main.dsc

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,8 @@
1515
# then is able to display them in minecraft and even animate them, by spawning and moving invisible armor stands with resource pack items on their heads.
1616
#
1717
# Installation:
18-
# 1: Add "models.dsc" to your "plugins/Denizen/scripts" and "/ex reload"
19-
# 2: Make sure you have DenizenModelsConverter.exe on hand, either downloaded or compiled yourself from https://github.com/mcmonkeyprojects/DenizenModels
20-
# 3: Note that you must know the basics of operating resource packs - the pack content will be generated for you, but you must know how to configure the "mcmeta" pack file and how to install a pack on your client
18+
# 1: Copy the "scripts/dmodels" folder to your "plugins/Denizen/scripts" and "/ex reload"
19+
# 3: Note that you must know the basics of operating resource packs - the pack content will be generated for you, but you must know how to install a pack on your client and/or distribute it to players as appropriate
2120
# 4: Take a look at the config settings in the bottom of this file in case you want to change any of them.
2221
#
2322
# Usage:
@@ -28,19 +27,19 @@
2827
# meaning you cannot have a section of block more than 36 blockbench units from its pivot point.
2928
# If you need a larger object, add more Outliner groups with pivots moved over.
3029
# 1.4 Make sure pivot points are as correct as possible to minimize glitchiness from animations
31-
# (for example, if you have a bone pivot point in the center of a block, but the block's own pivot point is left at default 0,0,0, this can lead to the armor stand having to move and rotate at the same time, and lose sync when doing so)
30+
# (for example, if you have a bone pivot point in the center of a block, but the block's own pivot point is left at default 0,0,0, this can lead to the armor stand having to move and rotate at the same time, and lose sync when doing so)
3231
# 1.5 Animate freely, make sure the animation names are clear
33-
# 2: Save the ".bbmodel" file
34-
# 3: Use the DenizenModelsConverter program to convert the bbmodel to a ".dmodel.yml" and a resource pack
35-
# 4: Save the ".dmodel.yml" file into "plugins/Denizen/data/models"
36-
# 5: Load the resource pack on your client (or include it in your server's automatic resource pack)
37-
# 6: Spawn your model and control it using the Denizen scripting API documented below
32+
# 2: Save the ".bbmodel" file into "plugins/Denizen/data/dmodels"
33+
# 3: Load the model. For now, just do a command like "/ex run dmodels_load_bbmodel def:GOAT" but replace "GOAT" with the name of your model
34+
# This will output a resource pack to "plugins/Denizen/data/dmodels/res_pack/"
35+
# 4: Load the resource pack on your client (or include it in your server's automatic resource pack)
36+
# 5: Spawn your model and control it using the Denizen scripting API documented below
3837
#
3938
# #########
4039
#
4140
# API usage examples:
42-
# # First load a model
43-
# - ~run dmodels_load_model def.model_name:goat
41+
# # First load a model (in advance, not every time - you can use '/ex' to do this once after adding or modifying the .bbmodel file)
42+
# - ~run dmodels_load_bbmodel def.model_name:goat
4443
# # Then you can spawn it
4544
# - run dmodels_spawn_model def.model_name:goat def.location:<player.location> save:spawned
4645
# - define root <entry[spawned].created_queue.determination.first>

0 commit comments

Comments
 (0)