Generic mapper package - Revision history

Zooka: /* Helpful Additions */

2024-11-09T11:47:08Z

Helpful Additions

Zooka: /* Usage */

2024-11-08T10:04:42Z

Usage

Zooka: /* Pattern Matching */

2024-11-08T09:55:53Z

Pattern Matching

Zooka: /* Examples */

2024-11-08T09:53:39Z

Examples

Dt192 at 02:38, 19 January 2024

2024-01-19T02:38:40Z

Show changes

Zooka: /* Feature Delete */

2024-01-19T02:33:32Z

Feature Delete

Zooka: /* Room Delete Feature */

2024-01-19T02:33:16Z

Room Delete Feature

Zooka: /* Room Create Feature */

2024-01-19T02:32:59Z

Room Create Feature

Zooka: /* Feature Create */

2024-01-19T02:32:38Z

Feature Create

Zooka: /* Room Label */

2024-01-19T02:32:19Z

Room Label

← Older revision		Revision as of 11:47, 9 November 2024
Line 792:		Line 792:

	= Helpful Additions =		= Helpful Additions =
−	[[Generic_Mapper_Additions\|Generic Mapper Additions]]	+
		+	Some helpful Mudleteers have provided some ways to modify generic_mapper for their games. See [[Generic_Mapper_Additions\|Generic Mapper Additions]] for more ideas.

← Older revision		Revision as of 10:04, 8 November 2024
Line 22:		Line 22:

	See also: [https://forums.mudlet.org/viewtopic.php?f=13&t=6105 Mudlet Forums]		See also: [https://forums.mudlet.org/viewtopic.php?f=13&t=6105 Mudlet Forums]
		+
		+	There are also some Youtube videos of getting started in the mapper.
		+
		+	[https://www.youtube.com/watch?v=m6nqwbvEJXc Mudlet Generic Mapper Tutorial]
		+
		+	[https://www.youtube.com/watch?v=Kjckwn1ZyrI Automapping in Mudlet]

	== Commands ==		== Commands ==

@@ Line 733: / Line 733: @@
 = Examples =
-== Pattern Matching ==
+== Prompt Pattern Matching ==
-Pattern matching (used with <code>map prompt</code> and <code>map ignore</code> commands) uses [https://www.lua.org/pil/20.2.html Lua pattern matching] (as opposed to regex matching used in Aliases or Triggers).  While similar there are a few key differences, notably the use of percentage character (<code>%</code>).
+Pattern matching (used with <code>map prompt</code> and also <code>map ignore</code> commands) uses [https://www.lua.org/pil/20.2.html Lua pattern matching] (as opposed to regex matching used in Aliases or Triggers).  While similar there are a few key differences, notably the use of percentage character (<code>%</code>).
 '''Character Classes'''

@@ Line 733: / Line 733: @@
 = Examples =
-<!-- Usage details. -->
+== Pattern Matching ==
-TODO
 = Helpful Additions =
 [[Generic_Mapper_Additions|Generic Mapper Additions]]

@@ Line 675: / Line 675: @@
 This command deletes a global map feature and removes it from all rooms.
-Example: <syntaxhighlight = "lua">feature delete A Nexus Point</syntaxhighlight> - removes the global feature
+Example: <syntaxhighlight = "lua">feature delete A Nexus Point</syntaxhighlight>
-'A Nexus Point' and removes it from all rooms
+: removes the global feature 'A Nexus Point' and removes it from all rooms
 == Events ==

@@ Line 663: / Line 663: @@
 <syntaxhighlight = "lua">rdf [v<room id>] <feature></syntaxhighlight>
-This command removes a map feature from the room. If the map feature is
+This command removes a map feature from the room. If the map feature is associated with a character mark and its set on the room, a random
-associated with a character mark and its set on the room, a random
+character mark from the other map features on the room is chosen to replace it. The room number to delete the feature from can be given with
-character mark from the other map features on the room is chosen to
+the optional argument (note: there is no space between the v and the ID).
-Example: <syntaxhighlight = "lua">rdf v123 A Nexus Point</syntaxhighlight> - removes the feature 'A Nexus Point'
+Example: <syntaxhighlight = "lua">rdf v123 A Nexus Point</syntaxhighlight>
-from the room #123
+: removes the feature 'A Nexus Point' from the room #123
 === Feature Delete ===

@@ Line 650: / Line 650: @@
 <syntaxhighlight = "lua">rcf [v<room id>] <feature></syntaxhighlight>
-This command will add a created map feature to the room. If the map
+This command will add a created map feature to the room. If the map feature is associated with a character mark, it will be set on the room
-feature is associated with a character mark, it will be set on the room
+and existing marks get overwritten. The room number to add the feature to can be given with the optional argument (note: there is no space
 between the v and the ID).
-Example: <syntaxhighlight = "lua">rcf A Nexus Point</syntaxhighlight> - add the feature 'A Nexus Point' to
+Example: <syntaxhighlight = "lua">rcf A Nexus Point</syntaxhighlight>
-the current room
+: add the feature 'A Nexus Point' to the current room
-<syntaxhighlight = "lua">rcf v123 A Nexus Point</syntaxhighlight> - add the feature 'A Nexus Point'
+<syntaxhighlight = "lua">rcf v123 A Nexus Point</syntaxhighlight>
-to room #123
+: add the feature 'A Nexus Point' to room #123
 === Room Delete Feature ===

@@ Line 640: / Line 640: @@
 <syntaxhighlight lang="lua">feature create <feature> [char <room character>]</syntaxhighlight>
-This command will create a new map feature for use on rooms. You can
+This command will create a new map feature for use on rooms. You can also optionally add a character mark to the feature, which will be set
-also optionally add a character mark to the feature, which will be set
+when a map feature is added to a room. Note: Map feature names are not allowed to contain numbers.
-Example: <syntaxhighlight = "lua">feature create A Nexus Point char N</syntaxhighlight> - creates a new feature
+Example: <syntaxhighlight = "lua">feature create A Nexus Point char N</syntaxhighlight>
-'A Nexus Point' with an assigned room character 'N'
+: creates a new feature 'A Nexus Point' with an assigned room character 'N'
 === Room Create Feature ===

@@ Line 617: / Line 617: @@
 <syntaxhighlight lang="lua">room label [roomID] [fgColor] [bgColor] <message></syntaxhighlight>
-This command adds a label to the current or specified room.  Foreground
+This command adds a label to the current or specified room.  Foreground and background color are optional.
-Example: <syntaxhighlight = "lua">room label My Label</syntaxhighlight> - adds a 'My Label' label to the current room
+Example: <syntaxhighlight = "lua">room label My Label</syntaxhighlight>
-<syntaxhighlight = "lua">room label 342 My Label</syntaxhighlight> - adds a label to room #342
+: adds a 'My Label' label to the current room
-<syntaxhighlight = "lua">room label green My Label</syntaxhighlight> - adds a green label with a transparent
+<syntaxhighlight = "lua">room label 342 My Label</syntaxhighlight>
-background to the current room
+: adds a label to room #342
-<syntaxhighlight = "lua">room label green black My Label</syntaxhighlight> - adds a label with a green
+<syntaxhighlight = "lua">room label green My Label</syntaxhighlight>
-foreground and black background to the current room
+: adds a green label with a transparent background to the current room
-<syntaxhighlight = "lua">room label 34 green black My Label</syntaxhighlight> - adds a label with a green
+<syntaxhighlight = "lua">room label green black My Label</syntaxhighlight>
-foreground and black background to room #34
+: adds a label with a green foreground and black background to the current room
 === Area Labels ===