Annikka/evennia
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixed a lingering bug with @set that made it not work when assigning normal strings without quotes. Changed so that proper Python constructs (lists, dicts etc) now requires you to entering proper Python syntax (since this is parsed).

Browse source
This commit is contained in:
Griatch 2012-04-15 23:09:56 +02:00
parent bcf214ee0d
commit 5a2228763f
3 changed files with 219 additions and 200 deletions
Download patch file Download diff file Expand all files Collapse all files

322
contrib/tutorial_world/build.ev
View file

@ -18,11 +18,11 @@
# #
# @batchprocess contrib.tutorial_world.build # @batchprocess contrib.tutorial_world.build
# #
# If you give the /interactive switch you can step through the # If you give the /interactive switch you can step through the
# build process command for command. # build process command for command.
# #
# The area we are building looks like this: # The area we are building looks like this:
# #
# ? 03,04 # ? 03,04
# | # |
# +---+----+ +-------------------+ +--------+ +--------+ # +---+----+ +-------------------+ +--------+ +--------+
@ -70,7 +70,7 @@
#------------------------------------------------------------ #------------------------------------------------------------
# #
# We start from limbo. Remember that every command in the batchfile # We start from limbo. Remember that every command in the batchfile
# -must- be separated by at least one comment-line. # -must- be separated by at least one comment-line.
@tel #2 @tel #2
# #
# Build the intro room (don't forget to also connect the outro room to this later) # Build the intro room (don't forget to also connect the outro room to this later)
@ -81,17 +81,17 @@
# in-game they will fill the lines to the width as defined by the # in-game they will fill the lines to the width as defined by the
# player's client. # player's client.
# #
@dig Intro;tut#01 @dig Intro;tut#01
: tutorial_world.rooms.IntroRoom : tutorial_world.rooms.IntroRoom
# #
# Open an exit to tutorial. We don't do this in the @dig # Open an exit to tutorial. We don't do this in the @dig
# command since we want to describe the exit. # command since we want to describe the exit.
# #
@open tutorial;tut;intro = tut#01 @open tutorial;tut;intro = tut#01
# #
# describe the tutorial exit # describe the tutorial exit
# #
@desc tutorial = @desc tutorial =
This starts the {gEvennia tutorial{n, using a small solo game to show off This starts the {gEvennia tutorial{n, using a small solo game to show off
some of the server's possibilities. some of the server's possibilities.
# #
@ -129,7 +129,7 @@ tutorial
# #
# Show that the tutorial command works ... # Show that the tutorial command works ...
# #
@set here/tutorial_info = @set here/tutorial_info =
This is the tutorial command. Use it in various rooms to see what's This is the tutorial command. Use it in various rooms to see what's
technically going on and what you could try in each room. The intro technically going on and what you could try in each room. The intro
room assigns some properties to your character, like a simple room assigns some properties to your character, like a simple
@ -139,7 +139,7 @@ tutorial
If you play this scenario as superuser, you will see a big red If you play this scenario as superuser, you will see a big red
warning. This warning is generated in the intro-rooms Typeclass. warning. This warning is generated in the intro-rooms Typeclass.
#------------------------------------------------------------ #------------------------------------------------------------
# #
# Outro room # Outro room
@ -150,7 +150,7 @@ tutorial
#------------------------------------------------------------ #------------------------------------------------------------
# #
@dig/teleport Leaving Tutorial @dig/teleport Leaving Tutorial
: tutorial_world.rooms.OutroRoom : tutorial_world.rooms.OutroRoom
= exit tutorial;exit;back, start again;start = exit tutorial;exit;back, start again;start
# #
@desc @desc
@ -158,8 +158,8 @@ tutorial
later. later.
# #
@open exit = #2 @open exit = #2
# This text is what the @tutorial command finds and displays. # This text is what the @tutorial command finds and displays.
@set here/tutorial_info = @set here/tutorial_info =
This outro room cleans up properties on the character that was set by This outro room cleans up properties on the character that was set by
the tutorial. the tutorial.
# #
@ -188,9 +188,9 @@ start
# #
# We define the tutorial message seen when the using the tutorial command # We define the tutorial message seen when the using the tutorial command
# #
@set here/tutorial_info = @set here/tutorial_info =
Weather room Weather room
This room inherits from a parent called WeatherRoom. It runs on a This room inherits from a parent called WeatherRoom. It runs on a
timer-Script that allows various weather-related messages to appear timer-Script that allows various weather-related messages to appear
at irregular intervals. at irregular intervals.
@ -200,7 +200,7 @@ start
below. Around you the ground is covered in low gray-green grass, below. Around you the ground is covered in low gray-green grass,
pushed flat by wind and rain. Inland, the vast dark moors begin, only pushed flat by wind and rain. Inland, the vast dark moors begin, only
here and there covered in patches of low trees and brushes. here and there covered in patches of low trees and brushes.
To the east, you glimpse the ragged outline of a castle ruin. It sits To the east, you glimpse the ragged outline of a castle ruin. It sits
perched on a sheer cliff out into the water, isolated from the perched on a sheer cliff out into the water, isolated from the
@ -230,7 +230,7 @@ start
you can ever budge this on your own (besides, what would you do with you can ever budge this on your own (besides, what would you do with
all those stones? Start your own quarry?). all those stones? Start your own quarry?).
# #
@set well/tutorial_info = @set well/tutorial_info =
This is a normal object, locked with get:false() so that Players This is a normal object, locked with get:false() so that Players
cannot pick it up. Since the get_err property is set, you get a cannot pick it up. Since the get_err property is set, you get a
customized error message when trying to pick it up. customized error message when trying to pick it up.
@ -245,9 +245,9 @@ start
# #
@lock sign = get:false() @lock sign = get:false()
# #
@set sign/get_err_msg = The sign is securely anchored to the ground. @set sign/get_err_msg = The sign is securely anchored to the ground.
# #
@set sign/readable_text = @set sign/readable_text =
WARNING - Bridge is not safe! WARNING - Bridge is not safe!
# #
@set sign/tutorial_info = @set sign/tutorial_info =
@ -270,11 +270,11 @@ start
# #
@lock ruin = get:false() @lock ruin = get:false()
# #
@set ruin/get_err_msg = @set ruin/get_err_msg =
Small as it may appear from a distance, you still cannot reach over and Small as it may appear from a distance, you still cannot reach over and
pick up the castle to put in your pocket. pick up the castle to put in your pocket.
# #
@set ruin/tutorial_info = @set ruin/tutorial_info =
This is just a normal object, dropped in the room and setting the This is just a normal object, dropped in the room and setting the
mood. This is an easy solution, but in a real game one would probably mood. This is an easy solution, but in a real game one would probably
want to modify the look command to be able to see various 'scenery'- want to modify the look command to be able to see various 'scenery'-
@ -288,7 +288,7 @@ start
below you its waves crash against the foot of the cliff. The vast below you its waves crash against the foot of the cliff. The vast
inland moor meets the ocean along a high and uninviting coastline of inland moor meets the ocean along a high and uninviting coastline of
ragged vertical stone. ragged vertical stone.
Once this part of the world might have been beautiful, but now the Once this part of the world might have been beautiful, but now the
eternal winds and storms have washed it all down into a gray and eternal winds and storms have washed it all down into a gray and
barren wasteland. barren wasteland.
@ -297,7 +297,7 @@ start
# #
@set sea/get_err_msg = No one gets the sea. The sea gets you. @set sea/get_err_msg = No one gets the sea. The sea gets you.
# #
@set sea/tutorial_info = @set sea/tutorial_info =
This is just a normal object, dropped in the room and setting the This is just a normal object, dropped in the room and setting the
mood. This is an easy solution, but in a real game one would probably mood. This is an easy solution, but in a real game one would probably
want to modify the look command to be able to see various 'scenery'- want to modify the look command to be able to see various 'scenery'-
@ -315,20 +315,20 @@ start
# #
@lock trees = get:false() @lock trees = get:false()
# #
@set trees/get_err_msg = @set trees/get_err_msg =
The group of old trees have withstood the eternal wind for hundreds The group of old trees have withstood the eternal wind for hundreds
of years. You will not uproot them any time soon. of years. You will not uproot them any time soon.
# #
@set trees/tutorial_info = @set trees/tutorial_info =
These are climbable objects; they make for a small puzzle for These are climbable objects; they make for a small puzzle for
accessing a hidden exit. Climbing the trees allows the accessing a hidden exit. Climbing the trees allows the
Climbable typeclass to assign a attribute on the character Climbable typeclass to assign a attribute on the character
that an exit is then looking for. that an exit is then looking for.
# #
# The text to echo to player if trying 'climb tree' # The text to echo to player if trying 'climb tree'
# #
@set tree/climb_text = @set tree/climb_text =
With some effort you climb one of the old trees. With some effort you climb one of the old trees.
The branches are wet and slippery but can easily carry your The branches are wet and slippery but can easily carry your
@ -338,10 +338,10 @@ start
beyond the trees. It looks like some sort of building. From this beyond the trees. It looks like some sort of building. From this
angle you can make out a {wfaint footpath{n leading in that angle you can make out a {wfaint footpath{n leading in that
direction, all but impossible to make out from ground level. direction, all but impossible to make out from ground level.
You climb down again.
You climb down again.
#------------------------------------------------------------ #------------------------------------------------------------
# #
# Outside Evennia Inn (hidden path) # Outside Evennia Inn (hidden path)
@ -349,10 +349,10 @@ start
#------------------------------------------------------------ #------------------------------------------------------------
# #
# We dig the room without moving to it. # We dig the room without moving to it.
# #
@dig Outside Evennia Inn;outside inn;tut#03 @dig Outside Evennia Inn;outside inn;tut#03
: tutorial_world.rooms.WeatherRoom : tutorial_world.rooms.WeatherRoom
= northern path;north;n;path,back to cliff;back;cliff;south;s = northern path;north;n;path,back to cliff;back;cliff;south;s
# #
# Lock exit from view/traverse until we climbed that tree (which is # Lock exit from view/traverse until we climbed that tree (which is
@ -360,13 +360,13 @@ start
# #
@lock north = view:attr(last_climbed) ; traverse:attr(last_climbed) @lock north = view:attr(last_climbed) ; traverse:attr(last_climbed)
# #
@desc north = @desc north =
This is a hardly visible footpath leading off through the rain-beaten This is a hardly visible footpath leading off through the rain-beaten
grass. It seems to circle the trees northward. You would never had grass. It seems to circle the trees northward. You would never had
noticed it had you not seen it from above. noticed it had you not seen it from above.
# #
@set north/tutorial_info = @set north/tutorial_info =
This exit is locked with a lock string that looks like this: This exit is locked with a lock string that looks like this:
view:attr(last_climbed); traverse:attr(last_climbed) view:attr(last_climbed); traverse:attr(last_climbed)
@ -378,7 +378,7 @@ start
# #
north north
# #
@desc @desc
You stand outside a one-story sturdy wooden building. Light flickers You stand outside a one-story sturdy wooden building. Light flickers
behind closed storm shutters. Over the door a sign creaks in the wind behind closed storm shutters. Over the door a sign creaks in the wind
- the writing says {cEvennia Inn{n and is surrounded by a painted - the writing says {cEvennia Inn{n and is surrounded by a painted
@ -392,7 +392,7 @@ north
#------------------------------------------------------------ #------------------------------------------------------------
# #
@dig/teleport The Evennia Inn;evennia inn;inn;tut#04 @dig/teleport The Evennia Inn;evennia inn;inn;tut#04
: tutorial_world.rooms.TutorialRoom : tutorial_world.rooms.TutorialRoom
= enter;in,leave;out = enter;in,leave;out
# #
@desc The Evennia Inn consists of one large room filled with @desc The Evennia Inn consists of one large room filled with
@ -409,7 +409,7 @@ north
tells you cheerfully that it's the leftovers from those foolish tells you cheerfully that it's the leftovers from those foolish
adventurers that challenged the old ruin before you ... adventurers that challenged the old ruin before you ...
# #
@set here/tutorial_info = @set here/tutorial_info =
Nothing special about this room, only a bonus place to potentially go Nothing special about this room, only a bonus place to potentially go
for chatting with other online players. Oh, and don't forget to grab for chatting with other online players. Oh, and don't forget to grab
a blade if you don't already have one. The weapons are locked so that a blade if you don't already have one. The weapons are locked so that
@ -419,12 +419,12 @@ north
weapons in there won't help much against what is waiting in the ruin weapons in there won't help much against what is waiting in the ruin
anyway ...) anyway ...)
# #
# Create the weapons to be held by the barrel. # Create the weapons to be held by the barrel.
# #
@create/drop rusty old sword;rusty;sword;weapon : tutorial_world.objects.Weapon @create/drop rusty old sword;rusty;sword;weapon : tutorial_world.objects.Weapon
# #
@desc rusty = @desc rusty =
This is a rusty old broadsword. It has seen better days but the hilt is in good shape. This is a rusty old broadsword. It has seen better days but the hilt is in good shape.
# #
# Only allow to pick up if we don't already has something called weapon # Only allow to pick up if we don't already has something called weapon
@lock rusty = get:not holds(weapon) @lock rusty = get:not holds(weapon)
@ -433,8 +433,8 @@ north
# #
@create/drop blunt axe;blunt;axe;weapon : tutorial_world.objects.Weapon @create/drop blunt axe;blunt;axe;weapon : tutorial_world.objects.Weapon
# #
@desc axe = @desc axe =
A heavy weapon, but the edge is dull and covered in rust and nicks. A heavy weapon, but the edge is dull and covered in rust and nicks.
# #
@lock blunt = get:not holds(weapon) @lock blunt = get:not holds(weapon)
# #
@ -442,8 +442,8 @@ north
# #
@create/drop patched spear;patched;spear;weapon : tutorial_world.objects.Weapon @create/drop patched spear;patched;spear;weapon : tutorial_world.objects.Weapon
# #
@desc patched = @desc patched =
The spear tip looks to be in decent condition, but the shaft was broken and is rather poorly mended. The spear tip looks to be in decent condition, but the shaft was broken and is rather poorly mended.
# #
@lock patched = get:not holds(weapon) @lock patched = get:not holds(weapon)
# #
@ -456,7 +456,7 @@ north
#------------------------------------------------------------ #------------------------------------------------------------
# #
# Back to cliff # Back to cliff
@teleport tut#02 @teleport tut#02
# #
# The bridge uses parent rooms.BridgeRoom, which causes the player to # The bridge uses parent rooms.BridgeRoom, which causes the player to
# take a longer time than expected to cross as they are pummeled by # take a longer time than expected to cross as they are pummeled by
@ -465,12 +465,12 @@ north
# itself. # itself.
# #
@dig The old bridge;bridge;tut#05 @dig The old bridge;bridge;tut#05
: tutorial_world.rooms.BridgeRoom : tutorial_world.rooms.BridgeRoom
= old bridge;east;e;bridge;hangbridge = old bridge;east;e;bridge;hangbridge
# #
# put some descriptions on the exit to the bridge # put some descriptions on the exit to the bridge
# #
@desc bridge = @desc bridge =
The hang-bridge's foundation sits at the edge of the cliff to the The hang-bridge's foundation sits at the edge of the cliff to the
east - two heavy stone pillars anchor the bridge on this side. east - two heavy stone pillars anchor the bridge on this side.
# #
@ -497,23 +497,23 @@ bridge
movement commands. This makes it take a few steps to cross it despite movement commands. This makes it take a few steps to cross it despite
it being only one room. it being only one room.
The bridge has no normal exits, instead it has a counter that tracks The bridge has no normal exits, instead it has a counter that tracks
how far out on the bridge the Character is. For the bridge to work it how far out on the bridge the Character is. For the bridge to work it
needs the names of links to the adjoining rooms, and when the counter needs the names of links to the adjoining rooms, and when the counter
indicates the Character is leaving the bridge, they are teleported indicates the Character is leaving the bridge, they are teleported
there. there.
The room also inherits from the weather room to cause the bridge to The room also inherits from the weather room to cause the bridge to
sway at regular intervals. It also implements an timer and a random sway at regular intervals. It also implements an timer and a random
occurrence at every step across the bridge. It might be worth trying occurrence at every step across the bridge. It might be worth trying
this passage a few times to see what may happen. Hint: you can fall this passage a few times to see what may happen. Hint: you can fall
off! off!
#------------------------------------------------------------ #------------------------------------------------------------
# #
# Ledge under the bridge # Ledge under the bridge
# #
#------------------------------------------------------------ #------------------------------------------------------------
# #
@ -522,7 +522,7 @@ bridge
# #
@dig/teleport Protruding ledge;cliffledge;ledge;tut#06 @dig/teleport Protruding ledge;cliffledge;ledge;tut#06
# #
@set here/tutorial_info = @set here/tutorial_info =
This room is stored as an attribute on the 'Bridge' room and used a This room is stored as an attribute on the 'Bridge' room and used a
destination should the player fall off the bridge. In our example the destination should the player fall off the bridge. In our example the
bridge is relatively simple and always drops us to the same ledge; a bridge is relatively simple and always drops us to the same ledge; a
@ -533,7 +533,7 @@ bridge
You are on a narrow ledge protruding from the side of the cliff, You are on a narrow ledge protruding from the side of the cliff,
about halfway down. The air if saturated with salty sea water, about halfway down. The air if saturated with salty sea water,
sprays hitting your face from the crashing waves below. sprays hitting your face from the crashing waves below.
The ledge is covered with a few black-grey brushes. Not far from you The ledge is covered with a few black-grey brushes. Not far from you
the cliff-face is broken down to reveal a narrow natural opening into the cliff-face is broken down to reveal a narrow natural opening into
the cliff. the cliff.
@ -548,7 +548,7 @@ bridge
# #
@create/drop The sea (far below you);sea;ocean @create/drop The sea (far below you);sea;ocean
# #
@set sea/get_err_msg: @set sea/get_err_msg:
Try as you might, the Sea will always get you long before you can Try as you might, the Sea will always get you long before you can
ever get it. ever get it.
# #
@ -562,13 +562,13 @@ bridge
# #
@lock bridge = get:false() @lock bridge = get:false()
# #
@desc bridge = @desc bridge =
You can see the shape of the hang bridge a fair bit above you, partly You can see the shape of the hang bridge a fair bit above you, partly
obscured by the rain. There is no way to get back up there from this obscured by the rain. There is no way to get back up there from this
ledge. ledge.
# #
@set bridge/get_err_msg = You can't reach it, it's too far away. @set bridge/get_err_msg = You can't reach it, it's too far away.
#------------------------------------------------------------ #------------------------------------------------------------
# #
@ -580,8 +580,8 @@ bridge
# cliff again. If you look at the map, the 'dark cell' also connects # cliff again. If you look at the map, the 'dark cell' also connects
# to here. We'll get to that later. # to here. We'll get to that later.
# #
@dig Underground passages;passages;underground;tut#07 @dig Underground passages;passages;underground;tut#07
: tutorial_world.rooms.TutorialRoom : tutorial_world.rooms.TutorialRoom
= hole into cliff;hole;passage;cliff = hole into cliff;hole;passage;cliff
# #
# Describe the exit # Describe the exit
@ -597,17 +597,17 @@ hole
This room acts a hub for getting the player back to the This room acts a hub for getting the player back to the
start again, regardless of how you got here. start again, regardless of how you got here.
# #
@desc @desc
The underground cavern system you have entered seems to stretch on The underground cavern system you have entered seems to stretch on
forever, with criss-crossing paths and natural caverns probably forever, with criss-crossing paths and natural caverns probably
carved by water. It is not completely dark, here and there faint carved by water. It is not completely dark, here and there faint
daylight sifts down from above - the cliff is porous leaving channels daylight sifts down from above - the cliff is porous leaving channels
of air and light up to the surface. of air and light up to the surface.
(some time later) (some time later)
You eventually come upon a cavern with a black pool of stale You eventually come upon a cavern with a black pool of stale
water. In it sits a murky bucket, the first remnant of any sort of water. In it sits a murky bucket, the first remnant of any sort of
intelligent life down here. The bucket has disconnected from a chain intelligent life down here. The bucket has disconnected from a chain
@ -619,7 +619,7 @@ hole
# #
@lock pool = get:false() @lock pool = get:false()
# #
@set pool/get_err_msg = @set pool/get_err_msg =
You sift your hands through the black water without feeling any You sift your hands through the black water without feeling any
immediate bottom. It's chilling cold and so dark you don't feel like immediate bottom. It's chilling cold and so dark you don't feel like
taking a sip. taking a sip.
@ -632,7 +632,7 @@ hole
# #
@lock hole = get:false() @lock hole = get:false()
# #
@set hole/get_err_msg = You cannot reach it from here. You need to climb the chain. @set hole/get_err_msg = You cannot reach it from here. You need to climb the chain.
# #
@desc hole = @desc hole =
Whereas the lower edges of the hole seem jagged and natural you can Whereas the lower edges of the hole seem jagged and natural you can
@ -656,16 +656,16 @@ hole
# #
#------------------------------------------------------------ #------------------------------------------------------------
# #
@dig/teleport Dark cell;dark;cell;tut#08 @dig/teleport Dark cell;dark;cell;tut#08
: tutorial_world.rooms.DarkRoom : tutorial_world.rooms.DarkRoom
# #
@set here/tutorial_info = @set here/tutorial_info =
Dark room Dark room
The dark room implements a custom "dark" state. This is a very The dark room implements a custom "dark" state. This is a very
restricted state that completely redefines the look command and only restricted state that completely redefines the look command and only
allows limited interactions. allows limited interactions.
Looking around repeatedly will eventually produce hints as to how to Looking around repeatedly will eventually produce hints as to how to
get out of the dark room. get out of the dark room.
# #
@ -676,7 +676,7 @@ hole
{YThe {yflickering light{Y of the torch reveals a small square {YThe {yflickering light{Y of the torch reveals a small square
cell. It does not seem like you are still in the castle, for the cell. It does not seem like you are still in the castle, for the
stone of the walls are chiseled crudely and drip with water and mold. stone of the walls are chiseled crudely and drip with water and mold.
One wall holds a solid iron-cast door. While rusted and covered with One wall holds a solid iron-cast door. While rusted and covered with
lichen it seems very sturdy. In a corner lies what might have once lichen it seems very sturdy. In a corner lies what might have once
been a bed or a bench but is now nothing more than a pile or rotting been a bed or a bench but is now nothing more than a pile or rotting
@ -702,10 +702,10 @@ hole
slightly aside. You feel a faint draft from that direction. slightly aside. You feel a faint draft from that direction.
# #
# The crumbling wall is in fact an advanced type of Exit, all we need to do is # The crumbling wall is in fact an advanced type of Exit, all we need to do is
# to supply it with a destination. # to supply it with a destination.
# #
# Puzzle wall is an exit without a given destination at start # Puzzle wall is an exit without a given destination at start
@create/drop root-covered wall;wall;roots;wines;root : tutorial_world.objects.CrumblingWall @create/drop root-covered wall;wall;roots;wines;root : tutorial_world.objects.CrumblingWall
# #
# This destination is auto-assigned to the exit when its puzzle is solved # This destination is auto-assigned to the exit when its puzzle is solved
# connect to the Underground passages # connect to the Underground passages
@ -714,22 +714,22 @@ hole
@lock roots = get:false() @lock roots = get:false()
# #
# (the crumbling wall describes itself, so we don't do it here) # (the crumbling wall describes itself, so we don't do it here)
@set here/tutorial_info = @set here/tutorial_info =
This room presents a puzzle that has to be solved in order to get out This room presents a puzzle that has to be solved in order to get out
of the room. The root-covered wall is in fact an advanced Exit-type of the room. The root-covered wall is in fact an advanced Exit-type
object that is locked until the puzzle is solved. object that is locked until the puzzle is solved.
#------------------------------------------------------------ #------------------------------------------------------------
# #
# Castle Gate # Castle Gate
# We are done with the underground, describe castle. # We are done with the underground, describe castle.
#------------------------------------------------------------ #------------------------------------------------------------
# #
# We are done building the underground passages, let's # We are done building the underground passages, let's
# head back up to ground level. We teleport to the bridge # head back up to ground level. We teleport to the bridge
# and continue from there. # and continue from there.
# #
# Back to the bridge # Back to the bridge
@teleport tut#05 @teleport tut#05
# #
# The bridge room should not have any normal exits from it, that is # The bridge room should not have any normal exits from it, that is
@ -743,11 +743,11 @@ hole
This is part of a four-room area patrolled by a mob: the guardian of This is part of a four-room area patrolled by a mob: the guardian of
the castle. The mob initiates combat if the player stays in the same the castle. The mob initiates combat if the player stays in the same
room for long enough. room for long enough.
Combat itself is a very simple affair which takes advantage of the Combat itself is a very simple affair which takes advantage of the
strength of the weapon you use, but dictates a fix skill for you and strength of the weapon you use, but dictates a fix skill for you and
your enemy. The enemy is quite powerful, so don't stick around too your enemy. The enemy is quite powerful, so don't stick around too
long ... long ...
# #
@desc @desc
The old gatehouse is near collapse. Part of its northern wall has The old gatehouse is near collapse. Part of its northern wall has
@ -779,8 +779,8 @@ hole
# #
#------------------------------------------------------------ #------------------------------------------------------------
@dig Along inner wall;inner wall;along;tut#10 @dig Along inner wall;inner wall;along;tut#10
: tutorial_world.rooms.WeatherRoom : tutorial_world.rooms.WeatherRoom
= Standing archway;archway;south;s,ruined gatehouse;gatehouse;north;n = Standing archway;archway;south;s,ruined gatehouse;gatehouse;north;n
# #
@desc standing archway = @desc standing archway =
@ -792,7 +792,7 @@ archway
This is part of a four-room area patrolled by a mob; the guardian of This is part of a four-room area patrolled by a mob; the guardian of
the castle. The mob initiates combat if the player stays in the same the castle. The mob initiates combat if the player stays in the same
room for long enough. room for long enough.
Combat itself is a very simple affair which takes advantage of the Combat itself is a very simple affair which takes advantage of the
strength of the weapon you use, but dictates a fix skill for you and strength of the weapon you use, but dictates a fix skill for you and
your enemy. your enemy.
@ -802,29 +802,29 @@ archway
actually turns out to be collapsed buildings so mashed together by actually turns out to be collapsed buildings so mashed together by
the ravishes of time that they all seem to lean on each other and the ravishes of time that they all seem to lean on each other and
against the outer wall. The whole scene is directly open to the sky. against the outer wall. The whole scene is directly open to the sky.
The buildings make a half-circle along the main wall, here and there The buildings make a half-circle along the main wall, here and there
broken by falling stone and rubble. At one end (the {wnorth{nern) of broken by falling stone and rubble. At one end (the {wnorth{nern) of
this half-circle is the entrance to the castle, the ruined this half-circle is the entrance to the castle, the ruined
gatehoue. {wEast{nwards from here is some sort of open courtyard. gatehoue. {wEast{nwards from here is some sort of open courtyard.
#------------------------------------------------------------ #------------------------------------------------------------
# #
# Corner of castle (east from gatehouse) # Corner of castle (east from gatehouse)
# #
#------------------------------------------------------------ #------------------------------------------------------------
# back to castle gate # back to castle gate
@teleport tut#09 @teleport tut#09
# #
@dig/teleport Corner of castle ruins;corner;tut#11 @dig/teleport Corner of castle ruins;corner;tut#11
: tutorial_world.rooms.TutorialRoom : tutorial_world.rooms.TutorialRoom
= castle corner;corner;east;e,gatehouse;west;w = castle corner;corner;east;e,gatehouse;west;w
# #
@desc @desc
The ruins opens up to the sky in a small open area, lined by The ruins opens up to the sky in a small open area, lined by
columns. The open area is dominated by a huge stone obelisk in its columns. The open area is dominated by a huge stone obelisk in its
center, an ancient ornament miraculously still standing. center, an ancient ornament miraculously still standing.
Previously one could probably continue past the obelisk and eastward Previously one could probably continue past the obelisk and eastward
into the castle keep itself, but that way is now completely blocked into the castle keep itself, but that way is now completely blocked
by fallen rubble. To the {wwest{n is the gatehouse and entrance to by fallen rubble. To the {wwest{n is the gatehouse and entrance to
@ -835,7 +835,7 @@ archway
This is part of a four-room area patrolled by a mob; the guardian of This is part of a four-room area patrolled by a mob; the guardian of
the castle. The mob initiates combat if the player stays in the same the castle. The mob initiates combat if the player stays in the same
room for long enough. room for long enough.
Combat itself is a very simple affair which takes advantage of the Combat itself is a very simple affair which takes advantage of the
strength of the weapon you use, but dictates a fix skill for you and strength of the weapon you use, but dictates a fix skill for you and
your enemy. your enemy.
@ -844,7 +844,7 @@ archway
# #
@lock obelisk = get:false() @lock obelisk = get:false()
# #
@set obelisk/get_err_msg = It's way too heavy for anyone to move. @set obelisk/get_err_msg = It's way too heavy for anyone to move.
# #
# (the obelisk describes itself, so we need no do it here) # (the obelisk describes itself, so we need no do it here)
# #
@ -859,7 +859,7 @@ archway
# #
@set ghost/get_err_msg = Your fingers just pass straight through it! @set ghost/get_err_msg = Your fingers just pass straight through it!
# #
@desc ghost = @desc ghost =
This ghostly shape could momentarily be mistaken for a thick fog had This ghostly shape could momentarily be mistaken for a thick fog had
it not moved with such determination and giving echoing hollow it not moved with such determination and giving echoing hollow
screams as it did. The shape is hard to determine, now and then it screams as it did. The shape is hard to determine, now and then it
@ -868,42 +868,42 @@ archway
presence. This must be the ruin's eternal guardian. presence. This must be the ruin's eternal guardian.
# #
# Give the enemy some random echoes (echoed at irregular intervals) # Give the enemy some random echoes (echoed at irregular intervals)
# This 'list structure' [ ... ] is parsed by the batch reader and # This 'list structure' [ ... ] is parsed by the batch reader and
# split by commas (so each entry cannot contain commas). # split by commas (so each entry cannot contain commas).
# #
@set ghost/irregular_echoes = @set ghost/irregular_echoes =
[The foggy thing gives off a high-pitched shriek., For a moment the ["The foggy thing gives off a high-pitched shriek.","For a moment the
fog wraps around a nearby pillar., The fog drifts lower to the ground fog wraps around a nearby pillar.", "The fog drifts lower to the ground
as if looking for something., The fog momentarily takes on a reddish as if looking for something.", "The fog momentarily takes on a reddish
hue.,The fog temporarily fills most of the area as it changes hue.", "The fog temporarily fills most of the area as it changes
shape.,You accidentally breathes in some of the fog - you start shape.", "You accidentally breathes in some of the fog - you start
coughing from the cold moisture.] coughing from the cold moisture."]
# #
# give the enemy a tentacle weapon # give the enemy a tentacle weapon
# #
@create foggy tentacles;tentacles:tutorial_world.objects.Weapon @create foggy tentacles;tentacles:tutorial_world.objects.Weapon
# #
# Make the enemy's weapon good - hits at 70% of attacks # Make the enemy's weapon good - hits at 70% of attacks
# #
@set foggy tentacles/hit = 0.7 @set foggy tentacles/hit = 0.7
# #
# Actually give the enemy its weapon # Actually give the enemy its weapon
# #
@teleport/quiet tentacles = ghost @teleport/quiet tentacles = ghost
# #
# Clear inactive mode and start the mob # Clear inactive mode and start the mob
# #
@set ghost/inactive = @set ghost/inactive =
#------------------------------------------------------------ #------------------------------------------------------------
# #
# The courtyard # The courtyard
# #
#------------------------------------------------------------ #------------------------------------------------------------
# #
@dig/teleport Overgrown courtyard;courtyard;tut#12 @dig/teleport Overgrown courtyard;courtyard;tut#12
: tutorial_world.rooms.WeatherRoom : tutorial_world.rooms.WeatherRoom
= courtyard;south;s,castle corner;north;n = courtyard;south;s,castle corner;north;n
# #
# Connect west exit to the inner wall # Connect west exit to the inner wall
@open along inner wall;wall;along;west;w, overgrown courtyard;courtyard;east;e = tut#10 @open along inner wall;wall;along;west;w, overgrown courtyard;courtyard;east;e = tut#10
@ -917,11 +917,11 @@ archway
strength of the weapon you use, but dictates a fix skill for you and strength of the weapon you use, but dictates a fix skill for you and
your enemy. your enemy.
# #
@desc @desc
The inner courtyard of the old castle is littered with debris and The inner courtyard of the old castle is littered with debris and
overgrown with low grass and patches of thorny wines. There is a overgrown with low grass and patches of thorny wines. There is a
collapsed structure close to the gatehouse that looks like a stable. collapsed structure close to the gatehouse that looks like a stable.
{wNorth{nwards is a smaller area cornered in the debris, adorned with {wNorth{nwards is a smaller area cornered in the debris, adorned with
a large obelisk-like thing. To the {wwest{n the castle walls loom a large obelisk-like thing. To the {wwest{n the castle walls loom
over a mess of collapsed buildings. On the opposite, {weast{nern side over a mess of collapsed buildings. On the opposite, {weast{nern side
@ -933,9 +933,9 @@ archway
# #
@lock stable = get:false() @lock stable = get:false()
# #
@desc stable = @desc stable =
The building is empty, if it was indeed once a stable it was abandoned long ago. The building is empty, if it was indeed once a stable it was abandoned long ago.
#------------------------------------------------------------ #------------------------------------------------------------
# #
# The temple # The temple
@ -943,23 +943,23 @@ archway
#------------------------------------------------------------ #------------------------------------------------------------
# #
@dig/teleport The ruined temple;temple;in;tut#13 @dig/teleport The ruined temple;temple;in;tut#13
: tutorial_world.rooms.TutorialRoom : tutorial_world.rooms.TutorialRoom
= ruined temple;temple;east;e, overgrown courtyard;courtyard;outside;out;west;w = ruined temple;temple;east;e, overgrown courtyard;courtyard;outside;out;west;w
# #
@desc @desc
This building seems to have survived the ravages of time better than This building seems to have survived the ravages of time better than
most of the others. Its arched roof and wide spaces suggests that most of the others. Its arched roof and wide spaces suggests that
this is a temple or church of some kind. this is a temple or church of some kind.
The wide hall of the temple stretches before you. At the far edge is The wide hall of the temple stretches before you. At the far edge is
a stone altar with no clear markings. Despite its relatively good a stone altar with no clear markings. Despite its relatively good
condition, the temple is empty of all furniture or valuables, like it condition, the temple is empty of all furniture or valuables, like it
was looted or its treasures moved ages ago. was looted or its treasures moved ages ago.
Stairs lead down to the temple's dungeon on either side of the Stairs lead down to the temple's dungeon on either side of the
altar. A gaping door opening shows the a wide courtyard to the west. altar. A gaping door opening shows the a wide courtyard to the west.
#------------------------------------------------------------ #------------------------------------------------------------
# #
# Antechamber - below the temple # Antechamber - below the temple
@ -970,21 +970,21 @@ archway
: tutorial_world.rooms.TutorialRoom : tutorial_world.rooms.TutorialRoom
= stairs down;stairs;down;d, up the stairs to ruined temple;stairs;temple;up;u = stairs down;stairs;down;d, up the stairs to ruined temple;stairs;temple;up;u
# #
@desc stairs down = @desc stairs down =
The stairs are worn by the age-old passage of feet. The stairs are worn by the age-old passage of feet.
# #
# Lock the antechamber so the ghost cannot get in there. # Lock the antechamber so the ghost cannot get in there.
@lock stairs down = traverse:not attr(is_mob) @lock stairs down = traverse:not attr(is_mob)
# #
# Go down # Go down
# #
stairs down stairs down
# #
@desc @desc
This chamber lies almost directly under the main altar of the This chamber lies almost directly under the main altar of the
temple. The passage of aeons is felt here and you also sense you are temple. The passage of aeons is felt here and you also sense you are
close to great power. close to great power.
The sides of the chamber are lined with stone archways, these are The sides of the chamber are lined with stone archways, these are
entrances to the {wtombs{n of what must have been influential entrances to the {wtombs{n of what must have been influential
families or individual heroes of the realm. Each is adorned by a families or individual heroes of the realm. Each is adorned by a
@ -995,7 +995,7 @@ stairs down
This is the second part of a puzzle involving the Obelisk in the This is the second part of a puzzle involving the Obelisk in the
castle's north-east corner. The correct exit to use will vary castle's north-east corner. The correct exit to use will vary
depending on which scene was shown on the Obelisk surface. depending on which scene was shown on the Obelisk surface.
Each tomb is a teleporter room and is keyed to a number corresponding Each tomb is a teleporter room and is keyed to a number corresponding
to the scene last shown on the obelisk (now stored on player). If the to the scene last shown on the obelisk (now stored on player). If the
number doesn't match, the tomb is a trap that teleports to a second number doesn't match, the tomb is a trap that teleports to a second
@ -1010,26 +1010,26 @@ stairs down
= Tomb with stone bird;bird;blue;stone = Tomb with stone bird;bird;blue;stone
# #
@dig Tomb of woman on horse @dig Tomb of woman on horse
: tutorial_world.rooms.TeleportRoom : tutorial_world.rooms.TeleportRoom
= Tomb with statue of riding woman;horse;riding; = Tomb with statue of riding woman;horse;riding;
# #
@dig Tomb of the crowned queen @dig Tomb of the crowned queen
: tutorial_world.rooms.TeleportRoom : tutorial_world.rooms.TeleportRoom
= Tomb with statue of a crowned queen;crown;queen = Tomb with statue of a crowned queen;crown;queen
# #
@dig Tomb of the shield @dig Tomb of the shield
: tutorial_world.rooms.TeleportRoom : tutorial_world.rooms.TeleportRoom
= Tomb with shield of arms;shield = Tomb with shield of arms;shield
# #
@dig Tomb of the hero @dig Tomb of the hero
: tutorial_world.rooms.TeleportRoom : tutorial_world.rooms.TeleportRoom
= Tomb depicting a heroine fighting a monster;knight;hero;monster;beast = Tomb depicting a heroine fighting a monster;knight;hero;monster;beast
# #
# The puzzle_values are set on Character by looking at the Obelisk in # The puzzle_values are set on Character by looking at the Obelisk in
# the Castle Corner room. If the scenes show doesn't match, the # the Castle Corner room. If the scenes show doesn't match, the
# failure/success_teleport_to attributes will be used to teleport away # failure/success_teleport_to attributes will be used to teleport away
# the Character. Since the scene shown by the Obelisk is random, this # the Character. Since the scene shown by the Obelisk is random, this
# means the right tomb need not be the same. # means the right tomb need not be the same.
# #
@tel Blue bird tomb @tel Blue bird tomb
# #
@ -1073,7 +1073,7 @@ stairs down
#------------------------------------------------------------ #------------------------------------------------------------
# #
# Falling room # Falling room
# #
# This is a transition between the trap and the cell room. Character # This is a transition between the trap and the cell room. Character
# is teleported here if they picked the wrong tomb. # is teleported here if they picked the wrong tomb.
@ -1087,21 +1087,21 @@ stairs down
The tomb is dark. You fumble your way through it. You think you can The tomb is dark. You fumble your way through it. You think you can
make out a coffin in front of you in the gloom. make out a coffin in front of you in the gloom.
{rSuddenly you hear a distinct 'click' and the ground abruptly {rSuddenly you hear a distinct 'click' and the ground abruptly
disappears under your feet! You fall ... things go dark. {n disappears under your feet! You fall ... things go dark. {n
... ...
... You come to your senses. You lie down. On stone floor. You ... You come to your senses. You lie down. On stone floor. You
shakily come to your feet. Somehow you suspect that you are not under shakily come to your feet. Somehow you suspect that you are not under
the tomb anymore, like you were magically snatched away. the tomb anymore, like you were magically snatched away.
The air is damp. Where are you? The air is damp. Where are you?
# #
@set here/success_teleport_to = dark cell @set here/success_teleport_to = dark cell
# #
@set here/failure_teleport_to = dark cell @set here/failure_teleport_to = dark cell
# #
@ -1112,19 +1112,19 @@ stairs down
# #
# The ancient tomb # The ancient tomb
# #
# This is the real tomb, the goal of the adventure. # This is the real tomb, the goal of the adventure.
# #
#------------------------------------------------------------ #------------------------------------------------------------
# Create the real tomb # Create the real tomb
# #
@dig/teleport Ancient tomb;tut#16 @dig/teleport Ancient tomb;tut#16
: tutorial_world.rooms.TutorialRoom : tutorial_world.rooms.TutorialRoom
= ,back to antechamber;antechamber;back = ,back to antechamber;antechamber;back
# #
@desc @desc
The tomb is dark. You fumble your way through it. You think you can The tomb is dark. You fumble your way through it. You think you can
make out a coffin in front of you in the gloom. make out a coffin in front of you in the gloom.
The coffin comes into view. On and around it are chiseled scenes of a The coffin comes into view. On and around it are chiseled scenes of a
stern woman in armor. They depict great heroic deeds. This is clearly stern woman in armor. They depict great heroic deeds. This is clearly
the tomb of some sort of ancient heroine - it must be the goal you the tomb of some sort of ancient heroine - it must be the goal you
@ -1134,18 +1134,18 @@ stairs down
Congratulations, you have reached the end of this little tutorial Congratulations, you have reached the end of this little tutorial
scenario. Just grab the mythical weapon (get weapon) and the exit scenario. Just grab the mythical weapon (get weapon) and the exit
will open. will open.
You can end the quest here or go back through the tutorial rooms to You can end the quest here or go back through the tutorial rooms to
explore further. You will find this weapon works better against the explore further. You will find this weapon works better against the
castle's guardian than any of the others you have found ... castle's guardian than any of the others you have found ...
# #
# The exact nature of the weapon is randomized. The get_text attribute # The exact nature of the weapon is randomized. The get_text attribute
# on the sarcophagus holds a %s replacement that is filled by the typeclass # on the sarcophagus holds a %s replacement that is filled by the typeclass
# with the name of the weapon when you get the weapon. # with the name of the weapon when you get the weapon.
# #
@create/drop Stone sarcophagus;sarcophagus;stone : tutorial_world.objects.WeaponRack @create/drop Stone sarcophagus;sarcophagus;stone : tutorial_world.objects.WeaponRack
# #
@desc stone = @desc stone =
The lid of the coffin is adorned with a stone statue in full size. The weapon held by The lid of the coffin is adorned with a stone statue in full size. The weapon held by
the stone hands looks very realistic ... the stone hands looks very realistic ...
# #
@ -1157,33 +1157,33 @@ stairs down
# #
@set sarcophagus/magic = True @set sarcophagus/magic = True
# #
@set sarcophagus/get_text = @set sarcophagus/get_text =
The hands of the statue close on what seems to be a real weapon The hands of the statue close on what seems to be a real weapon
rather than one in stone. This must be the hero's legendary weapon! rather than one in stone. This must be the hero's legendary weapon!
The prize you have been looking for! The prize you have been looking for!
With trembling hands you release the weapon from the stone and hold With trembling hands you release the weapon from the stone and hold
{c%s{n in your hands! {c%s{n in your hands!
{gThis concludes the Evennia tutorial. From here you can either {gThis concludes the Evennia tutorial. From here you can either
continue to explore the castle (hint: this weapon works better continue to explore the castle (hint: this weapon works better
against the castle guardian than any you might have found earlier) or against the castle guardian than any you might have found earlier) or
you can choose to exit.{n you can choose to exit.{n
#------------------------------------------------------------ #------------------------------------------------------------
# #
# Outro - end of the tutorial # Outro - end of the tutorial
# #
# This cleans all temporary attributes set on the Character # This cleans all temporary attributes set on the Character
# by the tutorial, removes weapons and items etc. # by the tutorial, removes weapons and items etc.
# #
#------------------------------------------------------------ #------------------------------------------------------------
# #
@dig End of tutorial;end;tut#17 @dig End of tutorial;end;tut#17
: tutorial_world.rooms.OutroRoom : tutorial_world.rooms.OutroRoom
= Exit tutorial;exit;end = Exit tutorial;exit;end
# #
# All weapons from the rack gets an automatic alias the same as the # All weapons from the rack gets an automatic alias the same as the
@ -1199,14 +1199,14 @@ stairs down
@desc @desc
{gThanks for trying out this little Evennia tutorial! {gThanks for trying out this little Evennia tutorial!
The game play given here is of course just scraping the surface of The game play given here is of course just scraping the surface of
what can be done with Evennia. The tutorial focuses more on showing what can be done with Evennia. The tutorial focuses more on showing
various techniques than to supply any sort of novel storytelling or various techniques than to supply any sort of novel storytelling or
gaming challenge. The full README and source code for the tutorial gaming challenge. The full README and source code for the tutorial
world can be found under {wcontrib/tutorial_world{g. world can be found under {wcontrib/tutorial_world{g.
If you went through the tutorial quest once, it can be interesting to If you went through the tutorial quest once, it can be interesting to
do it again to explore the various possibilities and rooms you might do it again to explore the various possibilities and rooms you might
not have come across yet, maybe with the source/build code to one not have come across yet, maybe with the source/build code to one
@ -1222,4 +1222,4 @@ stairs down
# #
@open exit back to Limbo;limbo;exit;back = #2 @open exit back to Limbo;limbo;exit;back = #2
# #
@tel 2 @tel 2

45
src/commands/default/building.py
View file

@ -1153,10 +1153,19 @@ class CmdSetAttribute(ObjManipCommand):
Sets attributes on objects. The second form clears Sets attributes on objects. The second form clears
a previously set attribute while the last form a previously set attribute while the last form
inspects the current value of the attribute inspects the current value of the attribute
(if any). You can also set lists [...] and dicts {...} (if any).
on attributes with @set (but not nested combinations). Also
note that such lists/dicts will always hold strings (never numbers). The most common data to save with this command are strings and
Use @py if you need to set arbitrary lists and dicts. numbers. You can however also set Python primities such as lists,
dictionaries and tuples on objects (this might be important for
the functionality of certain custom objects). This is indicated
by you starting your value with one of {c'{n, {c"{n, {c({n, {c[{n or {c{ {n.
Note that you should leave a space after starting a dictionary ('{ ')
so as to not confuse the dictionary start with a colour code.
Remember that if you use Python primitives like this, you must
write proper Python syntax too - notably you must include quotes
around your strings or you will get an error.
""" """
key = "@set" key = "@set"
@ -1201,14 +1210,17 @@ class CmdSetAttribute(ObjManipCommand):
for pair in obj[1:-1].split(',') if ":" in pair]) for pair in obj[1:-1].split(',') if ":" in pair])
# if nothing matches, return as-is # if nothing matches, return as-is
return obj return obj
if strobj.strip() and strobj.strip()[0] in ("'", '"', "(", "{ ", "["):
# this is a structure starting with a proper python structure,
# so treat it as such.
try:
# under python 2.6, literal_eval can do this for us.
from ast import literal_eval
return literal_eval(strobj)
except ImportError:
# fall back to old recursive solution (don't support nested lists/dicts)
return rec_convert(strobj.strip())
try:
# under python 2.6, literal_eval can do this for us.
from ast import literal_eval
return literal_eval(strobj)
except ImportError:
# fall back to old recursive solution (don't support nested lists/dicts)
return rec_convert(strobj.strip())
def func(self): def func(self):
"Implement the set attribute - a limited form of @py." "Implement the set attribute - a limited form of @py."
@ -1253,8 +1265,15 @@ class CmdSetAttribute(ObjManipCommand):
else: else:
# setting attribute(s). Make sure to convert to real Python type before saving. # setting attribute(s). Make sure to convert to real Python type before saving.
for attr in attrs: for attr in attrs:
obj.set_attribute(attr, self.convert_from_string(value)) try:
string += "\nCreated attribute %s/%s = %s" % (obj.name, attr, value) obj.set_attribute(attr, self.convert_from_string(value))
string += "\nCreated attribute %s/%s = %s" % (obj.name, attr, value)
except SyntaxError:
# this means literal_eval tried to parse a faulty string
string = "{RPython syntax error in your value. By assigning a value starting with"
string += "\none of {r'{R, {r\"{R, {r[{R, {r({R or {r{{R we assume you are entering a proper Python"
string += "\nprimitive such as a list or a dictionary. You must then also use correct"
string += "\nPython syntax. Remember especially to put quotes around all strings.{n"
# send feedback # send feedback
caller.msg(string.strip('\n')) caller.msg(string.strip('\n'))

52
src/utils/ansi.py
View file

@ -2,26 +2,26 @@
ANSI - Gives colour to text. ANSI - Gives colour to text.
Use the codes defined in ANSIPARSER in your text Use the codes defined in ANSIPARSER in your text
to apply colour to text according to the ANSI standard. to apply colour to text according to the ANSI standard.
Examples: Examples:
This is %crRed text%cn and this is normal again. This is %crRed text%cn and this is normal again.
This is {rRed text{n and this is normal again. This is {rRed text{n and this is normal again.
Mostly you should not need to call parse_ansi() explicitly; Mostly you should not need to call parse_ansi() explicitly;
it is run by Evennia just before returning data to/from the it is run by Evennia just before returning data to/from the
user. user.
""" """
import re import re
from src.utils import utils from src.utils import utils
# ANSI definitions # ANSI definitions
ANSI_BEEP = "\07" ANSI_BEEP = "\07"
ANSI_ESCAPE = "\033" ANSI_ESCAPE = "\033"
ANSI_NORMAL = "\033[0m" ANSI_NORMAL = "\033[0m"
ANSI_UNDERLINE = "\033[4m" ANSI_UNDERLINE = "\033[4m"
ANSI_HILITE = "\033[1m" ANSI_HILITE = "\033[1m"
ANSI_BLINK = "\033[5m" ANSI_BLINK = "\033[5m"
@ -30,7 +30,7 @@ ANSI_INV_HILITE = "\033[1;7m"
ANSI_INV_BLINK = "\033[7;5m" ANSI_INV_BLINK = "\033[7;5m"
ANSI_BLINK_HILITE = "\033[1;5m" ANSI_BLINK_HILITE = "\033[1;5m"
ANSI_INV_BLINK_HILITE = "\033[1;5;7m" ANSI_INV_BLINK_HILITE = "\033[1;5;7m"
# Foreground colors # Foreground colors
ANSI_BLACK = "\033[30m" ANSI_BLACK = "\033[30m"
ANSI_RED = "\033[31m" ANSI_RED = "\033[31m"
@ -40,7 +40,7 @@ ANSI_BLUE = "\033[34m"
ANSI_MAGENTA = "\033[35m" ANSI_MAGENTA = "\033[35m"
ANSI_CYAN = "\033[36m" ANSI_CYAN = "\033[36m"
ANSI_WHITE = "\033[37m" ANSI_WHITE = "\033[37m"
# Background colors # Background colors
ANSI_BACK_BLACK = "\033[40m" ANSI_BACK_BLACK = "\033[40m"
ANSI_BACK_RED = "\033[41m" ANSI_BACK_RED = "\033[41m"
@ -50,7 +50,7 @@ ANSI_BACK_BLUE = "\033[44m"
ANSI_BACK_MAGENTA = "\033[45m" ANSI_BACK_MAGENTA = "\033[45m"
ANSI_BACK_CYAN = "\033[46m" ANSI_BACK_CYAN = "\033[46m"
ANSI_BACK_WHITE = "\033[47m" ANSI_BACK_WHITE = "\033[47m"
# Formatting Characters # Formatting Characters
ANSI_RETURN = "\r\n" ANSI_RETURN = "\r\n"
ANSI_TAB = "\t" ANSI_TAB = "\t"
@ -58,7 +58,7 @@ ANSI_SPACE = " "
class ANSIParser(object): class ANSIParser(object):
""" """
A class that parses ansi markup A class that parses ansi markup
to ANSI command sequences to ANSI command sequences
""" """
@ -110,14 +110,14 @@ class ANSIParser(object):
(r'{M', normal + ANSI_MAGENTA), (r'{M', normal + ANSI_MAGENTA),
(r'{c', hilite + ANSI_CYAN), (r'{c', hilite + ANSI_CYAN),
(r'{C', normal + ANSI_CYAN), (r'{C', normal + ANSI_CYAN),
(r'{w', hilite + ANSI_WHITE), # pure white (r'{w', hilite + ANSI_WHITE), # pure white
(r'{W', normal + ANSI_WHITE), #light grey (r'{W', normal + ANSI_WHITE), #light grey
(r'{x', hilite + ANSI_BLACK), #dark grey (r'{x', hilite + ANSI_BLACK), #dark grey
(r'{X', normal + ANSI_BLACK), #pure black (r'{X', normal + ANSI_BLACK), #pure black
(r'{n', normal) #reset (r'{n', normal) #reset
] ]
# xterm256 {123, %c134, # xterm256 {123, %c134,
self.xterm256_map = [ self.xterm256_map = [
(r'%c([1-5]{3})', self.parse_rgb), # %c123 - foreground colour (r'%c([1-5]{3})', self.parse_rgb), # %c123 - foreground colour
@ -125,10 +125,10 @@ class ANSIParser(object):
(r'{([1-5]{3})', self.parse_rgb), # {123 - foreground colour (r'{([1-5]{3})', self.parse_rgb), # {123 - foreground colour
(r'{(b[1-5]{3})', self.parse_rgb) # {b123 - background colour (r'{(b[1-5]{3})', self.parse_rgb) # {b123 - background colour
] ]
# obs - order matters here, we want to do the xterms first since # obs - order matters here, we want to do the xterms first since
# they collide with some of the other mappings otherwise. # they collide with some of the other mappings otherwise.
self.ansi_map = self.xterm256_map + self.mux_ansi_map + self.ext_ansi_map self.ansi_map = self.xterm256_map + self.mux_ansi_map + self.ext_ansi_map
# prepare regex matching # prepare regex matching
self.ansi_sub = [(re.compile(sub[0], re.DOTALL), sub[1]) self.ansi_sub = [(re.compile(sub[0], re.DOTALL), sub[1])
@ -140,10 +140,10 @@ class ANSIParser(object):
def parse_rgb(self, rgbmatch): def parse_rgb(self, rgbmatch):
""" """
This is a replacer method called by re.sub with the matched This is a replacer method called by re.sub with the matched
tag. It must return the correct ansi sequence. tag. It must return the correct ansi sequence.
It checks self.do_xterm256 to determine if conversion It checks self.do_xterm256 to determine if conversion
to standard ansi should be done or not. to standard ansi should be done or not.
""" """
if not rgbmatch: if not rgbmatch:
return "" return ""
@ -154,8 +154,8 @@ class ANSIParser(object):
red, green, blue = int(rgbtag[1]), int(rgbtag[2]), int(rgbtag[3]) red, green, blue = int(rgbtag[1]), int(rgbtag[2]), int(rgbtag[3])
else: else:
red, green, blue = int(rgbtag[0]), int(rgbtag[1]), int(rgbtag[2]) red, green, blue = int(rgbtag[0]), int(rgbtag[1]), int(rgbtag[2])
if self.do_xterm256: if self.do_xterm256:
colval = 16 + (red * 36) + (green * 6) + blue colval = 16 + (red * 36) + (green * 6) + blue
return "\033[%s8;5;%s%s%sm" % (3 + int(background), colval/100, (colval%100)/10, colval%10) return "\033[%s8;5;%s%s%sm" % (3 + int(background), colval/100, (colval%100)/10, colval%10)
else: else:
@ -163,7 +163,7 @@ class ANSIParser(object):
if red == green and red == blue and red < 2: if red == green and red == blue and red < 2:
if background: return ANSI_BACK_BLACK if background: return ANSI_BACK_BLACK
elif red >= 1: return ANSI_HILITE + ANSI_BLACK elif red >= 1: return ANSI_HILITE + ANSI_BLACK
else: return ANSO_NORMAL + ANSI_BLACK else: return ANSI_NORMAL + ANSI_BLACK
elif red == green and red == blue: elif red == green and red == blue:
if background: return ANSI_BACK_WHITE if background: return ANSI_BACK_WHITE
elif red >= 4: return ANSI_HILITE + ANSI_WHITE elif red >= 4: return ANSI_HILITE + ANSI_WHITE
@ -196,7 +196,7 @@ class ANSIParser(object):
def parse_ansi(self, string, strip_ansi=False, xterm256=False): def parse_ansi(self, string, strip_ansi=False, xterm256=False):
""" """
Parses a string, subbing color codes according to Parses a string, subbing color codes according to
the stored mapping. the stored mapping.
strip_ansi flag instead removes all ansi markup. strip_ansi flag instead removes all ansi markup.
@ -206,16 +206,16 @@ class ANSIParser(object):
string = utils.to_str(string) string = utils.to_str(string)
self.do_xterm256 = xterm256 self.do_xterm256 = xterm256
# handle all subs # handle all subs
for sub in self.ansi_sub: for sub in self.ansi_sub:
# go through all available mappings and translate them # go through all available mappings and translate them
string = sub[0].sub(sub[1], string) string = sub[0].sub(sub[1], string)
if strip_ansi: if strip_ansi:
# remove all ANSI escape codes # remove all ANSI escape codes
string = self.ansi_regex.sub("", string) string = self.ansi_regex.sub("", string)
return string return string
ANSI_PARSER = ANSIParser() ANSI_PARSER = ANSIParser()
# #