You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: community/Customisation.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Keep in mind that some BlueMap updates require you to delete the `index.html` fi
14
14
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.
15
15
16
16
> **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.
18
18
{: .info }
19
19
20
20
1. TOC
@@ -29,21 +29,21 @@ Custom styles are not limited to any specific platform; they work on all platfor
29
29
> 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)
30
30
{: .info }
31
31
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/`).
33
33
Then you need to register that stylesheet with BlueMap, so it'll actually load it.
34
34
You do this in [`webapp.conf`](../wiki/configs/Webapp.md), by putting the file name in the `styles: [ ]` list.
35
35
After adding it to the list, you'll want to reload BlueMap, so BlueMap applies the changes you've made to the configs.
36
36
You can do so with the `/bluemap reload light` command.
37
37
38
38
To test if it works, you can use this simple style:
39
39
40
-
`/bluemap/web/my-custom-style.css`:
40
+
`./bluemap/web/my-custom-style.css`:
41
41
```css
42
42
:root {
43
43
--theme-bg: red;
44
44
}
45
45
```
46
-
`plugins/BlueMap/webapp.conf`:
46
+
`./plugins/BlueMap/webapp.conf`:
47
47
```hocon
48
48
styles: [
49
49
"my-custom-style.css"
@@ -64,19 +64,19 @@ Custom scripts are not limited to any specific platform; they work on all platfo
64
64
> 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)
65
65
{: .info }
66
66
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/`).
68
68
Then you need to register that script with BlueMap, so it'll actually load it.
69
69
You do this in [`webapp.conf`](../wiki/configs/Webapp.md), by putting the file name in the `scripts: [ ]` list.
70
70
After adding it to the list, you'll want to reload BlueMap, so BlueMap applies the changes you've made to the configs.
71
71
You can do so with the `/bluemap reload light` command.
72
72
73
73
To test if it works, you can use this simple script:
74
74
75
-
`/bluemap/web/my-custom-script.js`:
75
+
`./bluemap/web/my-custom-script.js`:
76
76
```js
77
77
console.log("Hello world!");
78
78
```
79
-
`plugins/BlueMap/webapp.conf`:
79
+
`./plugins/BlueMap/webapp.conf`:
80
80
```hocon
81
81
scripts: [
82
82
"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
93
93
94
94

95
95
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.
97
97
The options you can safely change are the `description`, `theme-color`, `og:site_name`, `og:title`, `og:description`, and `og:image`.
98
98
99
99
> 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
102
102
## Website favicon
103
103
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.
104
104
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`
106
106
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.
107
107
108
108
## Website title
109
109
The title is the text that is on the tab in your browser.
110
110
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/`.
112
112
The option `pageTitle` in the `.conf` files in this directory are what you need to change.
113
113
114
114
## Default language
115
115
You can change the default language for your map, which will apply for all new visitors.
116
116
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.
118
118
119
119
## Info menu
120
120
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/`.
122
122
The option `info: { content:` is the one you need to edit for this.
123
123
It accepts any normal HTML.
124
124
125
125
## Screenshot file name
126
126
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`".
128
128
By changing that piece of text, you can choose any other filename you wish.
0 commit comments