Latest revision as of 08:34, 1 April 2018

Submitting a Build Request

The purpose of this guide is to familiarize you, the player, with building information that you will need to set up a home or business on From the Ashes: Detroit by Night. Here are a few things you should put in your +request/build:

The name of your build.
How many rooms you will be needing. The number of rooms you can have is determined by your resource level.
What area on the +map you want to be linked. Take a look at the grid for ideas and to get a feel for the style of the district you wish to build your project in. Check residences for a list of possible apartments that might suit your needs and Resource level. Some of these are already furnished with descs that can be customized, while others will require you to build a room in its entirety.
- Please be advised that if your build does not suit the location or your Resources, you may be asked to modify your project.

Example:

+request/build Bazooka Lounge=I would like to make a two roomed club linked to #11.

There are some existing businesses available on the grid for PC ownership. If your concept fits one of these, do an 'ex' on the exit. If it's owned by "The D" that means it's open for new management and could be yours if you wanted it to be! Residences, shops, and other building ideas are welcome here and there are existing buildings where shops, cafes and other boutiques can be linked, such as the Guardian Building, and the Fisher Building. Check businesses for currently available enterprises.

Formatting

Because we like the grid to have a certain amount of uniformity, BuildStaff insists on the following:

Room desc format. Room descs must begin with %r[space(7)], have %r%r[space(7)] between paragraphs, and end with %r.
Exit descs. The above applies to Exits, too. Every exit needs to have an @desc, even if it's hidden or transparent.
@osuccs. All exits in a building project will require exit emits. This will be detailed later on.
@parent. Here at From the Ashes: Detroit by Night, we use only one parent for all rooms. @parent here=#6 This parent automatically formats the headers and footers for your room, as well as the exit format, which will automatically use the first letter of the first word as the Exit name, unless you specify otherwise (which you should). You do not need to add <> to anything.
Spellchecking can be overlooked. You don't need to be a perfect writer to play here, but we have provided a resource to use should you desire it. You can find lots of spell checkers online - for example, spellcheck.net.

STEP 1: Renaming your exit

Once your building request has been approved, you will be granted a starting room in the Building Nexus. The starting room is the very first room of your building project. Your Exit will be named something like: 'Will's Starterroom <WIL>'. The first thing you will need to do is consider what you are building. An Apartment? A House? A business? A business will need to be given the name of the business. An apartment, an apartment number. A house will require a house number and street name.

For a business:
- @name WIL = Bazooka Lounge;bl;bazooka
Or for an apartment:
- @name WIL = 104;104
Or for a house:
- @name WIL = 1313 Mocking Bird Lane;1313

STEP 2: Rename Your Room, @parent and Descing

You need to rename your starter room. Go inside the room.

@name here = The Bazooka Lounge - Vestibule

Rooms should begin with the name of the apartment, business or house name, then the name of the specific room. Foyer. Lounge. Living Room. And so on and so forth.

Next, you need to @parent your room as described in the Formatting section above. @parent here=#6

Now you are ready to begin descing your room and exits. Writing @descs is a creative process. It allows you to visually imagine a location, and fill in the details of the location with your words. @descs should be detailed and as descriptive as you like, though any exit that links to a street or outdoor location should receive a bit of extra attention. This exit tells people what the exterior facade of your store front or house looks like to anyone passing by and gives flavor to the location. All descs require a certain format be maintained as outlined above in the Formatting section.

@desc here=%r[space(7)]This is my desc. Isn't it nice?%r

Or to desc an exit:

@desc o=%r[space(7)]This is what the door looks like.%r

STEP 3: Exits

Now that you have @desc'd your room, your exits, what's next? Exit @succ's. These are the messages you receive when you move between exits. There are 5 of them that you need. They are:

@succ
@osucc
@odrop
@fail
@ofail

The specific information on each can be accessed by typing help @succ, replacing @succ with whichever you're curious about. Specifically, this is what each does.

@succ - Sets the message that is shown to someone who successfully passes through the exit.

@osucc - Sets the message that is shown to others whenever someone successfully passes through the exit (in the room where the exit is).

@odrop - Sets the message that will be shown to others on the OTHER side of the exit you pass through (in the room where the exit goes).

@fail - Sets the message that is shown to someone who fails to pass through the exit.

@ofail - Sets the message that is shown to others whenever someone fails to pass through the exit (in the room where the exit is).

These are the basic requirements of an exit. Examples are as follows:

@succ o=You walk out the door.
@osucc o=walks out the door.
@odrop o=walks out of Apartment 202.
@fail o=The door appears to be locked.
@ofail o=tries to walk out the door, but it appears to be locked.

STEP 4: The Next Room

Now that you have finished with your starter room, it is time to make the next one (if there is a next one).

Start in your existing room. There you will need to use the @dig command.

@dig Kitchen = Kitchen;k;kitchen,Out;o;out

This command creates the new room, an exit into that room, and an exit back out of that room to your starter room.

Make sure you follow all preceding steps on each new room. And that's it! You are done!

Before you resubmit your project for inspection and approval to be linked via +request/build, please make sure you have not overlooked anything. The following are often missed:

Ensure all descs start with %r[space(7)] and end with a %r
Ensure your exits have descs. Every exit needs an @desc
Don't forget to rename the exit INTO your starterroom. See Step 1 for how to do that.
Don't forget to @parent your room.
@odrop on every exit. It is often overlooked.
+inspect here can be used to view all the existing parts of a room in order to ensure they've all be set.

Places

Places code is immensely useful for large scenes. It provides a way to filter messages that helps you concentrate on just the people near your character while still being able to watch everyone else. Any public builds, ones where PCs are encouraged to loiter about and RP, are encouraged to have places code set up.

Places code is also useful when you have a large house, too. Instead of building a kitchen, a sitting room, and a dining room off your living room, why not make those areas places in the living room? Why shouldn't the people in the living room be able to see people going into and coming out of the kitchen or maybe overhear them if they're talking loudly enough? Why bother descing entire rooms that are rarely used? Put them into places.

For installation of places, please see the +help files on From the Ashes: Detroit by Night by typing +help places-config.

For additional configuration options, type +help places-options.

Miscellaneous Commands

Dark

Setting an exit DARK makes that exit invisible to the room. Anyone will be able to use the exit so long as they know what to type. Very useful for hidden doors to secret rooms. @set <exit>=dark

Unfindable

One room in your build may be set UNFINDABLE, if you have more than one. A safe room, for instance, or sanctum. Setting the room unfindable removes it from the +where list. @set <here>=undfindable.

Transparent

Setting an exit TRANSPARENT allows you to see the next room beyond the exit. Helpful if the door is made of glass, for instance, or is simply an open archway. @set <exit>=transparent

Abode

The ABODE flag lets people @link themselves to a room, which sets the room as their home. Use @set here=abode

Hotspots

Approved and linked to the grid?

Do you have a public building and want it to be shown on +hotspots? Send a +request/build and ask for it to be added.

Security

Have you considered security?

Difference between revisions of "Build Guide"

Latest revision as of 08:34, 1 April 2018

Contents

Submitting a Build Request

Formatting

STEP 1: Renaming your exit

STEP 2: Rename Your Room, @parent and Descing

STEP 3: Exits

STEP 4: The Next Room

Places

Miscellaneous Commands

Dark

Unfindable

Transparent

Abode

Hotspots

Security

Navigation menu

Personal tools

Namespaces

Variants

Views

More

Search

Navigation

Tools

@@ Line 19: / Line 19: @@
 * @osuccs. All exits in a building project will require exit emits. This will be detailed later on.
 * @parent. Here at From the Ashes: Detroit by Night, we use only one parent for all rooms. @parent here=#6 This parent automatically formats the headers and footers for your room, as well as the exit format, which will automatically use the first letter of the first word as the Exit name, unless you specify otherwise (which you should). You do not need to add <> to anything.
+* Spellchecking can be overlooked. You don't need to be a perfect writer to play here, but we have provided a resource to use should you desire it. You can find lots of spell checkers online - for example, [http://www.spellcheck.net/ spellcheck.net].
-== Spellchecking  ==
-* SPELLCHECK. Spellchecking can be overlooked. You don't need to be a perfect writer to play here, but we have provided a resource to use should you desire it. You can find lots of spell checkers online - for example, [http://www.spellcheck.net/ spellcheck.net].
 = STEP 1: Renaming your exit =
@@ Line 34: / Line 32: @@
 = STEP 2: Rename Your Room, @parent and Descing =
 You need to rename your starter room. Go inside the room.
 *@name here = The Bazooka Lounge - Vestibule
@@ Line 41: / Line 41: @@
 Next, you need to @parent your room as described in the Formatting section above. @parent here=#6
-Now you are ready to begin descing your room. Writing @descs is a creative process. It allows you to visually imagine a location, and fill in the details of the location with your words. @descs should be detailed and as descriptive as you like. All descs require a certain format be maintained as outlined above in the Formatting section.
+Now you are ready to begin descing your room and exits. Writing @descs is a creative process. It allows you to visually imagine a location, and fill in the details of the location with your words. @descs should be detailed and as descriptive as you like, though any exit that links to a street or outdoor location should receive a bit of extra attention. This exit tells people what the exterior facade of your store front or house looks like to anyone passing by and gives flavor to the location. All descs require a certain format be maintained as outlined above in the Formatting section.
-*@desc here=%r[space(7)]This is my desc. Isn't it nice?
+*@desc here=%r[space(7)]This is my desc. Isn't it nice?%r
 Or to desc an exit:
-*@desc o=%r[space(7)]This is what the door looks like.
+*@desc o=%r[space(7)]This is what the door looks like.%r
 = STEP 3: Exits =
@@ Line 76: / Line 76: @@
 *@ofail o=tries to walk out the door, but it appears to be locked.
-= Exits =
+= STEP 4: The Next Room =
-Your exit can be a tricky customer. It helps if you think of an exit on a game as one side of a door. They usually come in pairs. Every IN has an OUT, and while they're two different exits on the game, they're paired together as a single entity, be it a door or a hole in the wall or a thin curtain. Exits have a few options to set on them; the only one (other than the @desc) we make you set on The Reach is the '''@osucc''', and that's only on exactly two exits in your build, as covered earlier.
+Now that you have finished with your starter room, it is time to make the next one (if there is a next one).
-== @osuccs ==
-The osucc message is the message people in the same room as you see when you successfully go through an exit. They see it ''on'' your ''success'' - ''osucc''. We have you set this on the first entrance/exit on your build so people will know where you went when you, say, go into a house from the street. When you set an exit's osucc message, you're setting the message ''people in the same room as you'' who ''don't go through the exit'' see when you go through it. For example:
-:@osucc OH=goes into a moldy old house.
-Mary, Tim, and Greg are standing out on the street. Mary goes through the Old House <OH> exit. Tim and Greg see 'Mary goes into a moldy old house' because they're still out on the street.
-== @descs ==
-Fortunately, exits are easy to put descriptions on. Just @desc the exit name. For example:
-:@desc out=A wooden door leading to the shop's abattoir.
-:@desc bedroom=A curtain of purple beads separates the bedroom from the living room.
-:@desc qf=Quality Foods is an unassuming two-story brick building. The grocery store is open twenty-four hours a day and does brisk business.
-== @names ==
-Slightly more complicated than room @names or character @names, exit names also contain all the words you type that get you into a room. For example, the very common Out <O> @name is often:
-:@name out=Out;o;back;exit;leave
-We want to be able to let people wander around intuitively if possible, which is why there are so many words that mean 'go outside' on that out exit. The semi-colons are important in the exit @names. Here are some other examples of exit @names:
-:@name st=Study;st
-:@name st=Stairs;st;up;upstairs
-:@name st=Stairs;up;upstairs;stairs;study;st
-:@name ws=Workshop;ws;work;work shop;shop;down
-:@name wdw=Winding Driveway;wdw;winding;driveway;drive;winding drive
-The code will put the first set of characters after the semi-colon in brackets next to the exit name, so @name st=Study;st will get set as Study <ST>.
-= Where Is My Stuff? =
-We all lose track of things.
-== @search ==
-Sometimes you forget where you put things, like a closet or your horse ranch. That's okay, you can find things you own easily by typing ''@search''. That's it, ''@search''. That pulls up a whole list of things you own - rooms and exits, for example, and in the case of exits, how they relate to rooms. For example:
-:@search
-:ROOMS:
-:Apartment N202 - Aleswich Arms(#7326RA)
-:EXITS:
-:Apartment;202;apt 202;apartment 202(#7655E) [from Aleswich Arms - North Wing - Second Floor to Apartment N202 - Aleswich Arms(#7326RA)]
-:Out;o;back;exit;leave;hall;hallway;corridor;corr(#7809E) [from Apartment N202 - Aleswich Arms(#7326RA) to Aleswich Arms - North Wing - Second Floor]
-== #dbrefs ==
-What is an #dbref? It's short for 'database reference'. Everything, everything, everything on the game has a #dbref - the channels you talk on, the rooms you use. A #dbref number can stand in for an @name. While there are many apartments in the game, yours is the only apartment with the dbref #7326. If you're the person in the above example, anyway.
-Who cares? It's useful to know if, say, you misname an exit in a manner that makes it difficult to rename using words - like having two exits using 'BR' in the same room. Which can and does happen. You can sub in #dbrefs when necessary, like so:
+Start in your existing room. There you will need to use the @dig command.
-:@name #7984=Out;o;back;exit;leave
+* @dig Kitchen = Kitchen;k;kitchen,Out;o;out
+This command creates the new room, an exit into that room, and an exit back out of that room to your starter room.
-It comes in handy sometimes.
+Make sure you follow all preceding steps on each new room. And that's it! You are done!
+Before you resubmit your project for inspection and approval to be linked via '''+request/build''', please make sure you have not overlooked anything. The following are often missed:
+* Ensure all descs start with %r[space(7)] and end with a %r
+* Ensure your exits have descs. Every exit needs an @desc
+* Don't forget to rename the exit INTO your starterroom. See Step 1 for how to do that.
+* Don't forget to @parent your room.
+* @odrop on every exit. It is often overlooked.
+* +inspect here can be used to view all the existing parts of a room in order to ensure they've all be set.
 = Places =
-Place code is immensely useful for large scenes. It provides a way to filter messages that helps you concentrate on just the people near your character while still being able to watch everyone else. Any public builds, ones where PCs are encouraged to loiter about and RP, are ''strongly encouraged'' to have place code set up. (''Strongly encouraged'' in this case means ''please for the love of whatever entity or non-entity you find most dear, please, please put in place code, we are begging you''.)
+Places code is immensely useful for large scenes. It provides a way to filter messages that helps you concentrate on just the people near your character while still being able to watch everyone else. Any public builds, ones where PCs are encouraged to loiter about and RP, are encouraged to have places code set up.
-Place code is great when you have a great big house, too. Instead of building a kitchen, a sitting room, and a dining room off your living room, why not make those areas places in the living room? Why shouldn't the people in the living room be able to see people going into and coming out of the kitchen or maybe overhear them if they're talking loudly enough? Why bother descing entire rooms that are rarely used? Put in places. Please put in places.
-The best thing about places, though? You don't have to wait on build staff. And while we obviously are volunteers out trying to help everyone, sometimes it's a lot faster to set up some quick and dirty place code rather than wait for us to get our reading glasses on and oh let me open my spell check and you're missing a %r there, I'll get back to you after I link these five apartments.
-The +help files on the game and [[Mush_help:Places_2|on the wiki]] are useful, but we'll just walk through the basics here.
-== Configuring Places ==
-=== How many places do you want? ===
-Is it a business establishment like a bar or a cafe? You'll want various booths, tables, stools, or other seats. The more the merrier. You can make some of them small, with maybe three or four people, maximum, but the rest should be considerably bigger.
-Are you describing rooms on the main floor of a large house? Just as many as you think you'll use is good. You can have a kitchen, a parlour, and a dining room off your living room. You could have a few room places and a few regular seat places like couches.
-The maximum number of places you can have in any location is 10.
-Let's say I'm adding places to a cafe. I'd like to have a large counter for people to sit at, a couple of small, intimate places, some booths, and a big squishy couch. I'll configure 6 places.
-:places/configure <location>/<number of places>
-:places/configure here/6
-So, after typing places/configure here/6 and confirming that was in fact what we meant to do to, we now have places:
-:A table (#1) has 5 empty places.
-:A table (#2) has 5 empty places.
-:A table (#3) has 5 empty places.
-:A table (#4) has 5 empty places.
-:A table (#5) has 5 empty places.
-:A table (#6) has 5 empty places.
-Tables are automatic. Tables are the default. We can still have our counter, booths, and big squishy couch. We'll just have to set some of those attributes.
-=== How do you change a place's name or spaces? ===
-All the other attributes will be set using '''places/set <location> <num>/<item>=<value>'''. There are a number of things we can set, but the main ones we're gonna use are:
-:'''Name''': The name of the place, better if lower-case except for proper nouns. (Default: a table)
-:'''Spaces''': The number of spaces at a place. If set to '0', there is no limit. (Default: 4)
-:'''Description''': The description of the place. (Default: A table with a couple of chairs)
-:'''Say_Prefix''': What's added to the use of 'tt' or 'tto' at that place. A comma is automatically added. (Default: At your table)
-:places/set 1/name=Counter
-:places/set 2/name=Small Booth
-:places/set 3/name=Small Table
-:places/set 4/name=Booth
-:places/set 5/name=Booth
-:places/set 6/name=Big Squishy Couch
-And now when we type 'places', we get this list:
-:Counter (#1) has 5 empty places.
-:Small Booth (#2) has 5 empty places.
-:Small Table (#3) has 5 empty places.
-:Booth (#4) has 5 empty places.
-:Booth (#5) has 5 empty places.
-:Big Squishy Couch (#6) has 5 empty places.
-Let's work on the counter place, which is #1.
-:places/set 1/spaces=12
-:places/set 1/description=A long brick counter with a smooth concrete top.
-:places/set 1/say_prefix=At the counter
-Now when we type 'places', 'Counter' looks like this:
-:Counter (#1) has 12 empty places.
-And if we type 'plook 1' to look at place 1, we see:
-:A long brick counter with a smooth concrete top.
-:This place has 12 empty places out of 12.
-And if we sit at the counter and use the table talk command 'tt', everything we say will be prefixed by 'At the counter,' which is great.
-Once you have the basics down, you can configure places pretty fast. Like:
-:places/set 6/spaces=4
-:places/set 6/description=A big, squishy orange couch.
-:places/set 6/say_prefix=On the couch
-...gives us a place called 'Big, Squishy Couch' with four spots to sit where everything we say to our place with tt will be prefaced with 'On the couch,'. That's cool. Maybe I want more space on the couch. Maybe I want infinite space on the couch. Then I'd type:
-:places/set 6/spaces=0
-and have
-:Big Squishy Couch (#6) has no limit.
-...which is more useful for, say, outdoor golf ranges than couches.
-=== Adding another place ===
-Mistakes happen. Sometimes you realize after the fact that you want your cafe to have a secret petting zoo. You don't have to start over. You can sneak that petting zoo on in as your seventh space.
-:places/newplace <location>
-:places/newsplace here
-Boom, now there's another table in here. But it's so easy to make it a petting zoo. It's just so easy:
-:places/set 7/name=Secret Petting Zoo
-:places/set 7/spaces=0
-:places/set 7/description=A cleverly hidden petting zoo.
-:places/set 7/say_prefix=At the petting zoo
-And there you go. Type 'places' and now you have a secret petting zoo with no limit.
-WITH NO LIMIT.
-== Unconfiguring Places ==
-Yes, you can undo it.
+Places code is also useful when you have a large house, too. Instead of building a kitchen, a sitting room, and a dining room off your living room, why not make those areas places in the living room? Why shouldn't the people in the living room be able to see people going into and coming out of the kitchen or maybe overhear them if they're talking loudly enough? Why bother descing entire rooms that are rarely used? Put them into places.
-:places/breakdown <location>
+For installation of places, please see the +help files on From the Ashes: Detroit by Night by typing '''+help places-config'''.
-:places/breakdown here
+*  For additional configuration options, type '''+help places-options'''.
-...will wipe out all the places, while:
-:places/delplace <location>=<placenum>
-:places/delplace here=7
-...would just remove the seventh place, which in our example was the petting zoo. Health code violations, probably. If there is only one place set, you'll have to use the first command.
 = Miscellaneous Commands =
 == Dark ==
-You can set exits DARK, which means only you will be able to see the exit. Anyone will be able to use the exit so long as they know what to type. This is hella useful for hidden doors to secret rooms. @set <exit>=DARK will do it.
+Setting an exit DARK makes that exit invisible to the room. Anyone will be able to use the exit so long as they know what to type. Very useful for hidden doors to secret rooms. @set <exit>=dark
 == Unfindable ==
-Maybe you have a Brony room in your build and you want to keep it a secret. You probably don't want people looking at +where and seeing Brony Room - Expensive Mansion on the list. No worries, you can set it unfindable! This is good for things like secret sphere hangouts, hidden clubs, and other things not involving magical friendship. Please remember that as the room's owner, you will always, always see your room in your +where list, even if it's unfindable. The command is @set <here>=UNFINDABLE.
+One room in your build may be set UNFINDABLE, if you have more than one. A safe room, for instance, or sanctum. Setting the room unfindable removes it from the +where list. @set <here>=undfindable.
+== Transparent ==
+Setting an exit TRANSPARENT allows you to see the next room beyond the exit. Helpful if the door is made of glass, for instance, or is simply an open archway. @set <exit>=transparent
 == Abode ==
-Sometimes people crash at your place, or you want to give someone a temporary way to get to a room quickly, or whatever. The ABODE flag lets people @link themselves to a room, which sets the room as their home. Use @set here=ABODE.
+The ABODE flag lets people @link themselves to a room, which sets the room as their home. Use @set here=abode
-= Hangouts and the Directory =
+= Hotspots =
 Approved and linked to the grid?
-* Do you want your build to be a [[Mush_help:Hangouts|+hangout]]? Send a +req/build with ATTN Dresden in the title to be added.
+* Do you have a public building and want it to be shown on '''+hotspots'''? Send a +request/build and ask for it to be added.
-* Do you want your build added to the [[Mush help:Directory|+directory]]? Same! Send a +req/build with ATTN Dresden in the title to be added.
-= And Then... =
+= Security =
 Have you considered [[Equipment/Security_Systems|security]]?