diff --git a/.vitepress/config.ts b/.vitepress/config.ts index 0f8b0e2..c9ff63d 100644 --- a/.vitepress/config.ts +++ b/.vitepress/config.ts @@ -60,6 +60,11 @@ export default () => { }, cleanUrls: true, outDir: "./dist", + markdown: { + image: { + lazyLoading: true, + }, + }, vite: { resolve: { alias: [ diff --git a/pages/dungeons/alpha-img.md b/pages/dungeons/alpha-img.md index f54da7d..67d4e73 100644 --- a/pages/dungeons/alpha-img.md +++ b/pages/dungeons/alpha-img.md @@ -31,7 +31,7 @@ _If you find any bugs, please post a new issue on GitHub._
remove_alpha.py
From Alpha to Opaque.
Set all pixels opaque.
get_alpha.py
From Opaque to Alpha.
Set all pixels transparent.
merge_alpha_layers.py
Merge both types easily.
With this one, you have to set "masks", one with opaque pixels, one with transparent pixels.
Thank you so much for reading this tutorial, and good luck with your mod!
\ No newline at end of file diff --git a/pages/dungeons/loader-texture.md b/pages/dungeons/loader-texture.md index 0facdf3..a8864bc 100644 --- a/pages/dungeons/loader-texture.md +++ b/pages/dungeons/loader-texture.md @@ -21,18 +21,18 @@ All needed files for this tutorial can be found [here](https://github.com/Faithf 1. Open `LoadingSpinnerBlock.blend` with Blender 2. Drag the green bar at the bottom at the beginning of the animation - + 3. Go to the `Shading` tab at the top of the screen - + 4. Click on the blank face of the block in front of you (you get a green outline surrounding it) - + 5. In the bottom slide, in the Orange Area, click on the cross & import a new texture: - A.Everything should be good, you now just have to package your files using the Dokucraft Tool
diff --git a/pages/manuals/branding-guidelines.md b/pages/manuals/branding-guidelines.md index 2a5a73a..2139e2a 100644 --- a/pages/manuals/branding-guidelines.md +++ b/pages/manuals/branding-guidelines.md @@ -53,25 +53,25 @@ Logos work well for displaying our branding in places with limited space. This i For most general-purpose applications, use our plain logo. This logo additionally encompasses Classic Faithful, but if you specifically want to refer to Classic Faithful, you can use its respective plain logo as well. - + Left: Plain logo. Right: Classic Faithful plain logo. If you only want to refer to one project, such as in a card, use that project's respective logo. The Classic Faithful logos have different margins to the regular Faithful logo, so bear that in mind when adjusting sizes. - + You can use a monochrome version of our logo in small spaces if using the regular logo would look visually noisy or be hard to read. - + All our logos should always retain their pixel art form. Even when using the monochrome logo, don't simplify the shape into vectors. - + Left: Correct depiction of the Faithful monochrome logo. Right: Incorrect depiction. Finally, our logos should always be centered based on their main hexagonal part. The numbers and symbols in the bottom-right corner should not be taken into account when positioning. - + Left: Correctly centered Faithful 32x logo. Right: An example of incorrect centering; Note that the logo on the right has been centered based on the whole image, and not just the hexagonal part. ## Part 3: Logotexts @@ -80,12 +80,12 @@ Finally, our logos should always be centered based on their main hexagonal part. Logotexts were designed for users to be able to use a logo and a wordmark at the same time without having a clash in resolution. Each logo has a corresponding logotext and this can be used if the Faithful name is not already well established. - + The Faithful logotext. Always make sure to put logotexts on plain or low-contrast backgrounds — readability can be negatively impacted with noisy backgrounds. Please also note that the text and the logo that make up the logotexts are inseparable, so don't use the pixel art text by itself. - + Top: Correct placement of a logotext that ensures it's easily readable. Bottom: Poorly placed logotext. ## Part 4: Wordmarks @@ -94,24 +94,24 @@ Always make sure to put logotexts on plain or low-contrast backgrounds — read Wordmarks tend to be pretty big and bold, so use them sparingly for large banners and other big areas. They're usually the preferred branding when placed over busy backgrounds such as screenshots. - + The Faithful banner. The plain Faithful wordmark is preferred for most purposes, but specific projects also have their own wordmarks, similarly to the project logos. In addition, both cracked, flat, and outlined versions exist. As a rule of thumb, use the flat versions for referring to Faithful (or Classic Faithful) as a whole, the cracked versions for specific projects, and the outlined versions to help readability when necessary. - + Each Faithful wordmark variation. Wordmarks don't tend to scale well, so refrain from using them in small spaces — consider using the logo or simply typing out the name when space is limited. - + An example of a wordmark not scaling well. However, don't mix logos and wordmarks, since that's what the logotexts are for. The reasoning is because the pixelated logos don't mix well with the high-resolution wordmarks. - + A logo next to a wordmark. A logotext is much better suited for this situation. ## Part 5: Typography @@ -122,12 +122,12 @@ The Faithful font should be used for titles and headings, while any neutral sans The individual pixels on a logotext also tend to blend at small resolutions so you're usually better off just typing the name out in a regular font. - + Left: Good diversity in font sizing. Right: Blends together from the uniform size and font. The semibold Faithful font should be used for large headings and the regular Faithful font for sub-headings. Only use the bold Faithful font for top-level titles when more than two levels of nested titles are required, due to its low readability and large horizontal footprint. - + Each font weight and where it should be used. ## Part 6: Scaling @@ -138,12 +138,12 @@ In general, the hierarchy of branding elements to be used should be as following Always leave padding around the edges of any logo, logotext, and wordmark. Specific ratios don't really matter as long as the padding is even on all sides and the respective branding doesn't appear too large. - + Left: Correct padding and scaling of the logo. Right: Incorrect padding and sizing. Don't distort our branding to fit in a given space. Instead try using another suitable image or simply typing out the Faithful name using the format specified in part 1. - + Do not. ## Part 7: Colors and Backgrounds @@ -152,12 +152,12 @@ Faithful has a fairly limited color palette used throughout most of the branding The main brand color is used for most accent colors, such as buttons or embeds. It works in combination with the "generic" background image. - + The main Faithful brand color and image. Each pack additionally has a unique color and background screenshot assigned to it. - + All Faithful project colors with their respective images. A background image works well with a wordmark, decently with a logo, and not very well with a logotext. This placement hierarchy should be used to determine an element to go on top of a background image. If you absolutely have to use a logo or a logotext on a background image, it is recommended to add a drop shadow and/or blur the background. diff --git a/pages/mods/add-new-mod.md b/pages/mods/add-new-mod.md index 164d42d..68460c9 100644 --- a/pages/mods/add-new-mod.md +++ b/pages/mods/add-new-mod.md @@ -16,18 +16,18 @@ deprecated: true * If you want to add a new mod to our project, firstly check the mod list in our [GitHub](https://github.com/Faithful-Mods) **and** on our [Faithful Website](https://faithfulpack.net/mods) by typing the name of the mod or its assets folder name. - + > ℹ️ **Info** > See [here](/pages/mods/add-textures) if the mod repository already exists. * If the mod does not have any repository, then create a repository in your **own** profile (if you have access to the Faithful Mods organisation, then create it there). The repository needs to have the same name as the `assets` folder file (ex: `Actually Additions` mod repository would be named: `actuallyadditions`). - + * Keep the `main` branch empty (you can add a `readme.md` / `license.md` stuff but **no textures** on that branch) and make a new branch for each supported Minecraft version. - + > ⚠️ **Warning** > - The `main` branch needs to be set as the **default branch**! Do not merge other branches into the main branch! @@ -41,7 +41,7 @@ deprecated: true * Your repository now should look like this: - + > ℹ️ **Info** diff --git a/pages/mods/add-new-version.md b/pages/mods/add-new-version.md index a1e44db..eb383e5 100644 --- a/pages/mods/add-new-version.md +++ b/pages/mods/add-new-version.md @@ -19,14 +19,14 @@ deprecated: true #### **Using GitHub Website:** Type the Minecraft version you want to add support for, then click on `Create a branch`. - + #### **Using GitHub Desktop:** 1. Click on the `current branch` button, then `New branch`, then type the Minecraft version you want to add support for, if `main` is not selected, click on it, then `create branch`. - +Do note that these methods can be mixed and matched in certain amounts to get a material looking as it should.
Do note that all of these dithering methods can be mixed and matched at various intensities in a single texture. This is often required to accurately portray a desired material.
- + Picture 8: Examples of mixed dithering methods: linear and regular on stone, regular and hints of checkerboard dithering on sand, respectively.Special rules and/or exceptions can apply to specific textures if the Art Director Council approves it.
+::: danger NOTE +Special rules and/or exceptions can apply to specific textures if the Art Director Council approves it. +::: + **Tips**