Revision as of 05:51, 9 May 2024

Description

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

Instructions for github.io;

Create new repository using this one as template.
Replace map.dat with your own map file
Replace logo.svg and favicon.ico
In page/i18n/en.json replace %title% and %description%
Optionally you can also replace ones in page/index.html
You can add npcs to be searchable in page/data/npc.json just as the one that it's there.
Push
Go to repository Settings -> Pages. In Build and deployment section set Source as Github Actions
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/

@@ Line 17: / Line 17: @@
 = 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 -->
+Instructions for github.io;
 # Create new repository using this one as template.