Skip to content
Dinnerbone edited this page Dec 7, 2010 · 11 revisions

Designing your own gates

Each type of Stargate can be altered through the corresponding .gate file located in your /stargates/ directory. From here you can add new gate types, edit existing designs or delete ones you no longer use.

Example format

The following example will let you use a normal Nether Portal as a Stargate. It is the default design and is created automatically when you install Stargate for the first time.

cost-type=None
cost-to-use=None
cost-to-create=None
cost-to-activate=None
cost-destination=None
X=49
-=49

 XX 
X..X
-..-
X..X
 XX 

Making your own

Each .gate is split into two sections, separated by a single blank line.

Properties section

At the very top of the file is the Properties section. In here you can set various configuration options for Stargate, and define a "key" for the Design section.

Configuration

You may set various configuration options specific to this type of gate here. Each uses the format key=value.

portal-open

The block ID to place in the entrance when the portal is open. The default value is 90 (a portal).

portal-closed

The block ID to place in the entrance when the portal is closed. The default value is 0 (nothing, air).

cost-type

The type of cost charged to people for this gate. Allowed values are iconomy (To use iconomy coins), blocks to use items from the users inventory, or none. The default value is none.

cost-to-activate

The cost to active (turn on) this gate. If cost-type is iconomy, this is the amount of coins to deduct. If cost-type is blocks, this is the amount and types of blocks to deduct, in the following format:

# This charges 3 stone blocks (id 1) OR 6 cobblestone blocks (id 4)
# OR 1 log (according to items.txt) OR 4 redstone (according to items.txt)
cost-to-activate=3x1, 6x4, log, 4xredstone

Default value is 0.

cost-to-use

The cost to use (walk through) this gate. Accepts the same parameters as cost-to-activate. Default value is 0.

cost-to-create

The cost to create this gate. Accepts the same parameters as cost-to-activate. Default value is 0.

cost-destination

Allows you to send all the money (Items unsupported) obtained by using this gate to a specific person, useful for cities with mayors and the like. The following format is used:

# Sends the money to the owner (the person who created) of the gate
cost-destination=owner
# Sends the money to a player called Dinnerbone
cost-destination=player Dinnerbone

Default value is none.

groups-can-activate (NYI)

Allows you to set which groups can activate (turn on) a gate. List of group names separated by a comma, or all or none. Default is all.

groups-can-use (NYI)

Allows you to set which groups can use (go through) a gate. List of group names separated by a comma, or all or none. Default is all.

groups-can-create (NYI)

Allows you to set which groups can create a gate. List of group names separated by a comma, or all or none. Default is all.

groups-can-destroy (NYI)

Allows you to set which groups can destroy a gate. List of group names separated by a comma, or all or none. Default is admins.

can-be-fixed (NYI)

Allows you to set whether or not this gate can be a fixed gate (single destination only). Acceptable values are yes, no, or only (for "can only be fixed"). Default is yes.

Design key

You may set any single character to be used as a reference to a specific block, by using the following format:

# symbol = id
X=1

In the example X=1, any use of the symbol X in the design pattern will be known as the block ID 1 ('Stone').

Design section

In the bottom section you may design how a Stargate can be constructed. You may use any character from the design key, including 3 extra special characters:

- is a Control spot. You must have two of these, no more, no less. This must also be defined to a block type in your key - it's where you'll put your sign.

. is an entrance. This shouldn't be used in the key. It's where you walk into a gate, or come out of it.

(a whitespace) is a wildchar. It means it doesn't matter what block is there.