Difference between revisions of "Mudlet Map Browser"

From Mudlet
Jump to navigation Jump to search
m (fix category)
 
(2 intermediate revisions by the same user not shown)
Line 14: Line 14:
 
<!-- A description about what your script accomplishes. -->
 
<!-- A description about what your script accomplishes. -->
  
Display Mudlet maps in a browser.
+
Display Mudlet maps (.dat format) in a web browser for hosting online or locally.
 +
 
 +
e.g: https://delwing.github.io/arkadia-mapa/
  
 
= Usage =
 
= Usage =
<!-- include function parameters and some usage details (either screenshots or <code>preformatted script output</code> so players can understand how to use your script -->
+
Github is a requirement as this script uses Github Actions to produce the resulting static web page.
 
 
  
 
# Create new repository using this one as template.
 
# Create new repository using this one as template.
Line 34: Line 35:
 
= Examples =
 
= Examples =
  
<!-- Usage details. -->
+
https://delwing.github.io/arkadia-mapa/
 +
 
 +
https://ire-mudlet-mapping.github.io/AchaeaCrowdmap/
  
[[File:Mudlet Map Browser.png|thumb|left]]
+
[[File:Mudlet Map Browser.png|thumb|left|screenshot]]

Latest revision as of 06:07, 9 May 2024

Game non-mud specific
By Delwing
Download Github
Dependencies Mudlet 4.17

Description

Display Mudlet maps (.dat format) in a web browser for hosting online or locally.

e.g: https://delwing.github.io/arkadia-mapa/

Usage

Github is a requirement as this script uses Github Actions to produce the resulting static web page.

  1. Create new repository using this one as template.
  2. Replace map.dat with your own map file
  3. Replace logo.svg and favicon.ico
  4. In page/i18n/en.json replace %title% and %description%
  5. Optionally you can also replace ones in page/index.html
  6. You can add npcs to be searchable in page/data/npc.json just as the one that it's there.
  7. Push
  8. Go to repository Settings -> Pages. In Build and deployment section set Source as Github Actions
  9. Visit your page under https://{repositoryOwner}.github.io/{repository}/ so in case if this example it is: https://delwing.github.io/online-mudlet-map-template/

See also: Mudlet Forums

Examples

https://delwing.github.io/arkadia-mapa/

https://ire-mudlet-mapping.github.io/AchaeaCrowdmap/

screenshot