From f3e8807e2b57e98aa25e1710a6f80131811b1b51 Mon Sep 17 00:00:00 2001 From: Kale-Ko Date: Tue, 6 Sep 2022 21:44:08 -0400 Subject: [PATCH] Update wiki to reflect the latest version of emotecraft and add a few new features --- .deepsource.toml | 3 +- index.html | 43 ++++++++------- pages/en/404-notfound.md | 2 +- pages/en/404-untranslated-language.md | 2 +- pages/en/404-untranslated-page.md | 2 +- pages/en/a-helpful-feature.md | 2 +- pages/en/about.md | 9 ++-- pages/en/creating-emotes-blender.md | 14 ++--- pages/en/creating-emotes-blockbench.md | 16 +++--- pages/en/creating-music.md | 5 +- pages/en/download-emotes.md | 8 +-- pages/en/downloads.md | 17 +++--- pages/en/faq.md | 52 +++++++++---------- pages/en/home.md | 4 +- pages/en/install-client.md | 8 +-- pages/en/install-emotes.md | 4 +- pages/en/install-server.md | 8 +-- pages/en/mod-config.md | 50 +++++++++--------- pages/en/playing-emotes.md | 4 +- ...choose-wheel.md => setting-emote-wheel.md} | 6 +-- pages/en/sharing-emotes.md | 7 +-- pages/en/sidebar.md | 9 +--- pages/en/translating-mod.md | 4 +- pages/en/translating-wiki.md | 8 +-- pages/version.json | 2 +- style/style.css | 8 +-- 26 files changed, 150 insertions(+), 147 deletions(-) rename pages/en/{setting-fast-choose-wheel.md => setting-emote-wheel.md} (78%) diff --git a/.deepsource.toml b/.deepsource.toml index 10cb54a..49ed973 100644 --- a/.deepsource.toml +++ b/.deepsource.toml @@ -10,6 +10,5 @@ enabled = true [analyzers.meta] environment = [ - "browser", - "nodejs" + "browser" ] diff --git a/index.html b/index.html index 9fd2c12..0db0ca2 100644 --- a/index.html +++ b/index.html @@ -18,7 +18,7 @@ - + @@ -70,23 +70,21 @@ } fetch("./pages/version.json").then(res => res.json()).then(versions => { - console.log("Lastest version is " + versions.version + ".") + console.log("Latest version is " + versions.version + ".") var lastVersion = 0 - document.cookie.split(';').forEach(cookie => { - if (cookie.trim().startsWith("lastVersion=")) { - lastVersion = parseInt(cookie.trim().substring(12, cookie.length)) - } - }) + if (localStorage.getItem("lastVersion" != null)) { + lastVersion = parseInt(localStorage.getItem("lastVersion")) || 0 + } - document.cookie = "lastVersion=" + lastVersion + "; max-age=31536000; secure=false" + localStorage.setItem("lastVersion", lastVersion) console.log("Current version is " + lastVersion + ".") console.groupEnd() - if (versions.version > lastVersion) { + if (versions.version > lastVersion || versions.version == -1) { console.log("Cache out of date, refreshing.") caches.open("cache").then(cache => { @@ -99,7 +97,7 @@ lastVersion = versions.version - document.cookie = "lastVersion=" + lastVersion + "; max-age=31536000; secure=false" + localStorage.setItem("lastVersion", lastVersion) } console.groupCollapsed("Fetching languages.") @@ -161,7 +159,7 @@ } }) } else { - console.log("Langauge \"" + lang + "\" does not exist.") + console.log("Language \"" + lang + "\" does not exist.") return fetchWithCache("./pages/en/404-untranslated-language.md").then(res => res.text()) } @@ -191,6 +189,7 @@ HtmlSanitizer.AllowedAttributes.id = true HtmlSanitizer.AllowedAttributes.class = true + HtmlSanitizer.AllowedAttributes.download = true var main = document.getElementById("main") main.innerHTML = HtmlSanitizer.SanitizeHtml(marked.parse(markdown, { gfm: true, mangle: false, smartLists: true, smartypants: true })) @@ -199,6 +198,14 @@ document.title = main.children.item(0).innerHTML + " - " + main.children.item(1).innerHTML document.querySelector("html").lang = lang + var downloads = document.querySelectorAll("a.download") + + downloads.forEach(download => { + fetch(download.href).then(res => res.blob()).then(data => { + download.href = URL.createObjectURL(data) + }) + }) + if (scrollElement != null && scrollElement != "top" && document.querySelector("#" + scrollElement) != null) document.querySelector("#" + scrollElement).scrollIntoView({ block: "center", inline: "center" }) console.groupCollapsed("Fetching sidebar in language \"" + lang + "\".") @@ -288,15 +295,13 @@ }) }) - var darkmode = true + var darkmode = ("matchMedia" in window ? window.matchMedia("(prefers-color-scheme: dark)").matches : true) - document.cookie.split(';').forEach(cookie => { - if (cookie.trim().startsWith("darkmode=")) { - darkmode = cookie.trim().substring(9, cookie.length) == "true" - } - }) + if (localStorage.getItem("darkmode") != null) { + darkmode = localStorage.getItem("darkmode") == "true" + } - document.cookie = "darkmode=" + darkmode + "; max-age=31536000; secure=false" + localStorage.setItem("darkmode", darkmode) if (darkmode) { document.querySelector("html").classList.add("darkmode") @@ -311,7 +316,7 @@ console.log("Switching darkmode " + (document.querySelector("html").classList.contains("darkmode") ? "on" : "off") + ".") - document.cookie = "darkmode=" + document.querySelector("html").classList.contains("darkmode") + "; max-age=31536000; secure=false" + localStorage.setItem("darkmode", darkmode) }) diff --git a/pages/en/404-notfound.md b/pages/en/404-notfound.md index 5d05fdb..63adf77 100644 --- a/pages/en/404-notfound.md +++ b/pages/en/404-notfound.md @@ -2,4 +2,4 @@ ## 404 Not Found -The page you were looking for could not be found (Typo?) +The page you were looking for could not be found. (Typo?) diff --git a/pages/en/404-untranslated-language.md b/pages/en/404-untranslated-language.md index 36b5eee..99d535c 100644 --- a/pages/en/404-untranslated-language.md +++ b/pages/en/404-untranslated-language.md @@ -2,4 +2,4 @@ ## 404 Untranslated Language -The language you were trying to use has not been added yet, if you would like to help translate it see [this](./translating-wiki) +The language you were trying to use has not been added yet. diff --git a/pages/en/404-untranslated-page.md b/pages/en/404-untranslated-page.md index 91dbf2c..1f1772b 100644 --- a/pages/en/404-untranslated-page.md +++ b/pages/en/404-untranslated-page.md @@ -2,4 +2,4 @@ ## 404 Untranslated Page -The page you were trying to access has not been translated yet, if you would like to help translate it see [this](./translating-wiki) +The page you were trying to access has not been translated into that language yet. diff --git a/pages/en/a-helpful-feature.md b/pages/en/a-helpful-feature.md index d452732..597a12b 100644 --- a/pages/en/a-helpful-feature.md +++ b/pages/en/a-helpful-feature.md @@ -3,7 +3,7 @@ ## A Helpful Feature If you are trying to quickly create and test emotes it can be a pain to have to restart Minecraft every time you want to test it.\ -So instead if you place the emote file at `{.minecraft}/emote.json` and restart your game a special feature will be enabled in the mod. +So instead if you place the emote file at `.minecraft/emote.json` and restart your game a special feature will be enabled in the mod. If you press the O key (Or whatever, its a configurable keybind) it will load the emote.json file and then attempt to play the emote so you don't have to restart each time.\ This will also provide additional feedback in the game log if something goes wrong. diff --git a/pages/en/about.md b/pages/en/about.md index 36f06bf..8a432b1 100644 --- a/pages/en/about.md +++ b/pages/en/about.md @@ -6,10 +6,9 @@ Emotecraft is a mod for Minecraft Java that allows you to play emotes like on Mi Emotecraft being used -It supports Forge and Fabric and is usually pretty quick to update to new versions of the game. +It supports Forge and Fabric and is usually pretty quick to update to new versions of the game.\ +Downloads can be found [here](./downloads). -Downloads can be found [here](./downloads) +**Important Note:** The mod or plugin must also be installed on the server to be able to see other peoples emotes. -**Important Note:** The mod or plugin must also be installed on the server to be able to see others emotes. - -Different mod loaders (Forge/Fabric) are also fully compatible with each other and the plugins, however different versions may not be (eg. 2.1.4 might not work with 2.1.1) +Different mod loaders (Forge/Fabric) are also fully compatible with each other and the plugins, however different versions may not be (eg. 2.1.4 might not work with 2.1.1). diff --git a/pages/en/creating-emotes-blender.md b/pages/en/creating-emotes-blender.md index ffb8856..3054135 100644 --- a/pages/en/creating-emotes-blender.md +++ b/pages/en/creating-emotes-blender.md @@ -2,21 +2,21 @@ ## Creating Emotes With Blender -**This requires basic knowledge of how to move and rotate objects as well as use keyframes in blender.** For help with this see [this](https://docs.blender.org/manual/en/latest/scene_layout/object/editing/transform/introduction.html) and [this](https://docs.blender.org/manual/en/latest/animation/keyframes/introduction.html) +**This requires basic knowledge of how to move and rotate objects as well as use keyframes in blender.** For help with this see [this](https://docs.blender.org/manual/en/latest/scene_layout/object/editing/transform/introduction.html) and [this](https://docs.blender.org/manual/en/latest/animation/keyframes/introduction.html). To start you are going to need [Blender](https://www.blender.org/download/). -If you need help installing it see [this](https://docs.blender.org/manual/en/latest/getting_started/installing/index.html) +If you need help installing it see [this](https://docs.blender.org/manual/en/latest/getting_started/installing/index.html). -Then you are going to need the blender model, either with or without bend support. You can get it [here](./downloads#tool-downloads) +Then you are going to need the Blender model, either with or without bend support. You can get it [here](./downloads#tool-downloads). -Once you have blender installed open the model. You should be greeted with a readme, make sure to read it.\ +Once you have Blender installed open the model. You should be greeted with a readme, make sure to read it.\ To get started switch to the animation tab. You can move and rotate any of the joints how you want and add keyframes. -When you are done or would like to test your emote switch to the export tab. Here you will see a script with a few variables you can edit. You can change the emoteName, emoteDescription, and author to whatever you want. If you want the emote to loop you can set loop to true and set the return tick to the tick you would like it to loop on/return to\ +When you are done or would like to test your emote switch to the export tab. Here you will see a script with a few variables you can edit. You can change the emoteName, emoteDescription, and author to whatever you want. If you want the emote to loop you can set loop to true and set the return tick to the tick you would like it to loop on/return to.\ When you are done click the play/run button. This will generate an emote.json in the same place as the blend file. Next see [Installing Custom Emotes](./install-emotes) to install the emote you created.\ -If you are testing your emote a lot it is recommended you use [The Helpful Feature](./a-helpful-feature) but if you want you can still install it every time +If you are testing your emote a lot it is recommended you use [The Helpful Feature](./a-helpful-feature) but if you want you can still install it every time. -If you want you can add an icon for your emote, just put the image in the emotes folder as `{nameofemotefile}.png` +If you want you can add an icon for your emote, just put the image in the emotes folder as `{nameOfEmoteFile}.png` You can also add music to your emotes. See [here](./creating-music) diff --git a/pages/en/creating-emotes-blockbench.md b/pages/en/creating-emotes-blockbench.md index 47f61aa..5b65dc2 100644 --- a/pages/en/creating-emotes-blockbench.md +++ b/pages/en/creating-emotes-blockbench.md @@ -2,25 +2,25 @@ ## Creating Emotes With Blockbench -**This requires basic knowledge of how to move and rotate objects as well as use keyframes in blockbench.** For help with this see [this](https://www.youtube.com/playlist?list=PLjl_U0ndTXFc--5aIGQhcKQd8pOa99iK-) +**This requires basic knowledge of how to move and rotate objects as well as use keyframes in blockbench.** For help with this see [this](https://www.youtube.com/playlist?list=PLjl_U0ndTXFc--5aIGQhcKQd8pOa99iK-). To start you are going to need [Blockbench](https://www.blockbench.net/downloads). -Then you are going to need the blockbench model. You can get it [here](./downloads#tool-downloads). -**Note that the blockbench model does not support bends** +Then you are going to need the Blockbench model. You can get it [here](./downloads#tool-downloads). +**Note that the Blockbench model does not support bends** -Once you have blockbench installed open the model.\ +Once you have Blockbench installed open the model.\ To get started switch to the Animate tab. In the top left click the Add Animation button.\ -You can change the name and other paramiters however you like. When your done click confirm +You can change the name and other parameters however you like. When your done click confirm. You can now move and rotate any of the joints how you want and add keyframes. -When you are done click the save button (Or ctrl + s) and save it as emote.json (Or anything else as long as it ends in .json) +When you are done, click the save button (Or `Ctrl + S`) and save it as emote.json (Or anything else as long as it ends in .json) Next see [Installing Custom Emotes](./install-emotes) to install the emote you created.\ -If you are testing your emote a lot it is recommended you use [The Helpful Feature](./a-helpful-feature) but if you want you can still install it every time +If you are testing your emote a lot it is recommended you use [The Helpful Feature](./a-helpful-feature) but if you want you can still install it every time. -If you want you can add an icon for your emote, just put the image in the emotes folder as `{nameofemotefile}.png` +If you want you can add an icon for your emote, just put the image in the emotes folder as `{nameOfEmoteFile}.png` You can also add music to your emotes. See [here](./creating-music) diff --git a/pages/en/creating-music.md b/pages/en/creating-music.md index a00f4a8..96faf94 100644 --- a/pages/en/creating-music.md +++ b/pages/en/creating-music.md @@ -6,6 +6,9 @@ To start you will need [Open Note Block Studio](https://opennbs.org/). Click dow Once that is done run the program, you should be greeted with a blank song. Here you can create the song (If you need help see [this](https://www.youtube.com/watch?v=NFXzons84U8)) +You can now create your song. + +**Important Note:** You may only use the default Minecraft sounds\ **Important Note:** The file may not be any bigger than 32kb or it will crash on servers -When you are done the song click save and save it to the emotes folder as `{nameofemotefile}.nbs`. Then restart your game and it should work. +When you are done the song click save and save it to the emotes folder as `{nameOfEmoteFile}.nbs`. Then restart your game and it should work. diff --git a/pages/en/download-emotes.md b/pages/en/download-emotes.md index 92fc76b..0af9e5c 100644 --- a/pages/en/download-emotes.md +++ b/pages/en/download-emotes.md @@ -2,12 +2,12 @@ ## Downloading Custom Emotes -Currently you can download emotes from from the [Open Emotes Collection](https://emotes.kosmx.dev/), [#emote-list](https://discord.com/invite/CNnyrqvD2H) in the [Discord server](https://discord.com/invite/38e348fxVS), or from the old [Emote archive](https://github.com/KosmX/Emotecraft-emotes). +Currently you can download emotes from from the [Emotes Open Collection](https://emotes.kosmx.dev/), [#emote-list](https://discord.com/invite/CNnyrqvD2H) in the [Discord server](https://discord.com/invite/38e348fxVS), or from the old [Emote archive](https://github.com/KosmX/Emotecraft-emotes). -In the Open Emotes Collection find the emote your want using the search feature and then click the download button. +In the Emotes Open Collection find the emote your want using the search feature and then click the download button. -In the Discord server find the emote you want from #emote-list and then click the title of the embed (For older emotes click the download button in the bottom right). +In the Discord server find the emote you want from [#emote-list](https://discord.com/invite/CNnyrqvD2H) and then click the title of the embed (For older emotes click the download button in the bottom right). -In the emote archive find the emote you want (eg. ). Then click the "Raw" button. Finally Right Click -> Save as. +In the emote archive find the emote you want (eg. ). Then right click the "Raw" button and hit Save as. Next see [Installing Custom Emotes](./install-emotes) to install them from there. diff --git a/pages/en/downloads.md b/pages/en/downloads.md index 4117210..491422f 100644 --- a/pages/en/downloads.md +++ b/pages/en/downloads.md @@ -4,18 +4,19 @@ ### Mod Downloads -For Forge and Fabric downloads it is recommended to use [Modrinth](https://modrinth.com/mod/emotecraft/versions).\ -but you can also use Curseforge ([Forge](https://www.curseforge.com/minecraft/mc-mods/emotecraft-forge/files), [Fabric](https://www.curseforge.com/minecraft/mc-mods/emotecraft/files)) +For Forge and Fabric downloads it is recommended to use [Modrinth](https://modrinth.com/mod/emotecraft/versions),\ +but you can also use Curseforge ([Forge](https://www.curseforge.com/minecraft/mc-mods/emotecraft-forge/files), [Fabric](https://www.curseforge.com/minecraft/mc-mods/emotecraft/files)). -For the Bukkit plugin go [here](https://dev.bukkit.org/projects/emotecraft-bukkit/files). +For the Bukkit/Spigot plugin you can get it from [Modrinth](https://modrinth.com/plugin/emotecraft-bukkit/versions) or [Bukkit](https://dev.bukkit.org/projects/emotecraft-bukkit/files).\ +If you would like to use commands on Bukkit/Spigot you will also need [this](https://dev.bukkit.org/projects/emotecraft-command-extension/files). -The most up to date versions for all loaders and also Bungee can be found on [Github](https://github.com/KosmX/emotes/releases). +The most up to date versions for all loaders + Bungee and Velocity can be found on [Github](https://github.com/KosmX/emotes/releases). -Next see [Installing on Forge/Fabric](./install-client) to install the mod on your client or [Installing on a Server](./install-server) for a server. +Next see [Installing on Forge/Fabric](./install-client) to install the mod on your client, or [Installing on Bukkit/Spigot/Bungee](./install-server) for a server. ### Tool Downloads -[Blender with bends](https://github.com/KosmX/emotes/raw/dev/blender/emote_creator_bend.blend) (Reccomended)\ -[Blender without bends](https://github.com/KosmX/emotes/raw/dev/blender/emote_creator.blend) +Blender model with bends (Recommended)\ +Blender model -[Blockbench](https://github.com/KosmX/emotes/raw/dev/blender/model.bbmodel) +Blockbench model diff --git a/pages/en/faq.md b/pages/en/faq.md index 0d56dee..41c7078 100644 --- a/pages/en/faq.md +++ b/pages/en/faq.md @@ -2,59 +2,59 @@ ## FAQ -### Where can I get more help? - -You can get help in the [Discord server](https://discord.com/invite/PSW2t4Ujm6) - ### Where do I download the mod? -You can download the mod from [here](./downloads) +You can download the mod from [here](./downloads). ### How do I play an emote? -See [Playing Emotes](./playing-emotes) +See [Playing Emotes](./playing-emotes). + +### How can I play an emote while moving? + +In the mod options, set Stop emote at this speed threshold to the max. -### How do I make an emote? +### Where can I find more custom emotes? -See the [Blender Tutorial](./creating-emotes-blender) +See [Downloading Emotes](./download-emotes). ### Where do I put the custom emotes? -See [Installing Emotes](./install-emotes) +See [Installing Emotes](./install-emotes). -### Do custom emotes need to be installed on all clients to work? +### How do I make a custom emote? -No, they only need to be on the client that is playing the emote. +See the [Blender Tutorial](./creating-emotes-blender). -### Does the mod need to be on the server? +### Do custom emotes need to be installed on all clients/the server to work? -Yes, the mod must be on the server to see other peoples emotes. +No, they only need to be on the client that is playing the emote OR the server. -### Where can I find others emotes? +### Does the mod need to be on the server? -See [Downloading Emotes](./download-emotes) +Yes, the mod must be on the server to see other peoples emotes. ### Can you make the mod for x version -Probably not, I don't have time for this. However Emotecraft is modular, you don't have to remap/rewrite the whole mod if you port it. +Probably not, I don't have time for that. However Emotecraft is modular so you don't have to rewrite/remap the whole mod if you port it. If you want to try it and you need help, contact `KosmX#7620` on Discord. ### Why can't I see my custom emotes -Make sure Load emotes on logical server (In the hidden config) is off\ -Make sure the emotes are valid jsons (If you open them up in notepad the first line should be a {)\ -If it is a blockbench emote make sure you are using version 2.1 or newer - -### How can I play an emote while moving? - -In the mod options, set Stop emote at this speed threshold to the max +Make sure Load emotes on logical server (In the hidden config) is off.\ +Make sure the emotes are valid jsons (If you open them up in notepad the first line should be a {).\ +If it is a BlockBench emote make sure you are using version 2.1 or newer. ### What is if I got this error -#### Update Forge to 36.1.0 (or newer) +#### Update Forge to the latest version -Mod File emotecraft-for-MC1.16.5-2.0.1-forge.jar needs language provider javafml:36.1 or above to load +Mod File emotecraft-for-MC1.16.5-2.0.1-forge.jar needs language provider javafml:36.1 or above to load #### Install/Update [Fabric API](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files) -Could not find required mod: emotecraft requires {fabric @ [0.16.2]} +Could not find required mod: emotecraft requires {fabric @ [0.16.2]} + +### Where can I get more help? + +You can get more help in the [Discord server](https://discord.com/invite/PSW2t4Ujm6). diff --git a/pages/en/home.md b/pages/en/home.md index af20dfe..0fe7d7a 100644 --- a/pages/en/home.md +++ b/pages/en/home.md @@ -6,6 +6,6 @@ Welcome to the home of the official Emotecraft wiki! Check out the sidebar to see how to install and use the mod. -Before you do anything it is recommended you read the [FAQ](./faq). If you are still confused, you can get help in the [Discord server](https://discord.com/invite/38e348fxVS) +Before you do anything it is recommended you read the [FAQ](./faq). If you are still confused, you can get help in the [Discord server](https://discord.com/invite/38e348fxVS). -If you are looking for the emotes collection go [here](https://emotes.kosmx.dev/) +If you are looking for the Emotes Open Collection go [here](https://emotes.kosmx.dev/). diff --git a/pages/en/install-client.md b/pages/en/install-client.md index 096173b..153fa88 100644 --- a/pages/en/install-client.md +++ b/pages/en/install-client.md @@ -5,10 +5,12 @@ To install the mod you first need to download the jar.\ You can find it [here](./downloads). **(Make sure you download the correct version)** -If you are installing it on fabric you will also need Fabric Api ([Modrinth](https://modrinth.com/mod/fabric-api/versions), [Curseforge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files))\ -and it is recommended you use Mod Menu ([Modrinth](https://modrinth.com/mod/modmenu/versions), [Curseforge](https://www.curseforge.com/minecraft/mc-mods/modmenu/files)) +If you are installing it on fabric you will also need Fabric Api ([Modrinth](https://modrinth.com/mod/fabric-api/versions), [Curseforge](https://www.curseforge.com/minecraft/mc-mods/fabric-api/files)),\ +and it is recommended you use Mod Menu ([Modrinth](https://modrinth.com/mod/modmenu/versions), [Curseforge](https://www.curseforge.com/minecraft/mc-mods/modmenu/files)). -Once you have the mod you just need to put it in your mods folder +If you are installing it on Forge you will need to download playerAnimator ([Modrinth](https://modrinth.com/mod/playeranimator/versions), [Curseforge](https://www.curseforge.com/minecraft/mc-mods/playeranimator/files)) and bendy-lib ([Modrinth](https://modrinth.com/mod/bendy-lib/versions), [Curseforge](https://www.curseforge.com/minecraft/mc-mods/bendy-lib/files)) as they are not embedded in the mod. + +Once you have the mod(s) you just need to put them in your mods folder located at Windows: `C:/Users/{your user}/AppData/Roaming/.minecraft/mods`\ Mac: `/Users/{your user}/Library/Application Support/minecraft/mods`\ diff --git a/pages/en/install-emotes.md b/pages/en/install-emotes.md index 98fe0f6..1e814e8 100644 --- a/pages/en/install-emotes.md +++ b/pages/en/install-emotes.md @@ -2,9 +2,7 @@ ## Installing Custom Emotes -To install an emote you simple need to drag the .json or .emotecraft file into the emotes folder. - -The emotes folder is located at\ +To install an emote you simple need to drag the .json or .emotecraft file into the emotes folder which is located at Windows: `C:/Users/{your user}/AppData/Roaming/.minecraft/emotes`\ Mac: `/Users/{your user}/Library/Application Support/minecraft/emotes`\ diff --git a/pages/en/install-server.md b/pages/en/install-server.md index 961d0f0..52f8ea0 100644 --- a/pages/en/install-server.md +++ b/pages/en/install-server.md @@ -1,12 +1,12 @@ # Emotecraft Wiki -## Installing on a Server - -If you are using a Fabric or Forge server see [this](./install-client) (Just note the mods dir will just be `{server}/mods`) +## Installing on Bukkit/Spigot/Bungee To install the plugin you first need to download the jar.\ You can find it [here](./downloads). **(Make sure you download the correct version)** -Once you have the plugin you just need to put it in your plugins folder `{server}/plugins` +If you are installing it on Bukkit/Spigot and would like to be able to use commands you will also need [Emotecraft command extensions](https://dev.bukkit.org/projects/emotecraft-command-extension/files) which requires [ProtocolLib](https://dev.bukkit.org/projects/protocollib/files) and [CommandAPI](https://www.spigotmc.org/resources/api-commandapi-1-13-1-19-2.62353/). + +Once you have the plugin(s) you just need to put them in your plugins folder located at `{serverPath}/plugins`. Then you just need to start/restart your Minecraft server. diff --git a/pages/en/mod-config.md b/pages/en/mod-config.md index 2d885b2..3f96fdf 100644 --- a/pages/en/mod-config.md +++ b/pages/en/mod-config.md @@ -6,46 +6,46 @@ To open the config screen on Fabric if you have Mod Menu installed go to the title screen and click the "Mods" button. Then find "Emotecraft" in the list and click the little sliders button. -To open the config screen click the play emotes key (See [Playing Emotes](./playing-emotes)). Then click "All emote" and finally "Config emotes". - -You can also find it in the Forge mods screen or if you have modmenu installed on Fabric in the modmenu. +To open the config screen click the play emotes key (See [Playing Emotes](./playing-emotes)). Then click "All emote" and finally "Config Emotes". ### Setting the Emote Wheel -See [Setting the Fast-choose Wheel](./setting-fast-choose-wheel) +See [Setting the Emote Wheel](./setting-emote-wheel). ### Mod config -Here the focus is the mod config. To open it simply click the "Mod options" button on the config screen. +Here the focus is the mod config. To open it simply click the "Mod Options" button on the config screen. -To change an option you can just left click on it. +To change an option you can just left click on it or if it is a slider left click and drag. #### Basic options -Load built-in emotes - ON/OFF - Default ON - Weather or not to load the emotes that come with the mod\ +Load Built-In Emotes - ON/OFF - Default ON - Weather or not to load the emotes that come with the mod\ Enable quark deserializer - ON/OFF - Default OFF - Weather or not to attempt to load emotes from the forge quark mod\ -Dark fast-choose wheel - ON/OFF - Default OFF - Weather or not the fast-choose wheel should be a dark color instead of light\ -Enable 3rd person perspective while playing an emote - ON/OFF - Default ON - Weather or not to switch to 3rd person mode when you play an emote\ -Use front view instead of back when playing an emote - ON/OFF - Default OFF - Weather or not to use third person front instead of back\ -Show icons instead of emote names - ON/OFF - Default ON - Weather or not to show emote icons instead of their names when possible\ -Allow NSFW emotes to be played - ON/OFF - Default OFF - Weather or not to allow players to play nsfw emotes +Use Dark Emote Wheel - ON/OFF - Default OFF - Weather or not the emote wheel should be a dark color instead of light\ +Use Old Emote Wheel Style - ON/OFF - Default OFF - Weather or not the emote wheel should be reverted to how it was before 2.1.3\ +Play Emotes in 3rd Person - ON/OFF - Default ON - Weather or not to switch to 3rd person mode when you play an emote\ +Use Front View for 3rd Person - ON/OFF - Default OFF - Weather or not to use third person front instead of back\ +Show Icons Only (If Available) - ON/OFF - Default ON - Weather or not to show emote icons instead of their names when possible\ +Allow NSFW Emotes - ON/OFF - Default OFF - Weather or not to allow players to play nsfw emotes #### Expert options -Debug - ON/OFF - Default ON - Weather or not to print debug messages into the console\ -Validate emote - ON/OFF - Default OFF - Weather or not to make sure players stay close to their actually possition while playing emotes\ -Validation threshold - Number 0.04 - 256 - Default 8.0 - How far is too far for a limb to be\ -Always validate received emotes - ON/OFF - Default OFF - Weather or not to always make sure the limbs are not to far, even if it is disabled on the server\ -Enable player safety feature - ON/OFF - Default ON - Weather or not block emotes from muted players (1.16.4+)\ -Stop emote at this speed threshold - Number 0.02 - 2980 - Default 0.04 - How fast a player needs to be going for an emote to be stopped\ -Y axis moving influence in top threshold - Number 0 - 100 - Default 75 - How much the y (up/down) axis contributes to the speed threshold\ -Show hidden config - ON/OFF - Default OFF - Wether to show the hidden config section +Debug - ON/OFF - Default ON - Weather or not to print extra debug messages into the console\ +Validate Emotes - ON/OFF - Default OFF - Weather or not to make sure players stay close to their actually position while playing emotes\ +validationThreshold - Number 0.04 - 256 - Default 8.0 - How far is too far for a limb to be\ +Auto patch emotes to stop smoothly - ON/OFF - Default ON - Weather or not to patch some emotes so they smoothly move back to the normal player state at the end\ +Always Validate Received Emotes - ON/OFF - Default OFF - Weather or not to always make sure the limbs are not to far, even if it is disabled on the server\ +Hide Emotes From Muted Players - ON/OFF - Default ON - Weather or not block emotes from muted players (1.16.4+)\ +stopThreshold - Number 0.02 - 2980 - Default 0.04 - How fast a player needs to be going for an emote to be stopped\ +yratio - Number 0 - 100 - Default 75 - How much the y (up/down) axis contributes to the stop threshold\ +Show Hidden Options - ON/OFF - Default OFF - Wether to show the hidden config section #### Hidden options -Note you must have "Show hidden config" enabled to see these config options +Note you must have "Show Hidden Options" enabled to see these config options. -Load emotes on logical server - ON/OFF - Default ON for server OFF for client - Weather or not to load emotes on the server **(KEEP THIS OFF FOR CLIENTS)**\ -Never remove bad icon - ON/OFF - Default OFF - Weather or not to never remove invalid emote icons\ -Export built in - ON/OFF - Default OFF - Weather or not to export built in emotes when you run an emotes export\ -Hide "no server" warning - ON/OFF - Default ON - Weather or not to hind the "No server" warning you might get on some older forge versions +Load Emotes on Logical Server - ON/OFF - Default OFF for clients On for servers - Weather or not to load emotes on the logical server **(KEEP THIS OFF FOR CLIENTS)**\ +Never Remove Bad Icons - ON/OFF - Default OFF - Weather or not to never remove invalid emote icons\ +Export Built-in - ON/OFF - Default OFF - Weather or not to export built in emotes when you run an emotes export\ +Hide "no server" warning - ON/OFF - Default ON - Weather or not to hind the "No server" warning you will see if the mod is not installed on the server diff --git a/pages/en/playing-emotes.md b/pages/en/playing-emotes.md index 24d8832..da839d8 100644 --- a/pages/en/playing-emotes.md +++ b/pages/en/playing-emotes.md @@ -2,9 +2,9 @@ ## Playing Emotes -To open the fast-choose wheel simply press 'b' (or whatever you set the open fast-choose wheel keybind too) +To open the emote wheel wheel simply press 'b' (or whatever you set the open emote wheel keybind too). -Then you will see the fast-choose wheel (See [Setting the fast-choose wheel](/setting-fast-choose-wheel)),\ +Then you will see the emote wheel wheel (See [Setting the Emote Wheel](./setting-emote-wheel)),\ you can select an emote from here (if you've set it up) or click "All Emotes" to view a list of all your emotes. To play an emote simply left click it. diff --git a/pages/en/setting-fast-choose-wheel.md b/pages/en/setting-emote-wheel.md similarity index 78% rename from pages/en/setting-fast-choose-wheel.md rename to pages/en/setting-emote-wheel.md index 26108fd..cb7b858 100644 --- a/pages/en/setting-fast-choose-wheel.md +++ b/pages/en/setting-emote-wheel.md @@ -1,10 +1,10 @@ # Emotecraft Wiki -## Setting the Fast-choose Wheel +## Setting the Emote Wheel -To start you are going to want to open the config, See [Opening the Config](./mod-config#opening-the-config) +To start you are going to want to open the config, See [Opening the Config](./mod-config#opening-the-config). -To assign an emote to a slot just click an emote and then the slot you want to put it in +To assign an emote to a slot just click an emote and then the slot you want to put it in. You can also bind emotes to keys, to do this just click the emote and then the box to the left of Reset. Then just hit they key you want to bind to the emote. diff --git a/pages/en/sharing-emotes.md b/pages/en/sharing-emotes.md index 7a62e97..ae3702a 100644 --- a/pages/en/sharing-emotes.md +++ b/pages/en/sharing-emotes.md @@ -2,7 +2,8 @@ ## Sharing Emotes -Once you have an emote you might want to share it with other people, you can post it in [#emote-list](https://discord.com/invite/CNnyrqvD2H) in the [Discord server](https://discord.com/invite/38e348fxVS).\ -All you need is a title, description, the .json file, and an image of the emote. +Once you have an emote you might want to share it with other people, to do this you can post it to the [Emotes Open Collection](https://emotes.kosmx.dev/) -To post the emote send `?postEmote "{title}" "{description}"` in #bot-commands with the .json and the image attached to the message. +To get started you need to [login](https://emotes.kosmx.dev/user). Then you can navigate to [Upload an emote](https://emotes.kosmx.dev/e/new) + +Here you will upload your emote.json. After that you may change some of the metadata along with the visibility of the emote. When you are done just click Publish! diff --git a/pages/en/sidebar.md b/pages/en/sidebar.md index f0844fa..b020b95 100644 --- a/pages/en/sidebar.md +++ b/pages/en/sidebar.md @@ -10,13 +10,13 @@ [Downloads](./downloads) [Installing on Forge/Fabric](./install-client)\ -[Installing on a Server](./install-server) +[Installing on a Bukkit/Spigot/Bungee](./install-server) ### Using Emotecraft [Playing Emotes](./playing-emotes)\ [Mod Config](./mod-config)\ -[Setting the Fast-choose Wheel](./setting-fast-choose-wheel) +[Setting the Emote Wheel](./setting-emote-wheel) [Downloading Custom Emotes](./download-emotes)\ [Installing Custom Emotes](./install-emotes) @@ -30,8 +30,3 @@ [A Helpful Feature](./a-helpful-feature) [Sharing Emotes](./sharing-emotes) - -### Contributing to Emotecraft - -[Translating the Mod](./translating-mod)\ -[Translating/Contributing to the Wiki](./translating-wiki) diff --git a/pages/en/translating-mod.md b/pages/en/translating-mod.md index ffd1e27..0ce5e2f 100644 --- a/pages/en/translating-mod.md +++ b/pages/en/translating-mod.md @@ -2,6 +2,6 @@ ## Translating the Mod -If you would like to help translate the mod you can head over to [Crowdin](https://crowdin.com/project/emotecraft) +If you would like to help translate the mod you can head over to [Crowdin](https://crowdin.com/project/emotecraft). -For a bit about how to use crowdin see [here](https://support.crowdin.com/joining-translation-project/#starting-translation) and [here](https://support.crowdin.com/for-volunteer-translators/#work-in-the-editor) +For a bit about how to use crowdin see [here](https://support.crowdin.com/joining-translation-project/#starting-translation) and [here](https://support.crowdin.com/for-volunteer-translators/#work-in-the-editor). diff --git a/pages/en/translating-wiki.md b/pages/en/translating-wiki.md index 9bad45d..66d0a26 100644 --- a/pages/en/translating-wiki.md +++ b/pages/en/translating-wiki.md @@ -2,7 +2,7 @@ ## Translating/Contributing to the Wiki -To contribute to the wiki you just need a GitHub acount and some basic knowledge of how to use it. +To contribute to the wiki you just need a GitHub account and some basic knowledge of how to use it. To start make a fork of the repository from [here](https://github.com/Kale-Ko/Emotecraft-Wiki/fork).\ When it finishes you will have a copy of the original repository that you can mess around in. @@ -11,7 +11,7 @@ If you would like you can clone this new repo locally to your computer to edit i ### Translating a page -If you would like to translate a page open up the pages dirrectory and then whatever language your would like to translate (All of the directories are two letter language codes) +If you would like to translate a page open up the pages directory and then whatever language your would like to translate (All of the directories are two letter language codes) If the language you would like to translate does not already exist then you must create it yourself along with a language.json file (See [this](https://github.com/Kale-Ko/Emotecraft-Wiki/blob/master/pages/en/language.json))\ You must also add the language code to the [languages.json](https://github.com/Kale-Ko/Emotecraft-Wiki/blob/master/pages/languages.json) file\ @@ -24,9 +24,9 @@ Then you can translate it. Adding a page is pretty much identical to translating a page except you just create a new file for whatever language you want. (Make sure this file follows close to the the same format as the others) -### Editting a page +### Editing a page -Editting a page is also pretty simple, just edit whichever page you want to. +Editing a page is also pretty simple, just edit whichever page you want to. ### Contributing your changes diff --git a/pages/version.json b/pages/version.json index 5ce59aa..051b2b6 100644 --- a/pages/version.json +++ b/pages/version.json @@ -1,3 +1,3 @@ { - "version": 1 + "version": 2 } \ No newline at end of file diff --git a/style/style.css b/style/style.css index 1713326..9f22a0d 100644 --- a/style/style.css +++ b/style/style.css @@ -2,7 +2,7 @@ html { --background-color: radial-gradient(#ffffff 25%, #e0e0e0 75%); - --forground-color: #f7f7f7; + --foreground-color: #f7f7f7; --border-color: #d1d1d1; --border-thickness: 3px; @@ -22,7 +22,7 @@ html { html.darkmode { --background-color: radial-gradient(#555555 25%, #444444 75%); - --forground-color: #6b6b6b; + --foreground-color: #6b6b6b; --border-color: #333333; @@ -48,7 +48,7 @@ body { } #main { - background: var(--forground-color); + background: var(--foreground-color); border: var(--border-thickness) solid var(--border-color); border-radius: var(--border-radius); @@ -62,7 +62,7 @@ body { } #navbar { - background: var(--forground-color); + background: var(--foreground-color); border: var(--border-thickness) solid var(--border-color); border-radius: var(--border-radius);