Skip to content

Commit

Permalink
Update wiki for V5 changes (#78)
Browse files Browse the repository at this point in the history
  • Loading branch information
@TBlueF
TBlueF authored Jun 17, 2024
1 parent 18d83b0 commit 0518ed6
Show file tree
Hide file tree
Showing 11 changed files with 143 additions and 185 deletions.
2 changes: 1 addition & 1 deletion community/BluemapLazyServer.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ server {
listen 80;
server_name yourdomain.com;
# path to bluemap-webroot, bluemap can also be used in a sub-folder .. just adapt the paths accordingly
# path to bluemap-webroot, BlueMap can also be used in a sub-folder .. just adapt the paths accordingly
root /var/www;
location ~* ^/maps/[^/]*/tiles/ {
Expand Down
2 changes: 1 addition & 1 deletion community/Chat.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ Then after reloading nginx with `sudo nginx -s reload` we should see our BlueMap

As we no longer use BlueMap's own port for accessing it. We should prevent it from being exposed. In our `docker-compose.yml` file
we can do `"127.0.0.1:8100:8100/tcp"` instead of `"8100:8100/tcp"`. If you don't use Docker, instead of changing Docker's
port bindings change directly the ip address bluemap uses by editing `plugins/BlueMap/webserver.conf` and adding `ip: "127.0.0.1"`.
port bindings change directly the ip address BlueMap uses by editing `plugins/BlueMap/webserver.conf` and adding `ip: "127.0.0.1"`.

## Domain and HTTPS

Expand Down
17 changes: 11 additions & 6 deletions wiki/FAQ.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ BlueMap needs to wait until the server saves the world data to disk, so it may t
on the map. Also make sure to click `Update Map` in the menu on the left to make your browser fetch a fresh copy.

### Q: I'm experiencing issues after updating to a newer BlueMap version!
Please make sure to read the changelog, as there may be more steps necessary than just swapping out the .jar file. Those steps will be clearly listed on the update page.
Please make sure to read the changelog, as there may be more steps necessary than just swapping out the .jar file.
Those steps will be clearly listed on the update page.

### Q: Why is BlueMap using so much of my CPU?
When you install BlueMap for the first time, it needs to convert all of your world(s) into 3d models.
Expand All @@ -50,7 +51,7 @@ First, press the `Update Map` button in BlueMap's menu. This updates all tiles f
your browser has not cached anything weird.
You can also try to clear your browser-cache completely. *(`F12` -> Network -> [x] Disable cache -> `F5`)*

If that doesn't help, you might have changed some bluemap-settings that require a complete re-render of the map:
If that doesn't help, you might have changed some BlueMap-settings that require a complete re-render of the map:
Just use `/bluemap purge <map-id>` to delete and re-render the entire map. Then clear your browser-cache again,
and it should be fixed :)

Expand All @@ -59,12 +60,13 @@ and it should be fixed :)
browser has not cached anything weird.
- Use `/bluemap` to check if BlueMap is rendering something! It might be busy rendering a different map first.
- Make sure that the `world:`-setting in your map-config is set to the correct world-folder.
- Make sure that the `dimension:`-setting in your map-config is correct.
- Make sure your BlueMap-version supports the minecraft-version you are trying to render. *(You can see that on
BlueMap's [official download-page](https://github.com/BlueMap-Minecraft/BlueMap/releases/latest))*
- BlueMap can only render the parts of your world that have already been generated by Minecraft! *(E.g., by exploring
your world or using a plugin to pre-generate an area of your world.)*
- Use the command `/bluemap debug block` (in-game). If that is throwing an error, it is likely that you have a mod
installed that is not compatible with bluemap.
installed that is not compatible with BlueMap.
Check the [incompatibilities-list](#known-incompatibilities-with-other-mods) at the bottom.
If you don't have any mod from the list, please report the error
[here](https://github.com/BlueMap-Minecraft/BlueMap/issues).
Expand Down Expand Up @@ -116,10 +118,13 @@ and add SSL that way.

### Q: My map disappears when I zoom in!
This happens when BlueMap is trying to load the hi-res tiles, but can't find them for some reason.
This could be caused by one of two things:
This could be caused by one of these things:
- You have updated BlueMap, but did not update BlueMap's webapp properly.
Try to delete the `<webroot>/index.html` and reload BlueMap.
- You've set `save-hires-layer` to `false` in your map's config.
If this is the case, make sure to set the `hires-slider-default` to `0` in `webapp.conf` and set the "Render Distance - Hires Layer" slider down to `0` in the webapps settings-menu.
- You haven't set up your external webserver correctly yet.
If this is the case, make sure to set the `hires-slider-default` to `0` in `webapp.conf` and set the
"Render Distance - Hires Layer" slider down to `0` in the webapps settings-menu.
- You haven't set up your external webserver correctly.
Please make sure you've read the [External Webservers]({{site.baseurl}}/wiki/webserver/) guide to see how to do that.

If you're still having issues, please visit [#support](https://discord.com/channels/665868367416131594/751804128749027421) in our [Discord](https://bluecolo.red/map-discord).
Expand Down
55 changes: 17 additions & 38 deletions wiki/customization/Mods.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,22 @@ BlueMap is automatically looking for mods and datapacks in your server-files. If
and parse its resources to be able to render any additional blocks.
If you don't want this, you can turn this auto-discovery off in the `core.conf` -> `scan-for-mod-resources`.

BlueMap might not be able to parse all blocks and resources for a mod. For example, if a mod generates it's resources/block-models at
runtime, bluemap won't be able to find them in the `mod.jar` and will not be able to render them correctly!
BlueMap might not be able to parse all blocks and resources for a mod. For example, if a mod generates its resources/block-models at
runtime, BlueMap won't be able to find them in the `mod.jar` and will not be able to render them correctly!
If you have experience with creating resource-packs with custom models, then you can easily make a resource-pack with static
resources for such a mod. BlueMap can then load your resource-pack instead and render the blocks based on that.

## Configs
Some mods add special blocks or biomes that bluemap can't easily read from the mod's resources.
For this, you can add some configs to tell bluemap how to render those special blocks and biomes.
**You need to put these config files in a .zip file or folder, and then put that into bluemaps resourcepacks folder.**
*(You are basically creating a special resource-pack for bluemap here)*
Some mods add special blocks that have properties that BlueMap can't easily read from the mod's resources.
For this, you can add some configs to tell BlueMap how to render them.
**You need to put these config files in a .zip file or folder, and then put that into BlueMap's `packs` folder.**
*(You are basically creating a special resource-pack for BlueMap here)*

### Custom block models
Use the standard [resourcepack format](https://minecraft.wiki/w/Resource_pack) to define custom block-states and block-models.

### Custom biomes
Use the standard [datapack format](https://minecraft.wiki/w/Biome_definition) to define custom biomes.

### Block-properties config
**File:** `assets/modid/blockProperties.json`<br>
Expand All @@ -35,11 +41,12 @@ For this, you can add some configs to tell bluemap how to render those special b
{
"minecraft:bubble_column": { "alwaysWaterlogged": true },
"minecraft:grass": { "randomOffset": true },
"minecraft:glass": { "occluding": false }
"minecraft:glass": { "occluding": false, "cullingIdentical": true },
"minecraft:ice": { "cullingIdentical": true }
}
```

Usually bluemap tries to guess those properties based on the block's model. But if that guess is not correct, you can
Usually BlueMap tries to guess those properties based on the block's model. But if that guess is not correct, you can
change the render-behaviour of a block with this config.

Possible properties for blocks are:
Expand All @@ -49,6 +56,8 @@ Possible properties for blocks are:
done for grass-blocks and flowers
- `occluding` is used to determine if the block is "occluding" light when calculating
the [ambient occlusion](https://en.wikipedia.org/wiki/Ambient_occlusion) on neighbor blocks.
- `cullingIdentical` means that if the block is directly next to another block of the same type, then the side facing
that block will be culled (removed)

### Block-colors config
**File:** `assets/modid/blockColors.json`<br>
Expand All @@ -68,33 +77,3 @@ properties or are just static.
Possible values are `@foliage`, `@grass`, `@water` to use the foliage-, grass- or water-color of the biome to color
the block, `@redstone` to use the power-level of the block *(used for redstone)*,
or a static color using a [css-style color-hex](https://htmlcolorcodes.com/color-picker/) like `#86a863`.

### Biomes config
**File:** `assets/modid/biomes.json`<br>
**Example:**
```json
{
"minecraft:flower_forest": {
"humidity": 0.8,
"temperature": 0.7,
"watercolor": 4159204
},
"minecraft:birch_forest": {
"humidity": 0.6,
"temperature": 0.6,
"watercolor": "#3f76e4"
},
"minecraft:dark_forest": {
"humidity": 0.8,
"temperature": 0.7,
"watercolor": 4159204,
"foliagecolor": "#28340a55",
"grasscolor": "#28340a88"
}
}
```

If a mod adds a new biome, bluemap needs to know some properties of that biome to calculate things like grass and
foliage-color. You can define these using this config. Undefined biomes will be treated as an ocean-biome.

*(The biomes-config works only for Minecraft 1.18+ worlds)*
30 changes: 15 additions & 15 deletions wiki/customization/ResourcePacks.md
View file
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
---
layout: page
title: Installing Resource-Packs
title: Resource/Data-packs
parent: Advanced Customization
grand_parent: Wiki
nav_order: 3
---

# Installing Resource-Packs
# Installing Resourcepacks or Datapacks

BlueMap supports the use of minecraft resource-packs. If you want to change the appearance of your map,
use high resolution textures or fancy block-models.
BlueMap supports the use of minecraft resourcepacks and datapacks. If you want to change the appearance of your map,
use high resolution textures or fancy block-models or customize biomes.

> **Important:**
> If you change your resource-pack setup you need to delete your previous renders!
> If you change your resource/data-pack setup you need to delete your previous renders!
> Purge your maps with `/bluemap purge <map>`.
> Otherwise, you will get broken models with really weird textures.
> Otherwise, you might get broken models and/or weird texture-mixups.
{: .info .important }

To install a resource-pack you just need to put the resource-pack folder or zip in the folder `resourcepacks` next to
To install a resource/data-pack you just need to put the pack-folder or zip into the folder `packs` next to
your configuration files and reload BlueMap. BlueMap will scan the folder and try to load every resource it finds.

> Sponge, Forge, Fabric: `./config/bluemap/resourcepacks/`<br>
> Spigot/Paper: `./plugins/BlueMap/resourcepacks/`
> Sponge, Forge, Fabric: `./config/bluemap/packs/`<br>
> Spigot/Paper: `./plugins/BlueMap/packs/`
> CLI: `./config/packs/`
{: .info }

You can use more than one resource-pack. Like in minecraft, they will override each other. They are loaded in
alphabetical order, so a resource-pack called `zzzresources.zip` will override `aaaresources.zip`.<br>
You can use more than one resource/data-pack. Like in minecraft, they will override each other. They are loaded in
alphabetical order, so a pack called `zzzresources.zip` will override `aaaresources.zip`.
This means you can reorder them by renaming them e.g. `01_some_pack.zip`, `02_some_extension_pack.zip`...

Make sure the resource-pack is for the correct minecraft-version. Otherwise, it might not be loaded correctly.<br>
There might be warnings in the console if you are using resource-packs that have some unexpected formatting. A warning
mostly results in a single (block-)model not loaded correctly, so all the other resources from that resource-pack are
still being loaded.
Make sure the resource/data-pack is for the correct minecraft-version. Otherwise, it might not be loaded correctly.
You can check the `./bluemap/logs/debug.log` (`./data/logs/debug.log` on cli) to find warnings that might occur when
loading resource/data-packs.
19 changes: 9 additions & 10 deletions wiki/customization/Storages.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,9 +64,9 @@ somehow:

For **Spigot, Fabric and Forge** there are a couple of [mods/plugins](https://modrinth.com/mods?q=jdbc) which add such a driver.

Alternatively you can also **manually** download the JDBC-Driver of your choice and configure bluemap to load it:
Download the driver-jar (e.g. [mariadb-java-client-3.2.0.jar](https://mariadb.com/downloads/connectors/connectors-data-access/java8-connector/))
and place it in the `./bluemap` folder. Then set `driver-jar: "bluemap/mariadb-java-client-3.2.0.jar"` and `driver-class: "org.mariadb.jdbc.Driver"`
Alternatively you can also **manually** download the JDBC-Driver of your choice and configure BlueMap to load it:
Download the driver-jar (e.g. [mariadb-java-client.jar](https://mariadb.com/downloads/connectors/connectors-data-access/java8-connector/))
and place it in the `./bluemap` folder. Then set `driver-jar: "bluemap/mariadb-java-client.jar"` and `driver-class: "org.mariadb.jdbc.Driver"`
to tell BlueMap where to find the jar and which class to load from it. *(Don't forget to remove the `#` to uncomment the settings)*

## Sqlite
Expand All @@ -91,10 +91,9 @@ All the storage-types have a `compression` setting. It defines how each hires-ti
The default and recommended compression is `GZIP`, since browsers can receive the files compressed and decompress them on the fly.
The supported compression settings are:

| setting | description |
|------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `compression: NONE` | No compression, map tiles will be stored in plain json format.<br/>*Uncompressed files will be about 20x as big!* |
| `compression: GZIP` | [GZip](https://en.wikipedia.org/wiki/Gzip) compression.<br/>*Recommended.* |
| `compression: DEFLATE` | [Deflate](https://en.wikipedia.org/wiki/Deflate) compression. |
| `compression: ZSTD` | [Zstandard](https://en.wikipedia.org/wiki/Zstd) compression.<br/>*This compression is not supported by browsers. Selecting this means that BlueMap will need to recompress the file to gzip each time before sending it to the client! (Very slow!)* |

| setting | description |
|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `compression: NONE` | No compression, map tiles will be stored in plain json format.<br/>*Uncompressed files will be about 20x as big!* |
| `compression: GZIP` | [GZip](https://en.wikipedia.org/wiki/Gzip) compression.<br/>*Recommended.* |
| `compression: DEFLATE` | [Deflate](https://en.wikipedia.org/wiki/Deflate) compression. |
| `compression: ZSTD` | [Zstandard](https://en.wikipedia.org/wiki/Zstd) compression.<br/>*This compression is not supported by some browsers. BlueMap might need to recompress the file to gzip each time before sending it to the client! (Very slow!)* |
Loading

0 comments on commit 0518ed6

Please sign in to comment.