Documentation

[sick geyser]

🔖
Rewiriting docs in progress...

@scarlet talon Hello :)

Some of the documentation exists in Emotecraft for historical reasons:

Initially I didn't think of making a standalone animation library, so all code was in Emotecraft
This was changed later, the animation code has been extracted to a library (and a lot of code has been added), this is playerAnimator.
But some documentation is still on Emotecraft.

You'll even find some stuff in @subtle gulch /tag command (feel free to try it)

Now (until new-year) I have very little time, but if you want to help, I can give you some access and starts.

https://github.com/KosmX/emotes/wiki

Animation in Minecraft: mostly the same for PlayerAnimator
Emote binary: except for a binary KeyframeAnimation representation, this is unique to Emotecraft
Emote.json, 1:1 just copy over
Keyfrane Animation [mildly technical]: mostly related, we should copy this too
Logical sides..., this is purely Emotecraft, but we should make a short explaining for this, maybe even use some examples from FabricMC wiki (they have a great wiki)

A lot of working stuff is written into the mods javadoc

/**
  * Class documentation...
  */
public class ...

Some of those should be re-written, those could also be used.

Another thing I've seen is for most stuff, having prepared a few patterns could help a lot; (here's how to play an animation on arbitrary player)

[scarlet talon]

All sounds good!

I'll let you know once I have time (it'll be a busy school week lol) and get started!

[hazy tiger]

Yo man aren’t you the goat?

[hazy tiger]

Hey man, I think that git hub is a bed website to make the documentation on.

[scarlet talon]

Far from it lol

Most dev docs are on there

And there's no need to make your own website unless you really have an extensive amount of time IMO

[scarlet talon]

🤝

[hazy tiger]

We’re you able to sync the animations on the server?

[scarlet talon]

Ye

Wait

You mean player animations?

Or the GLib thing?

[hazy tiger]

There are already a lot of website for it, they aren’t even hard to use but a .md file is still a good solution

[hazy tiger]

Yea player animation

[scarlet talon]

.md file is just gonna be unorganised since everything will be jammed in 1 place

[hazy tiger]

Well yea

[scarlet talon]

Not directly, I just store separate timers on the server and handle triggering/stopping via packets

[hazy tiger]

Ok

[scarlet talon]

I might do asset synch later

But for now it's docs

[hazy tiger]

Having all the explanation of ehat each statement do in the docs would be better

[scarlet talon]

Yep, Github docs will for sure level this library up IMO. It's gonna be great :p

[hazy tiger]

yea

its pretty hard to understand since its not that well explained

[sick geyser]

If there need for it, I can host a wiki site, but probably GitHub is a better choice for a wiki like this.

[hazy tiger]

Probably

[scarlet talon]

I agree. No need to waste money n stuff IMHO.

[fleet charm]

I agree (joespeph jumpscare)

[scarlet talon]

Jpoespephhpehehp!! :yessir:

[scarlet talon]

Yo @sick geyser Would you like me to write the docs (once I'm back) on a forked repo and pull request? Or should I request repo access?

(Sorry if I reply a little late to this, in school atm :p)

[scarlet talon]

@sick geyser I'm getting started writing docs rn. Will fork the repo and get to work soon™️

[scarlet talon]

Written some "Getting Started" docs, will commit to a forked repo soon™️