Skip to content

Commit dd03026

Browse files
docs(): Fix docs links (#244)
* fix tree links from blenvy to main * clarify where to get the release zip
1 parent d5f14bc commit dd03026

File tree

2 files changed

+18
-18
lines changed

2 files changed

+18
-18
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Want to jump right in? See the [quickstart guide](https://github.com/kaosat-dev/
2929
## Features
3030

3131
* Useful if you want to use Blender as your Editor
32-
* define Bevy components as custom properties in Blender with an UI tool to add & edit Bevy components, automatically export gltf blueprints & more in [Blender](https://github.com/kaosat-dev/Blenvy/tree/blenvy/tools/blenvy)
33-
* blueprints & levels system : turn your Blender collections into [gltf Blueprints](https://github.com/kaosat-dev/Blenvy/tree/blenvy/crates/blenvy) for reuse inside levels that are just Blender scenes
32+
* define Bevy components as custom properties in Blender with an UI tool to add & edit Bevy components, automatically export gltf blueprints & more in [Blender](https://github.com/kaosat-dev/Blenvy/tree/main/tools/blenvy)
33+
* blueprints & levels system : turn your Blender collections into [gltf Blueprints](https://github.com/kaosat-dev/Blenvy/tree/main/crates/blenvy) for reuse inside levels that are just Blender scenes
3434
* setup & tweak components in Blender Collections & override any of them in your collection instances if you want
3535
* setup & tweak components for objects, meshes and materials as well !
3636
* automatically load all assets for each blueprint (gltf files, manually added assets), with no setup required
@@ -39,42 +39,42 @@ Want to jump right in? See the [quickstart guide](https://github.com/kaosat-dev/
3939
* minimal dependencies: Bevy, Serde & RON only!
4040
* opensource
4141

42-
> If you were previously using the individual bevy_gltf_xxx crates & Blender add-ons please see the [migration guide](https://github.com/kaosat-dev/Blenvy/blob/blenvy/Migration_guide.md)
42+
> If you were previously using the individual bevy_gltf_xxx crates & Blender add-ons please see the [migration guide](https://github.com/kaosat-dev/Blenvy/blob/main/Migration_guide.md)
4343
4444
## Crates
4545

4646
One crate to rule them all !
4747

48-
* [blenvy](https://github.com/kaosat-dev/Blenvy/tree/blenvy/crates/blenvy) This crate allows you to
48+
* [blenvy](https://github.com/kaosat-dev/Blenvy/tree/main/crates/blenvy) This crate allows you to
4949
* define components direclty inside gltf files and instanciate/inject the components on the Bevy side.
50-
* export your project's Bevy registry to json, in order to be able to generate custom component UIs on the Blender side in the Blender [blenvy](https://github.com/kaosat-dev/Blenvy/tree/blenvy/tools/blenvy) add-on
50+
* export your project's Bevy registry to json, in order to be able to generate custom component UIs on the Blender side in the Blender [blenvy](https://github.com/kaosat-dev/Blenvy/tree/main/tools/blenvy) add-on
5151
* define Blueprints/Prefabs for Bevy inside gltf files and spawn them in Bevy. With the ability to override and add components when spawning, efficient "level" loading etc
5252
* the ability to save & load your game state in a relatively simple way, by leveraging the blueprint functionality to only save a minimal subset of dynamic data, seperating dynamic & static parts of levels etc.
5353

5454
OLD videos:
5555
There is a [video tutorial/explanation](https://youtu.be/-lcScjQCA3c) if you want, or you can read the crate docs.
5656
There is a [video tutorial/explanation](https://youtu.be/CgyNtwgYwdM) for this one too, or you can read the crate docs
5757

58-
The examples for the crate are [here](https://github.com/kaosat-dev/Blenvy/tree/blenvy/examples)
58+
The examples for the crate are [here](https://github.com/kaosat-dev/Blenvy/tree/main/examples)
5959

6060
## Tools
6161

6262
### Blender: blenvy
6363

64-
* an all in one [Blender addon](https://github.com/kaosat-dev/Blenvy/tree/blenvy/tools/blenvy) for the Blender side of the workflow:
64+
* an all in one [Blender addon](https://github.com/kaosat-dev/Blenvy/tree/main/tools/blenvy) for the Blender side of the workflow:
6565
* allow easilly adding & editing Bevy components , using automatically generated UIs for each component
6666
* automatically exports your level/world from Blender to gltf whenever you save your Blend file
67-
* automatically export your [Gltf blueprints](https://github.com/kaosat-dev/Blenvy/tree/blenvy/crates/blenvy) & assets
67+
* automatically export your [Gltf blueprints](https://github.com/kaosat-dev/Blenvy/tree/main/crates/blenvy) & assets
6868

6969
## Examples
7070

71-
you can find all examples, [here](https://github.com/kaosat-dev/Blenvy/tree/blenvy/examples)
71+
you can find all examples, [here](https://github.com/kaosat-dev/Blenvy/tree/main/examples)
7272

73-
* [`components`](https://github.com/kaosat-dev/Blenvy/tree/blenvy/examples/components/) use of ```components``` only, to spawn entities with components defined inside gltf files
74-
* [`blueprints`](https://github.com/kaosat-dev/Blenvy/tree/blenvy/examples/blueprints/) use of ```blueprints``` and ```levels``` to spawn a level and then populate it with entities coming from different gltf files, live (at runtime) spawning of entities etc
75-
* [`animation`](https://github.com/kaosat-dev/Blenvy/tree/blenvy/examples/animation/) how to use and trigger animations from gltf files
76-
* [`save_load`](https://github.com/kaosat-dev/Blenvy/tree/blenvy/examples/save_load/) how to save & load levels
77-
* [`demo`](https://github.com/kaosat-dev/Blenvy/tree/blenvy/examples/demo/) a full demo showcasing all features , including physics, animation
73+
* [`components`](https://github.com/kaosat-dev/Blenvy/tree/main/examples/components/) use of ```components``` only, to spawn entities with components defined inside gltf files
74+
* [`blueprints`](https://github.com/kaosat-dev/Blenvy/tree/main/examples/blueprints/) use of ```blueprints``` and ```levels``` to spawn a level and then populate it with entities coming from different gltf files, live (at runtime) spawning of entities etc
75+
* [`animation`](https://github.com/kaosat-dev/Blenvy/tree/main/examples/animation/) how to use and trigger animations from gltf files
76+
* [`save_load`](https://github.com/kaosat-dev/Blenvy/tree/main/examples/save_load/) how to save & load levels
77+
* [`demo`](https://github.com/kaosat-dev/Blenvy/tree/main/examples/demo/) a full demo showcasing all features , including physics, animation
7878

7979
## Workflow
8080

@@ -84,8 +84,8 @@ The workflow goes as follows (once you got your Bevy code setup)
8484

8585
![component registration](https://github.com/kaosat-dev/Blenvy/blob/main/docs/component_registration.png)
8686

87-
* setup & then use the Blenvy [Bevy crate](https://github.com/kaosat-dev/Blenvy/tree/blenvy/crates/blenvy)
88-
* setup & then use the Blenvy [Blender add-on](https://github.com/kaosat-dev/Blenvy/tree/blenvy/tools/blenvy)
87+
* setup & then use the Blenvy [Bevy crate](https://github.com/kaosat-dev/Blenvy/tree/main/crates/blenvy)
88+
* setup & then use the Blenvy [Blender add-on](https://github.com/kaosat-dev/Blenvy/tree/main/tools/blenvy)
8989
* iterate
9090
* have fun !
9191

tools/blenvy/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ If you can I would generally recommend starting fresh, but a lot of effort has b
2020
## Installation:
2121

2222

23-
* grab the latest release zip file
23+
* grab the latest release zip file from the [release page](https://github.com/kaosat-dev/Blenvy/releases/)
2424

25-
![blender addon install](./docs/blender_addon_install_zip.png)
25+
![blender addon install](./docs/blender_addon_install_zip.png)
2626

2727
* up to Blender 4.1 go to edit => preferences => add-ons, click on install and choose the path where ```blenvy.zip``` is stored
2828

0 commit comments

Comments
 (0)