Skip to content

Commit 570e28b

Browse files
authored
Update Customisation.md
1 parent 5f08d26 commit 570e28b

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

community/Customisation.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Keep in mind that some BlueMap updates require you to delete the `index.html` fi
1414
so make sure to remember any edits you do to it and any of BlueMap's other source files, because you will need to apply them again.
1515

1616
> **Info:**
17-
> Throughout this guide, `/bluemap/web/` shall be assumed as the default webroot. If you're using a custom, different webroot, please make sure to use that instead.
17+
> Throughout this guide, `./bluemap/web/` shall be assumed as the default webroot. If you're using a custom, different webroot, please make sure to use that instead.
1818
{: .info }
1919

2020
1. TOC
@@ -29,21 +29,21 @@ Custom styles are not limited to any specific platform; they work on all platfor
2929
> If you don't know how to write CSS yet, here is a good guide: [developer.mozilla.org/en-US/docs/Learn/CSS](https://developer.mozilla.org/en-US/docs/Learn/CSS)
3030
{: .info }
3131

32-
To get started with BlueMap CSS, you should create a `.css` file in your webroot (usually `/bluemap/web/`).
32+
To get started with BlueMap CSS, you should create a `.css` file in your webroot (usually `./bluemap/web/`).
3333
Then you need to register that stylesheet with BlueMap, so it'll actually load it.
3434
You do this in [`webapp.conf`](../wiki/configs/Webapp.md), by putting the file name in the `styles: [ ]` list.
3535
After adding it to the list, you'll want to reload BlueMap, so BlueMap applies the changes you've made to the configs.
3636
You can do so with the `/bluemap reload light` command.
3737

3838
To test if it works, you can use this simple style:
3939

40-
`/bluemap/web/my-custom-style.css`:
40+
`./bluemap/web/my-custom-style.css`:
4141
```css
4242
:root {
4343
--theme-bg: red;
4444
}
4545
```
46-
`plugins/BlueMap/webapp.conf`:
46+
`./plugins/BlueMap/webapp.conf`:
4747
```hocon
4848
styles: [
4949
"my-custom-style.css"
@@ -64,19 +64,19 @@ Custom scripts are not limited to any specific platform; they work on all platfo
6464
> If you don't know how to write JavaScript yet, here is a good guide: [developer.mozilla.org/en-US/docs/Learn/JavaScript](https://developer.mozilla.org/en-US/docs/Learn/JavaScript)
6565
{: .info }
6666

67-
To get started with BlueMap JavaScript, you should create a `.js` file in your webroot (usually `/bluemap/web/`).
67+
To get started with BlueMap JavaScript, you should create a `.js` file in your webroot (usually `./bluemap/web/`).
6868
Then you need to register that script with BlueMap, so it'll actually load it.
6969
You do this in [`webapp.conf`](../wiki/configs/Webapp.md), by putting the file name in the `scripts: [ ]` list.
7070
After adding it to the list, you'll want to reload BlueMap, so BlueMap applies the changes you've made to the configs.
7171
You can do so with the `/bluemap reload light` command.
7272

7373
To test if it works, you can use this simple script:
7474

75-
`/bluemap/web/my-custom-script.js`:
75+
`./bluemap/web/my-custom-script.js`:
7676
```js
7777
console.log("Hello world!");
7878
```
79-
`plugins/BlueMap/webapp.conf`:
79+
`./plugins/BlueMap/webapp.conf`:
8080
```hocon
8181
scripts: [
8282
"my-custom-script.js"
@@ -93,7 +93,7 @@ In some places, when you share a link to your map, it'll embed a bit of extra in
9393

9494
![Screenshot of the default BlueMap embed in Discord](../assets/BlueMapDiscordEmbed.png)
9595

96-
You can change how this looks by editing the `bluemap/web/index.html` file.
96+
You can change how this looks by editing the `./bluemap/web/index.html` file.
9797
The options you can safely change are the `description`, `theme-color`, `og:site_name`, `og:title`, `og:description`, and `og:image`.
9898

9999
> The `og:image` attribute should be a full URL link, not a relative path.
@@ -102,29 +102,29 @@ The options you can safely change are the `description`, `theme-color`, `og:site
102102
## Website favicon
103103
A favicon is the icon you'll see on the tab in your browser, and in the favourites bar if you've favourited the website.
104104
There are two ways to change BlueMap's favicon:
105-
1. Replace the favicon image `/bluemap/web/assets/favicon-8768b872.png`
105+
1. Replace the favicon image `./bluemap/web/assets/favicon-8768b872.png`
106106
2. Copy a new image file to the BlueMap webroot (or `assets` directory) and edit the `<link rel="icon" href="./assets/favicon-8768b872.png">` in `index.html` to refer to your new image instead.
107107

108108
## Website title
109109
The title is the text that is on the tab in your browser.
110110
Changing the `<title>` tag in the `index.html` will not work!
111-
You need to change it in each language file, which are at `/bluemap/web/lang/`.
111+
You need to change it in each language file, which are at `./bluemap/web/lang/`.
112112
The option `pageTitle` in the `.conf` files in this directory are what you need to change.
113113

114114
## Default language
115115
You can change the default language for your map, which will apply for all new visitors.
116116
It will not change the language for people who have already visited your site once already.
117-
In `/bluemap/web/lang/settings.conf` is the setting `default`, which you can change to any of the locales listed below it.
117+
In `./bluemap/web/lang/settings.conf` is the setting `default`, which you can change to any of the locales listed below it.
118118

119119
## Info menu
120120
BlueMap has an *Info* menu in the sidebar, which is also completely customisable.
121-
You can edit it in each language file, which are at `/bluemap/web/lang/`.
121+
You can edit it in each language file, which are at `./bluemap/web/lang/`.
122122
The option `info: { content:` is the one you need to edit for this.
123123
It accepts any normal HTML.
124124

125125
## Screenshot file name
126126
BlueMap has a screenshot feature, which downloads a screenshot to your device.
127-
You can change the filename of that by opening the `/bluemap/web/assets/index-123456.js` file, and then doing a `Ctrl`+`F` for "`bluemap-screenshot.png`".
127+
You can change the filename of that by opening the `./bluemap/web/assets/index-123456.js` file, and then doing a `Ctrl`+`F` for "`bluemap-screenshot.png`".
128128
By changing that piece of text, you can choose any other filename you wish.
129129

130130
## (Sub)Domain

0 commit comments

Comments
 (0)