Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@ gem "jekyll", "~> 4.3" # installed by `gem jekyll`

gem "just-the-docs", "0.10.1" # pinned to the current release
# gem "just-the-docs" # always download the latest release

gem 'jekyll-relative-links'
32 changes: 15 additions & 17 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ GEM
addressable (2.8.7)
public_suffix (>= 2.0.2, < 7.0)
base64 (0.3.0)
bigdecimal (3.2.2)
bigdecimal (3.3.1)
colorator (1.1.0)
concurrent-ruby (1.3.5)
csv (3.3.5)
Expand All @@ -17,16 +17,16 @@ GEM
ffi (1.17.2-x86_64-darwin)
ffi (1.17.2-x86_64-linux-gnu)
forwardable-extended (2.6.0)
google-protobuf (4.31.1-arm64-darwin)
google-protobuf (4.33.1-arm64-darwin)
bigdecimal
rake (>= 13)
google-protobuf (4.31.1-x64-mingw-ucrt)
google-protobuf (4.33.1-x64-mingw-ucrt)
bigdecimal
rake (>= 13)
google-protobuf (4.31.1-x86_64-darwin)
google-protobuf (4.33.1-x86_64-darwin)
bigdecimal
rake (>= 13)
google-protobuf (4.31.1-x86_64-linux-gnu)
google-protobuf (4.33.1-x86_64-linux-gnu)
bigdecimal
rake (>= 13)
http_parser.rb (0.8.0)
Expand All @@ -53,13 +53,15 @@ GEM
webrick (~> 1.7)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-relative-links (0.7.0)
jekyll (>= 3.3, < 5.0)
jekyll-sass-converter (3.1.0)
sass-embedded (~> 1.75)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
json (2.13.2)
json (2.16.0)
just-the-docs (0.10.1)
jekyll (>= 3.8.5)
jekyll-include-cache
Expand All @@ -77,21 +79,16 @@ GEM
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (6.0.2)
rake (13.3.0)
rake (13.3.1)
rb-fsevent (0.11.2)
rb-inotify (0.11.1)
ffi (~> 1.0)
rexml (3.4.2)
rouge (4.6.0)
rexml (3.4.4)
rouge (4.6.1)
safe_yaml (1.0.5)
sass-embedded (1.89.2-arm64-darwin)
google-protobuf (~> 4.31)
sass-embedded (1.89.2-x64-mingw-ucrt)
google-protobuf (~> 4.31)
sass-embedded (1.89.2-x86_64-darwin)
google-protobuf (~> 4.31)
sass-embedded (1.89.2-x86_64-linux-gnu)
sass-embedded (1.94.2)
google-protobuf (~> 4.31)
rake (>= 13)
terminal-table (3.0.2)
unicode-display_width (>= 1.1.1, < 3)
unicode-display_width (2.6.0)
Expand All @@ -105,7 +102,8 @@ PLATFORMS

DEPENDENCIES
jekyll (~> 4.3)
jekyll-relative-links
just-the-docs (= 0.10.1)

BUNDLED WITH
2.3.9
2.3.27
5 changes: 4 additions & 1 deletion _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,7 @@ exclude:

sass:
quiet_deps: true # https://github.com/just-the-docs/just-the-docs/issues/1541
silence_deprecations: ['import'] # https://github.com/just-the-docs/just-the-docs/issues/1607
silence_deprecations: ['import'] # https://github.com/just-the-docs/just-the-docs/issues/1607

plugins:
- jekyll-relative-links
65 changes: 65 additions & 0 deletions _sass/custom/custom.scss
Original file line number Diff line number Diff line change
Expand Up @@ -119,3 +119,68 @@ th {
margin-left: calc( (100% - #{$page-width}) / 2 + #{$sidebar-width} );
}
}

h2, h3 {
scroll-margin-top: 1em;
}

// Highlight linked headings -->
h2:not(:has(> code)):target,
h3:not(:has(> code)):target {
animation: highlightTexts 3s ease-out;
}

@keyframes highlightTexts {
from {
text-shadow:
0 0 2em rgba(170, 170, 255, 1.0),
0 0 1em rgba(170, 170, 255, 1.0),
0 0 0.1em rgba(170, 170, 255, 1.0);
}
to {
box-shadow: 0 0 0em rgba(255, 255, 170, 0.0);
}
}

h2:target > code,
h3:target > code {
animation: highlightConfigs 3s ease-out;
}

@keyframes highlightConfigs {
from {
box-shadow: 0 0 1em 0 rgba(170, 170, 255, 1.0);
}
to {
box-shadow: 0 0 0em 0 rgba(255, 255, 170, 0.0);
}
}
// <-- Highlight linked headings

section.config-indent {
--indent-size: 2em;

&::before, &::after {
position: relative;
font-family: monospace;
left: calc(-1 * var(--indent-size) - 0.5ch); //-0.5ch to center the line neatly between the {}'s
}

&::before { content: "{"; }
&::after { content: "}"; }

& :first-child { margin-top: 0; }
& :last-child { margin-bottom: 0; }

padding-left: var(--indent-size);

--bracket-height: 2em;
border-left: 1px solid transparent;
border-image: linear-gradient(to bottom,
transparent var(--bracket-height),
grey var(--bracket-height),
grey calc(100% - var(--bracket-height)),
transparent calc(100% - var(--bracket-height))
);
border-image-slice: 1;
}
73 changes: 73 additions & 0 deletions wiki/configs/Core.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
layout: page
title: Core
parent: Configs
grand_parent: Wiki
nav_order: 1
---

# Core-Config

> **Info:**
> When a "default" is mentioned for any option, it is meant that if the option is commented out, that is what BlueMap will use.
> This may not be the same as the option that is pre-filled-in.
{: .info }

## `accept-download`
By changing this setting to `true` you are indicating that you have accepted [Mojang's EULA](https://account.mojang.com/documents/minecraft_eula),
you confirm that you own a license to Minecraft (Java Edition)
and you agree that BlueMap will download and use a minecraft-client file (depending on the minecraft-version)
from [Mojang's servers](https://piston-meta.mojang.com/mc/game/version_manifest.json) for you.
This file contains resources that belong to Mojang and you must not redistribute it or do anything else that is not compliant with mojang's EULA.

BlueMap uses resources in this file to generate the 3D-models used for the map and texture them. (BlueMap will not work without those resources.)

## `data`
The folder where BlueMap saves data-files it needs during runtime, or to save e.g. the render-progress to resume it later.

_Default is_ `"bluemap"`

## `render-thread-count`
This changes the amount of threads that BlueMap will use to render the maps.
A higher value can improve render-speed, but could impact performance on the host machine.
This should be always below or equal to the number of available processor-cores.

Zero or a negative value means the amount of available processor-cores subtracted by the value.
(So a value of -2 with 6 cores results in 4 render-processes)

_Default varies per machine_

## `scan-for-mod-resources`
Controls whether BlueMap should try to find and load mod-resources and datapacks from the server/world-directories.

_Default is_ `true`

## `metrics`
If this is `true`, BlueMap might send really basic metrics reports containing only the implementation-type and the version that is being used to [metrics.bluecolored.de/bluemap](https://metrics.bluecolored.de/)

This allows me to track the basic usage of BlueMap and helps me stay motivated to further develop this tool!
Please leave it on :)

An example report looks like this: `{"implementation":"bukkit","version":"5.13","mcVersion":"?"}`

_Default is_ `true`

## `log`
Config-section for debug-logging

<section markdown="1" class="config-indent">

### `file`
The file where the debug-log will be written to.
Comment out to disable debug-logging completely.

[Java String formatting syntax](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html) can be used to add time.

_Default is no logging_

### `append`
Whether the logger should append to an existing file, or overwrite it

_Default is_ `false`

</section>
Loading