xiaokun/netease-modsdk-wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

搬运一批Bedrock wiki内容，完善翻译

Browse Source
This commit is contained in:
boybook
2025-03-20 00:13:44 +08:00
parent ead7392a76
commit 4896c1a4f2
163 changed files with 33930 additions and 1464 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/wiki/particles/disabling-particles.md Normal file
View File

@@ -0,0 +1,40 @@
---
title: Disabling Particles
category: Tutorials
tags:
- beginner
mentions:
- SirLich
- Joelant05
- MedicalJewel105
---
In the event that you want to disable a particle, it is recommended to do so from the particle file itself as opposed to simply making the particle texture transparent in `particles.png`. Additionally, disabling a particle might offer a slight performance boost compared to making it transparent, as transparent particles are still emitted (but not visible).
The basic idea of disabling a particle from emitting is as follows:
<CodeHeader>RP/particles/some_vanilla_particle.json</CodeHeader>
```json
{
"format_version": "1.10.0",
"particle_effect": {
"description": {
"identifier": "minecraft:some_vanilla_particle",
"basic_render_parameters": {
"material": "particles_alpha",
"texture": "textures/particle/particles"
}
},
"components": {
"minecraft:emitter_lifetime_expression": {
"activation_expression": 0,
"expiration_expression": 1
},
"minecraft:emitter_rate_manual": {
"max_particles": 0
}
}
}
}
```

10
docs/wiki/particles/index.md Normal file
View File

@@ -0,0 +1,10 @@
---
title: Particles
categories:
- title: General
color: blue
- title: Tutorials
color: green
- title: Documentation
color: red
---

336
docs/wiki/particles/particles-and-sounds.md Normal file
View File

@@ -0,0 +1,336 @@
---
title: 'Particles and Sounds'
category: General
tags:
- outdated
mentions:
- SirLich
- Joelant05
- destruc7ion
- MedicalJewel105
- aexer0e
- solvedDev
---
:::danger
Some information from this page was copied [here](/visuals/animation-effects)
:::
## Particles in Animation
Minecraft Particles can be used in entity animations. For example, the phantom has an animation which emits the minecraft:phantom_trail particle constantly. Let's try to add a particle to our entity's attack animation.
`part of RP/entity/description/`
<CodeHeader></CodeHeader>
```json
"particle_effects": {
"l_explosion": "minecraft:large_explosion"
},
```
This piece of code is located in our resource entity file. Here we defined the shortname ("l_explosion") for the particle we are going to use, "minecraft:large_explosion".
You can test a particle in-game with the `/particle <namespace:particle_id> ~ ~2 ~` command. You can view the full list of Vanilla Particles [here](https://minecraft.wiki/w/Particles).
Now for the Blockbench part.
- Right click the bone were your particle will be emitted from, and choose 'Add Locator' with the anchor icon. Name it something distinct, like 'l_expl_emitter'. Now move the emitter to the desired location.
![](/assets/images/guide/custom_particles_1.png)
_Note: you can also use locators to define where a lead will leash to, if you name your locator 'lead'._
- In the 'Animate' section, choose 'Animate Effects' on your timeline, then click on the '+' icon near the 'Particle' object.
![](/assets/images/guide/custom_particles_2.png)
- You will see this menu on your left. 'Effect' asks for your particle's shortname, and 'Locator' asks for the name of your Locator/Emitter object.
![](/assets/images/guide/custom_particles_3.png)
_Note: you can add sounds to animations in a similar way._
![](/assets/images/guide/custom_particles_4.jpg)
Now you're good to go! Save the model and the animations. If you did everything correctly, the defined particle will spawn whenever the entity attacks. _Of course you could put another particle on the walking animation's timeline (for example, hooves making dust) in the same way._
## Custom Particles
Custom particles are defined in the `RP/particles` folder. As mentioned earlier on this page, you can summon particles using the '/particle' command (e.g in Behavior Animations) or using Resource Animation emitters. The best way to learn custom particles is to play around with the example files from the [Vanilla Example resource pack](https://www.minecraft.net/en-us/addons) and the Particle Example Pack, and of course, from the documentation on [bedrock.dev](http://bedrock.dev/r/Particles).
_Note: Skip to the end of this section for a tool to generate particle files visually._
File structure:
- "identifier" is exactly what you'd expect: I'll use "wiki:curvy_particle" and "wiki_pink_hit" for the tutorial. File names do not matter.
- "texture" defines the texture file. Not that a single image file can hold textures for many particles.
- "material" is usually set to "particles_alpha" for particles.
![](/assets/images/guide/custom_particles_5.png)
That is the texture I'm going to use, it's size is `16x16`. (`RP/particles/wiki_particles.png`). As you can see, it has 4 different textures in it, each of them being a `8x8`. The upper row (_starting/top left corner at at 0, 0_) is the flipbook texture for "wiki:curvy*particle" and the bottom row (\_top left corner at/starting at 0, 8*). We'll define this in the "billboard_texture" component.
<CodeHeader>RP/particles/curvy_particle.json</CodeHeader>
```json
{
"format_version": "1.10.0",
"particle_effect": {
"description": {
"identifier": "wiki:curvy_particle",
"basic_render_parameters": {
"material": "particles_alpha",
"texture": "textures/particle/wiki_particles"
}
},
"components": {
"minecraft:emitter_rate_instant": {
"num_particles": 50
},
"minecraft:emitter_lifetime_once": {
"active_time": 0
},
"minecraft:emitter_shape_sphere": {
"radius": 0.3,
"direction": "outwards"
},
"minecraft:particle_initial_speed": "Math.random(0.0, 15.0)",
"minecraft:particle_initial_spin": {
"rotation": "Math.random(0, 360)",
"rotation_rate": "Math.random(-300, 300)"
},
"minecraft:particle_lifetime_expression": {
"max_lifetime": "Math.random(1.0, 4.0)"
},
"minecraft:particle_motion_dynamic": {
"linear_acceleration": [0, 2.0, 0],
"linear_drag_coefficient": 5,
"rotation_drag_coefficient": 0.3
},
"minecraft:particle_appearance_billboard": {
"size": ["0.11", "0.11"],
"facing_camera_mode": "lookat_xyz",
"uv": {
"texture_width": 16,
"texture_height": 16,
"flipbook": {
"base_UV": [0, 0],
"size_UV": [8, 8],
"step_UV": [8, 0],
"frames_per_second": 2,
"max_frame": 2,
"stretch_to_lifetime": true,
"loop": false
}
}
},
"minecraft:particle_appearance_lighting": {}
}
}
}
```
Here's the code for our first particle, "wiki:curvy_particle". Our texture file is defined.
The components are quite complicated here, but they're explained well on the [Particle doc](http://bedrock.dev/r/Particles). Let's move forward to the `"minecraft:particle_appearance_billboard"` component for now.
- "texture_width" and "texture_height" defines the size of the image file itself.
- "base_UV" in "flipbook" defines the top-left corner of the particle texture. For this particle it's at 0, 0, which is the upper left corner of the image itself. For the second particle, "wiki:pink_hit", "base_UV" will be at 0, 8, which is 8 pixels lower then the first location.
- "size_UV" defines the size of the particle's texture(8*8) on the image file(which is 16*16).
- "step_UV" is how far the flipbook needs to step in order to get the next particle texture. In this case it's 8, 0, which is 8 pixels to the right.
- "frames_per_second" is quite self-explainable. "max_frame" is the total number of frames for the particle.
The second particle, "wiki:pink_hit".
<CodeHeader>RP/particles/pink_hit.json</CodeHeader>
```json
{
"format_version": "1.10.0",
"particle_effect": {
"description": {
"identifier": "wiki:pink_hit",
"basic_render_parameters": {
"material": "particles_alpha",
"texture": "textures/particle/wiki_particles"
}
},
"components": {
"minecraft:emitter_rate_steady": {
"spawn_rate": 520,
"max_particles": 48
},
"minecraft:emitter_lifetime_once": {
"active_time": 0.15
},
"minecraft:emitter_shape_point": {
"offset": [0.0, "Math.random(-0.9, -0.5)", 0.0],
"direction": [
"Math.random(-0.75, 0.75)",
"Math.random(-1.0, 1.0)",
"Math.random(-0.75, 0.75)"
]
},
"minecraft:particle_initial_speed": "Math.random(10.0, 20.0)",
"minecraft:particle_lifetime_expression": {
"max_lifetime": "6.0 / (Math.random(0.0, 16.0) + 12.0)"
},
"minecraft:particle_motion_dynamic": {
"linear_acceleration": [0, -12.0, 0],
"linear_drag_coefficient": 10
},
"minecraft:particle_appearance_billboard": {
"size": [
"0.10 + v.particle_random_1*0.05",
"0.10 + v.particle_random_1*0.05"
],
"facing_camera_mode": "lookat_xyz",
"uv": {
"texture_width": 16,
"texture_height": 16,
"flipbook": {
"base_UV": [0, 8],
"size_UV": [8, 8],
"step_UV": [8, 0],
"frames_per_second": 8,
"max_frame": 2,
"stretch_to_lifetime": true,
"loop": false
}
}
},
"minecraft:particle_appearance_tinting": {
"color": {
"gradient": [
[
"v.particle_random_1*0.3 + 0.6",
"v.particle_random_2*0.3+ 0.6",
"v.particle_random_2*0.3+ 0.6",
1.0
],
["v.particle_random_1*0.3 + 0.6", 0.5, 0.3, 1.0]
],
"interpolant": "v.particle_age/v.particle_lifetime"
}
},
"minecraft:particle_appearance_lighting": {}
}
}
}
```
Done! Now you have two custom particles that can be used in animations!
It's rather tiresome to create particles that way, comparable to creating models without Blockbench. Luckily, you can use [Snowstorm](https://jannisx11.github.io/snowstorm/), a Visual Particle Generator. It's especially convenient to download the [VSC Snowstorm Extension](https://marketplace.visualstudio.com/items?itemName=JannisX11.snowstorm), which is going to create an interactive UI in Visual Studio Code itself for `.particle.json` files.
![](/assets/images/guide/custom_particles_6.jpg)
`/particle wiki:pink_hit ~ ~2 ~`
![](/assets/images/guide/custom_particles_7.jpg)
`/particle wiki:curvy_particle ~ ~2 ~`
---
## Defining Custom Sounds
_You can find a more in-depth tutorial on custom sounds on [wiki.bedrock.dev](/concepts/sounds)._
Minecraft can read sound files in the `.ogg` (recommended) or `.wav` format. (You can look up an .mp3 to .ogg converter online). Personally, I usually get my sound effects from ZapSplat.com.
Sound files are located in subfolders of the `RP/sounds/` folder. My skele_yaklin sound files are located under `RP/sounds/mob/yaklin_moo.ogg` and `RP/sounds/mob/yaklin_moo_2.ogg`. (I don't have more sound effects currently, thus I will be using same ones over and over, but ideally one would need more of those).
### Sound Definition
Now to define the sound's shortnames! This process is similar to defining block texture shortnames. It's done in `RP/sounds/sound_definitions.json`.
<CodeHeader>RP/sounds/sound_definitions.json</CodeHeader>
```json
{
"format_version": "1.14.0",
"sound_definitions": {
"mob.yaklin.idle": {
"category": "neutral",
"max_distance": 12.0,
"sounds": ["sounds/mob/yaklin_moo", "sounds/mob/yaklin_moo_2"]
},
"mob.yaklin.death": {
"category": "neutral",
"max_distance": 12.0,
"sounds": ["sounds/mob/yaklin_moo"]
},
"mob.yaklin.hurt": {
"category": "neutral",
"max_distance": 12.0,
"sounds": "sounds/mob/yaklin_moo"
}
}
}
```
We have 3 sound shortnames in total:
1. `mob.yaklin.idle`, which refers to a random sound file from the "sounds": [] array.
1. `mob.yaklin.death` can be heard from the distance of 12 blocks: `max_distance": 12.0`.
1. And, lastly, `mob.yaklin.hurt`.
### sounds.json
Now we are about to call our sounds. We can do it either through the `/playsound <>` slash command or automatically in `RP/sounds.json`. Once again, this resembles block resource definition.
![](/assets/images/guide/custom_particles_8.png)
^ the file's structure. I recommend checking out the same file in the Example Resource Pack.
<CodeHeader>RP/sounds.json/"entities": {}/"wiki:skele_yaklin": {}</CodeHeader>
```json
"wiki:skele_yaklin": {
"volume": 1.0,
"pitch": [
1.0,
1.0
],
"events": {
"ambient": "mob.yaklin.idle",
"hurt": "mob.yaklin.hurt",
"death": "mob.yaklin.death",
"step": {
"sound": "mob.cow.step",
"volume": 0.15,
"pitch": 1.0
}
}
}
```
Let's see how the sounds of the skele_yaklin are called in the entity's object.
- The first "volume" and "pitch" are global, they are the starting point for every other of the entity's sounds. If you want the sounds to play exactly how they are, set both of them to 1;
- "events" include the automatic sounds to be played. There are a couple Vanilla events that will trigger automatically(you can see the whole list on the wiki.bedrock.dev page linked bove). All of the events call a sound's shortname.
- "ambient" plays occasionally, for example the sheep "baah" sound.
- "hurt" plays when the entity is hurt.
- "death" plays on death.
- "step" is the sound of the mob walking. I used the cow step sound, already included in the base game.
That's it! Turn up your Sound volume in Settings>Audio, spawn in your mobs, and listen to the melodic cacophony of their new voices!
---
---
## Your progress so far
**What you've done:**
- Learned to include Particles in Animations
- Created two Custom Particles and learned to create more
- Defined custom Sounds for your custom entity;
**What are you to do next:**
- Create custom biomes
- Create custom generated Structures
- Be introduced to Scripting

43
docs/wiki/particles/particles.md Normal file
View File

@@ -0,0 +1,43 @@
---
title: 'Intro to Particles'
category: General
tags:
- guide
mentions:
- SirLich
- MedicalJewel105
- TheItsNameless
---
## Particle Systems
A [particle system](https://www.wikiwand.com/en/Particle_system) is a technique in game physics, motion graphics, and computer graphics that uses many small sprites to create convincing effects such as smoke, fire, or swarms of insects. You can create new particle systems in the Bedrock Edition of Minecraft by using your own custom textures, and your own movement logic. This makes particles extremely fun and powerful!
The Molang integration in particles is also extremely well developed, which allows you to pass data between different particles, or between an entity and a particle.
### Particles
A 'particle', or a 'particle instance' is a single sprite (texture) which is placed in 3D space, and has its own logic for how to move about and change its appearance. Some examples of a particle could include:
- A single snowflake
- A single raindrop
- A single wisp of smoke
### Emitters
An 'emitter' or 'particle emitter' is a system that can spawn many particles, either all at once (explosion), or over time (steady). Emitters have their own logic for how to move, how many particles to spawn, and where. Some examples of emitters could include:
- A snowstorm (creates snowflakes)
- A rainstorm (creates raindrops)
- A smokey chimney (creates smoke wisps)
## Creating your First Particle
To create a particle, you need a resource pack, a texture, and a particle definition file:
<FolderView
:paths="[
'RP/particles/snowflake.json',
'RP/textures/particles/snowflake.png'
]"
> </FolderView>

225
docs/wiki/particles/vanilla-particles.md Normal file
View File

@@ -0,0 +1,225 @@
---
title: Vanilla Particles
category: Documentation
---
Here is the complete list of Bedrock particles from the vanilla resources. Please be aware that not all of these particles function properly, as many require molang context from their host entity.
:::tip Playing via /particle:
For some reason, Bedrock requires the leading `minecraft` namespace, and the coordinates in the `/particle` command.
It doesn't have autocomplete for particles.
:::
### Working Particles
These particles can be spawned directly in-world, without any issues.
| Working Particles |
| ------------------------------------------- |
| minecraft:basic_flame_particle |
| minecraft:basic_portal_particle |
| minecraft:basic_smoke_particle |
| minecraft:bleach |
| minecraft:blue_flame_particle |
| minecraft:camera_shoot_explosion |
| minecraft:campfire_smoke_particle |
| minecraft:campfire_tall_smoke_particle |
| minecraft:candle_flame_particle |
| minecraft:critical_hit_emitter |
| minecraft:crop_growth_emitter |
| minecraft:dragon_breath_trail |
| minecraft:dragon_death_explosion_emitter |
| minecraft:dragon_destroy_block |
| minecraft:dragon_dying_explosion |
| minecraft:endrod |
| minecraft:end_chest |
| minecraft:evocation_fang_particle |
| minecraft:evoker_spell |
| minecraft:cauldron_explosion_emitter |
| minecraft:egg_destroy_emitter |
| minecraft:falling_border_dust_particle |
| minecraft:falling_dust_dragon_egg_particle |
| minecraft:falling_dust_gravel_particle |
| minecraft:falling_dust_red_sand_particle |
| minecraft:falling_dust_sand_particle |
| minecraft:falling_dust_scaffolding_particle |
| minecraft:falling_dust_top_snow_particle |
| minecraft:heart_particle |
| minecraft:honey_drip_particle |
| minecraft:huge_explosion_lab_misc_emitter |
| minecraft:huge_explosion_emitter |
| minecraft:ice_evaporation_emitter |
| minecraft:knockback_roar_particle |
| minecraft:lab_table_misc_mystical_particle |
| minecraft:large_explosion |
| minecraft:lava_drip_particle |
| minecraft:lava_particle |
| minecraft:llama_spit_smoke |
| minecraft:magnesium_salts_emitter |
| minecraft:mob_portal |
| minecraft:mycelium_dust_particle |
| minecraft:obsidian_glow_dust_particle |
| minecraft:obsidian_tear_particle |
| minecraft:redstone_ore_dust_particle |
| minecraft:redstone_repeater_dust_particle |
| minecraft:redstone_torch_dust_particle |
| minecraft:redstone_wire_dust_particle |
| minecraft:rising_border_dust_particle |
| minecraft:sculk_sensor_redstone_particle |
| minecraft:snowflake_particle |
| minecraft:spore_blossom_ambient_particle |
| minecraft:spore_blossom_shower_particle |
| minecraft:stalactite_lava_drip_particle |
| minecraft:stalactite_water_drip_particle |
| minecraft:totem_particle |
| minecraft:villager_angry |
| minecraft:villager_happy |
| minecraft:water_drip_particle |
| minecraft:water_evaporation_bucket_emitter |
| minecraft:water_splash_particle_manual |
### Particles with Issues
The following particles can be spawned, but might spam you with content log errors because they rely on variables that `/particle` cannot set:
| Particles with issues |
| ----------------------------------------------- |
| minecraft:arrow_spell_emitter |
| minecraft:balloon_gas_particle |
| minecraft:basic_crit_particle |
| minecraft:conduit_absorb_particle |
| minecraft:conduit_attack_emitter |
| minecraft:dragon_breath_fire |
| minecraft:dragon_breath_lingering |
| minecraft:electric_spark_particle |
| minecraft:enchanting_table_particle |
| minecraft:elephant_tooth_paste_vapor_particle |
| minecraft:death_explosion_emitter |
| minecraft:eyeofender_death_explode_particle |
| minecraft:explosion_particle |
| minecraft:falling_dust_concrete_powder_particle |
| minecraft:lab_table_heatblock_dust_particle |
| minecraft:misc_fire_vapor_particle |
| minecraft:mobspell_emitter |
| minecraft:mob_block_spawn_emitter |
| minecraft:note_particle |
| minecraft:portal_directional |
| minecraft:portal_reverse_particle |
| minecraft:rain_splash_particle |
| minecraft:shulker_bullet |
| minecraft:silverfish_grief_emitter |
| minecraft:soul_particle |
| minecraft:sparkler_emitter |
| minecraft:splash_spell_emitter |
| minecraft:water_evaporation_actor_emitter |
| minecraft:water_splash_particle |
| minecraft:water_wake_particle |
| minecraft:wax_particle |
| minecraft:wither_boss_invulnerable |
### Bubble Particles
The following particles are various bubbles that only show up underwater. Some of them spam content log errors:
| Bubble particles |
| -------------------------------------- |
| minecraft:basic_bubble_particle |
| minecraft:basic_bubble_particle_manual |
| minecraft:bubble_column_bubble |
| minecraft:bubble_column_down_particle |
| minecraft:bubble_column_up_particle |
| minecraft:cauldron_bubble_particle |
| minecraft:cauldron_splash_particle |
| minecraft:dolphin_move_particle |
| minecraft:eye_of_ender_bubble_particle |
| minecraft:fish_hook_particle |
| minecraft:fish_pos_particle |
| minecraft:glow_particle |
| minecraft:guardian_attack_particle |
| minecraft:guardian_water_move_particle |
| minecraft:sponge_absorb_water_particle |
| minecraft:squid_flee_particle |
| minecraft:squid_ink_bubble |
| minecraft:squid_move_particle |
| minecraft:underwater_torch_particle |
### Permanent Particles
The following particles are permanent and will not be removed once spawned until you exit the game:
| Permanent particles |
| -------------------------------- |
| minecraft:mobflame_emitter |
| minecraft:nectar_drip_particle |
| minecraft:phantom_trail_particle |
| minecraft:stunned_emitter |
## Broken Particles
The following particles exist in-game but cannot be spawned because they require context that cannot be provided by `/particle` or are simply bugged:
| Broken particles |
| -------------------------------- |
| minecraft:block_destruct |
| minecraft:block_slide |
| minecraft:breaking_item_icon |
| minecraft:breaking_item_terrain |
| minecraft:cauldron_spell_emitter |
| minecraft:ink_emitter |
| minecraft:portal_east_west |
| minecraft:portal_north_south |
| minecraft:vibration_signal |
| minecraft:colored_flame_particle |
---
[Original Credit](https://www.reddit.com/r/MinecraftCommands/comments/cbd56p/i_need_a_list_of_bedrock_particles/etg8rt7/)
## Component Particles
The following is a list of pre-defined short names for Vanilla particles that can be used in certain components.
**These have all been proven to generally work. This may not be a full list.**
| Short names | Notes |
| --------------------- | ---------------------------------------------------------- |
| mobspellambient | Color determined by any present potion ID in the component |
| villagerangry | |
| bubble | Only shows underwater |
| evaporation | |
| crit | |
| dragonbreath | Only seems to work for the AoE component for Projectiles |
| driplava | |
| dripwater | |
| reddust | |
| enchantingtable | |
| endrod | |
| mobspell | Color determined by any present potion ID in the component |
| largeexplode | |
| hugeexplosion | |
| fallingdust | Color determined by any present potion ID in the component |
| waterwake | |
| flame | |
| villagerhappy | |
| heart | |
| mobspellinstantaneous | Color determined by any present potion ID in the component |
| iconcrack | |
| slime | |
| snowballpoof | |
| largesmoke | |
| lava | |
| mobflame | |
| townaura | |
| note | |
| explode | |
| portal | |
| rainsplash | |
| smoke | |
| watersplash | |
| ink | |
| terrain | Pulls texture from atlas.terrain |
| totem | |
| witchspell | |
| soul | |
| spit | |
| sneeze | |