Skip to content

Commit b9ef1eb

Browse files
Merge pull request #42 from QuickShop-Community/fix/updates
Update to correct crowdin, more documentation updates.
2 parents c15a0e6 + c33e001 commit b9ef1eb

14 files changed

Lines changed: 1240 additions & 167 deletions

File tree

.github/workflows/node.js.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ jobs:
2626
- name: Sync with Crowdin
2727
run: npm run crowdin:sync
2828
env:
29-
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN }}
29+
CROWDIN_PERSONAL_TOKEN: ${{ secrets.CROWDIN_PERSONAL_TOKEN_UPDATED }}
3030
- name: Build website
3131
run: npm run build
3232
- name: Deploy to GitHub Pages

crowdin.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
project_id: '559555'
2-
api_token_env: CROWDIN_PERSONAL_TOKEN
1+
project_id: '777746'
2+
api_token_env: CROWDIN_PERSONAL_TOKEN_UPDATED
33
preserve_hierarchy: true
44
files:
55
# JSON 翻译文件

docs/about/licenses.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Licenses
22

3-
Quickshop-Hikari is dual licensed under [GNU General Public License v3.0][gplv3] and [GNU Affero General Public License v3.0][https://www.gnu.org/licenses/agpl-3.0.html].
4-
New contributions will follow the updated license of [GNU Affero General Public License v3.0][https://www.gnu.org/licenses/agpl-3.0.html].
3+
Quickshop-Hikari is dual licensed under [GNU General Public License v3.0][gplv3] and [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.html).
4+
New contributions will follow the updated license of [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.html).
55

66
## Third-party components
77

docs/addon/bluemap.md

Lines changed: 149 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,172 @@ Can't find where to download the JAR? [Click here](../faq/where-addons-compacts-
66

77
:::
88

9-
BlueMap Addon can display the shop on your [BlueMap](https://modrinth.com/plugin/bluemap) instance!
9+
The BlueMap Addon allows QuickShop to display shops directly on your [BlueMap](https://modrinth.com/plugin/bluemap) web map.
10+
11+
Players can view:
12+
13+
- Shop locations
14+
- Item being sold or bought
15+
- Price
16+
- Stock
17+
- Owner
18+
- Shop type
19+
20+
As of 6.2.0.11, the BlueMap addon now supports **colored markers based on shop state**.
21+
22+
---
23+
24+
## New in 6.2.0.11
25+
26+
The BlueMap addon now supports:
27+
28+
- Colored markers based on shop type/state
29+
- Improved compatibility with the new ShopType system
30+
- Better synchronization with the revamped event system
31+
- More accurate updates when shop type changes
32+
33+
Markers now visually reflect:
34+
35+
- SELLING shops
36+
- BUYING shops
37+
- FROZEN shops
38+
39+
This makes it easier for players to understand shop behavior directly from the map.
40+
41+
---
1042

1143
## Showcase
1244

1345
![bluemap](img/bluemap.png)
1446

47+
---
48+
49+
## How It Works
50+
51+
When a shop is:
52+
53+
- Created
54+
- Removed
55+
- Updated
56+
- Frozen or unfrozen
57+
- Switched between BUYING/SELLING
58+
59+
The BlueMap addon automatically updates the marker.
60+
61+
Markers are:
62+
63+
- Added when shops are created
64+
- Removed when shops are deleted
65+
- Updated when price, stock, or type changes
66+
67+
No manual refresh required.
68+
69+
---
70+
71+
## Colored Markers
72+
73+
Markers can now display different colors depending on shop state.
74+
75+
Typical behavior:
76+
77+
- Selling shops → default color
78+
- Buying shops → alternate color
79+
- Frozen shops → disabled / muted color
80+
81+
This makes it easy to visually distinguish shop types on the map.
82+
83+
The color logic follows the new shop type system introduced in 6.2.0.11.
84+
85+
---
86+
1587
## Configuration
1688

1789
```yaml
1890
config-version: 1
91+
1992
# If you want the marker set/markers to display by default when opening the map.
2093
display-by-default: true
21-
#Location for the image you want as your quick-shop marker, it's defaulted to the BlueMap assets folder.
94+
95+
# Location for the image you want as your QuickShop marker.
96+
# Default is inside the BlueMap assets folder.
2297
icon-file-location: "/assets/chest.png"
23-
# If you want to display the marker icon.
98+
99+
# Display the marker icon on the map.
24100
display-icon: true
25-
# Max distance of range where the user can see the marker, useful for lag reduction in frames.
101+
102+
# Maximum distance at which markers are visible.
103+
# Lower values may improve performance on large servers.
26104
max-distance: 1000
27-
# This is where the name of each quick-shop marker when looking at the list (placeholders are %item%, %price%, %stock%, %owner%, %type%, %location%).
105+
106+
# Marker label shown in the marker list.
107+
# Available placeholders:
108+
# %item%, %price%, %stock%, %owner%, %type%, %location%
28109
marker-label: "%item%, %price%, %stock%, %owner%, %type%"
29-
# This is the popup text when clicking the shop marker itself.
30-
marker-detail: '<span style="font-size: 120%">Chest Shop</span><hr><span>Owner: <strong>%owner%</strong></span><br><span>Item: <strong>%item%</strong></span><br><span>Price: <strong>%price%</strong><br><span>Stock: <strong>%stock%</strong><br><span>Type: <strong>%type%</strong><br><span>Location: <strong>%location%</strong></span>'
31-
# How many times per second does the plugin refresh the chestshops?
110+
111+
# Popup text when clicking a marker.
112+
marker-detail: '<span style="font-size: 120%">Chest Shop</span><hr><span>Owner: <strong>%owner%</strong></span><br><span>Item: <strong>%item%</strong></span><br><span>Price: <strong>%price%</strong></span><br><span>Stock: <strong>%stock%</strong></span><br><span>Type: <strong>%type%</strong></span><br><span>Location: <strong>%location%</strong></span>'
113+
114+
# How many times per second does the plugin refresh the shops?
32115
refresh-per-seconds: 5
33-
```
116+
````
117+
118+
---
119+
120+
## Placeholders
121+
122+
The following placeholders are available:
123+
124+
* `%item%`
125+
* `%price%`
126+
* `%stock%`
127+
* `%owner%`
128+
* `%type%`
129+
* `%location%`
130+
131+
These reflect live shop data and update automatically.
132+
133+
---
134+
135+
## Performance
136+
137+
To optimize performance:
138+
139+
* Lower `refresh-per-seconds` on large servers.
140+
* Reduce `max-distance` to limit rendering range.
141+
* Avoid extremely high shop density in a single area.
142+
143+
The addon is event-driven and only refreshes when necessary.
144+
145+
---
34146

35147
## Localization
36148

37-
BlueMap Addon use the `game-language` settings in your QuickShop-Hikari configuration.
149+
The BlueMap Addon uses the `game-language` setting from your QuickShop configuration.
150+
151+
You can customize marker text via QuickShop’s Localization System:
152+
153+
See: `modules/localization.md`
154+
155+
---
156+
157+
## Installation
158+
159+
1. Install BlueMap.
160+
2. Install the QuickShop BlueMap Addon.
161+
3. Restart your server.
162+
163+
If BlueMap is not detected, the addon remains inactive.
164+
165+
---
166+
167+
## Summary
168+
169+
The BlueMap Addon:
170+
171+
* Displays shops on your web map
172+
* Updates automatically
173+
* Supports colored markers by shop state (6.2.0.11+)
174+
* Integrates with the new shop type system
175+
* Requires minimal configuration
38176

39-
You can customize the string via QuickShop-Hikari's [Localization System](../modules/localization.md).
177+
It is recommended for servers that want a modern, web-based shop overview.

0 commit comments

Comments
 (0)