Skip to content

Commit 4193f51

Browse files
committed
πŸ“ Docs improvements
1 parent 9fb60f0 commit 4193f51

File tree

8 files changed

+90
-9
lines changed

8 files changed

+90
-9
lines changed

β€Žsrc/routes/+layout.svelte

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,10 +71,10 @@
7171
</div>
7272
<div class="footer-social">
7373
<div class="social-container">
74-
<Button title="Join our Discord Server!">
74+
<Button title="Join our Discord Server!" href="/discord">
7575
<svelte:component this={DiscordIcon} class="social-icon" />
7676
</Button>
77-
<Button title="Check out our Source Code!">
77+
<Button title="Check out our Source Code!" href="/source">
7878
<svelte:component this={GithubIcon} class="social-icon" />
7979
</Button>
8080
</div>
@@ -152,9 +152,10 @@
152152
display: flex;
153153
flex-direction: row;
154154
justify-content: center;
155+
gap: 2rem;
155156
}
156157
157-
.social-container > :global(button) {
158+
.social-container > :global(a) {
158159
font-size: 2rem;
159160
}
160161
</style>
Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,57 @@
11
---
22
title: Cameras
3-
description: Everything you need to know about Cameras in the Blueprint Format.
3+
description: Cameras are used to control the player's view during an animation by forcing the player to spectate an animated item_display.
44
---
5+
6+
# { $frontmatter.title }
7+
8+
{ $frontmatter.description }
9+
10+
## Installing the Camera Plugin
11+
12+
Animated Java does not include camera functionality by default. To add camera functionality to your Data Pack, you will need to install the [Camera Plugin](https://www.blockbench.net/plugins/cameras).
13+
14+
## Creating a Camera
15+
16+
To create a camera, right click the Outliner and select `Add Camera`.
17+
18+
![add-camera-action](/img/steps/camera/1.png)
19+
20+
If this button isn't there, you can press `h` and then search for `Add Camera`.
21+
22+
## Animating Cameras
23+
24+
Cameras can be animated by adding keyframes to their position / rotation Timelines just like any other element.
25+
26+
## Excuting Commands as / at Cameras Externally.
27+
28+
Sometimes you may want to execute commands at a specific camera's position / rotation from an external function. This can be done by getting the camera's information using the data entity's `data.cameras.<camera_name>` NBT.
29+
30+
:::admonition type=info title=Example
31+
Teleport the nearest player to the position of a specific camera.
32+
33+
```rust title="foo/as_root.mcfunction"
34+
execute as <root> on passengers if entity @s[tag=aj.data] run \
35+
function foo:position with entity @s data.cameras.<camera_name>
36+
```
37+
38+
```rust title="foo/position.mcfunction"
39+
$execute positioned $(posx) $(posy) $(posz) rotated $(roty) $(rotx) run \
40+
tp @p ~ ~ ~ ~ ~
41+
```
42+
43+
:::
44+
45+
:::admonition type=info title=Example
46+
Force the player to spectate a specific camera.
47+
48+
```rust title="foo/as_root.mcfunction"
49+
execute as <root> on passengers if entity @s[tag=aj.data] run \
50+
function foo:select with entity @s data.cameras.<camera_name>
51+
```
52+
53+
```rust title="foo/select.mcfunction"
54+
$execute as $(uuid) run spectate @s @p
55+
```
56+
57+
:::

β€Žsrc/routes/docs/[...5]resources/[...1]faq/+page.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,26 @@ description: Frequently asked questions about Animated Java.
77

88
{$frontmatter.description}
99

10+
## How do I install Animated Java?
11+
12+
Follow the instructions in the [Installation](/docs/getting-started/installing-animated-java) section of the documentation.
13+
14+
---
15+
16+
## What versions of Minecraft does Animated Java support?
17+
18+
Animated Java v1.0.0 supports Minecraft versions 1.21 and above.
19+
20+
For older versions of Minecraft, see the [Legacy Releases](/docs/legacy-releases/index) section of the documentation.
21+
22+
## How can I support the development of Animated Java?
23+
24+
You can support my projects on Ko-Fi at [https://ko-fi.com/snavesutit](https://ko-fi.com/snavesutit)!
25+
26+
Additionally, you can help by reporting bugs, suggesting features, and contributing to the project on [GitHub](/source)
27+
28+
---
29+
1030
## What model limitations does Animated Java have and how do they compare to Vanilla Minecraft?
1131

1232
Animated Java has fewer limitations than Vanilla Minecraft, but there are still a few limitations to keep in mind when creating your models:
@@ -23,7 +43,7 @@ There are a few things you can do to make sure your models run as smoothly as po
2343
- Use a few bones as possible. The more bones you have, the more NBT modifications need to be done each frame. Note that bones with no Cubes in them are not exported, and therefor do not contribute to performance issues.
2444
- Avoid playing animations when your Rig is not visible to the player.
2545

26-
Animated Java is designed to be as efficient as possible, but there are still some limitations to what can be done with commands. If you are experiencing performance issues, consider joining the [Animated Java Discord](https://discord.gg/jFgY4PXZfp) for help and advice.
46+
Animated Java is designed to be as efficient as possible, but there are still some limitations to what can be done with commands. If you are experiencing performance issues, consider joining the [Animated Java Discord](/discord) for help and advice.
2747

2848
---
2949

β€Žsrc/routes/docs/[...5]resources/[...3]installing-pre-releases/+page.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ description: Learn how to install pre-release versions of Animated Java.
1515

1616
!!!
1717

18-
!!!step title="Step 2"|(slot=description)=Find the `animated-java.js` file you downloaded from our [Discord Server](https://discord.com/invite/jFgY4PXZfp), then click `Open`.
18+
!!!step title="Step 2"|(slot=description)=Find the `animated-java.js` file you downloaded from our [Discord Server](/discord), then click `Open`.
1919

2020
![pre-release-step2](/img/steps/pre-release/2.png)
2121

2222
!!!
2323

2424
:::
2525

26-
That's it! You should now have the pre-release version of Animated Java installed. If you have any issues, feel free to ask for help in the `#animated-java-support` channel of our [Discord server](https://discord.com/invite/jFgY4PXZfp).
26+
That's it! You should now have the pre-release version of Animated Java installed. If you have any issues, feel free to ask for help in the `#animated-java-support` channel of our [Discord server](/discord).

β€Žsrc/routes/docs/[...6]legacy-releases/[...3]legacy-beta/+page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: The last Beta version of Animated Java 1.0.0. Uses Display Entities
1010
## Install URL
1111

1212
```txt
13-
https://github.com/Animated-Java/animated-java/releases/tag/legacy-beta
13+
https://animated-java.dev/downloads/legacy_beta
1414
```
1515

1616
Follow the instructions in [Installing Legacy Versions](installing-legacy-versions) to install this version of the plugin.

β€Žsrc/routes/docs/[...6]legacy-releases/[...4]legacy-armorstands/+page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: The initial release of Animated Java that uses items on the heads o
1010
## Install URL
1111

1212
```txt
13-
https://github.com/Animated-Java/animated-java/releases/tag/legacy-armorstands
13+
https://animated-java.dev/downloads/legacy_armorstands
1414
```
1515

1616
Follow the instructions in [Installing Legacy Versions](installing-legacy-versions) to install this version of the plugin.

β€Žsrc/routes/source/+page.ts

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { redirect } from '@sveltejs/kit'
2+
3+
export const prerender = true
4+
5+
export function load() {
6+
throw redirect(302, 'https://github.com/Animated-Java/animated-java')
7+
}

β€Žstatic/img/steps/camera/1.png

48.6 KB
Loading

0 commit comments

Comments
Β (0)