Updated config to reflect new scope for project.
This commit is contained in:
63
README.md
63
README.md
@@ -10,12 +10,15 @@
|
|||||||
StargateCommand is an addon for Stargate that allows users to interact with Stargate with commands.
|
StargateCommand is an addon for Stargate that allows users to interact with Stargate with commands.
|
||||||
|
|
||||||
#### Features:
|
#### Features:
|
||||||
##### Import
|
[Still being determined](https://github.com/stargate-rewritten/SG-Command/issues)
|
||||||
Places a specified `.gate` file in-game.
|
- sg dial
|
||||||
##### Export
|
- Specifies your destination for networked gates.
|
||||||
Saves your selection to file as a `.gate`
|
- sg visualiser
|
||||||
##### Dial
|
- Maps a network in a text-based tree format or possibly a gui
|
||||||
Specifies your destination for networked gates.
|
- sg config
|
||||||
|
- Modify various config values in-game
|
||||||
|
- sg api
|
||||||
|
- Perform a function from the stargate API in-game.
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
[The most recent version of Stargate](https://www.spigotmc.org/resources/stargate.87978/)
|
[The most recent version of Stargate](https://www.spigotmc.org/resources/stargate.87978/)
|
||||||
@@ -24,56 +27,16 @@ Specifies your destination for networked gates.
|
|||||||
|
|
||||||
### Nodes
|
### Nodes
|
||||||
```
|
```
|
||||||
stargate.command.import -- Allow the use of /sgc import
|
sg.command.node [NOT IMPLEMENTED
|
||||||
stargate.command.export -- Allow the use of /sgc export
|
sg.command.node.subnode
|
||||||
stargate.command.dial -- Allow the use of /dial
|
|
||||||
stargate.command.dial.interactive -- Allow use of /dial <dest>
|
|
||||||
stargate.command.dial.direct -- Allow use of /dial <src> <dest>
|
|
||||||
```
|
```
|
||||||
### Defaults
|
### Defaults
|
||||||
```
|
```
|
||||||
stargate.command.import -- Op
|
sg.command.node -- OP
|
||||||
stargate.command.export -- Op
|
|
||||||
stargate.command.dial -- True
|
|
||||||
stargate.command.dial.interactive -- True
|
|
||||||
stargate.command.dial.direct -- False
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Instructions
|
## Instructions
|
||||||
### Import
|
Not yet available.
|
||||||
|
|
||||||
The "/sgc import" command allows you to import a .gate file without having to manually build it. To import a gate you simply type:
|
|
||||||
`/sgc import <gatefile>`
|
|
||||||
Where <gatefile> is any .gate file without ".gate" at the end. You will then be asked to select two blocks next to each other by right clicking them, this specifies the gates bottom-left location, and orientation.
|
|
||||||
You can see an example of importing a gate in [this YouTube video](http://youtu.be/Y7KQ0wUUP8c).
|
|
||||||
|
|
||||||
### Export
|
|
||||||
The "/sgc export" command is slightly more complicated than importing, but will allow you to take a gate layout ingame, and export it to a .gate file without having to hand-edit the file.
|
|
||||||
The first step in building a gate for export is creating a frame out of bedrock material, everything inside of this frame will be treated as the gate, and any bedrock inside of this frame will be treated as the entrance/exit.
|
|
||||||
Once you have your bedrock frame created, make any shape with any blocks inside of the frame, here is an example export frame: Export Frame
|
|
||||||
Once you are happy with the gate, run the command:
|
|
||||||
/sgc export <gatefile>
|
|
||||||
You will then be asked to select a few blocks:
|
|
||||||
-------------------------------------------------------
|
|
||||||
The first block is where the sign will be drawn
|
|
||||||
The second block is where the button will be drawn
|
|
||||||
The third block is where the player will exit the gate
|
|
||||||
The last block is the top-left of the bedrock frame
|
|
||||||
Once you have selected these four blocks, if there were no errors, your gate will be saved to disk, and loaded into memory for instant use.
|
|
||||||
You can see an example of exporting a gate in [this YouTube video](http://youtu.be/-U6IVWt43qw).
|
|
||||||
|
|
||||||
### Dial
|
|
||||||
The "/dial" command allows players to select a destination for a Stargate without requiring them to scroll through a large list of destinations. There are two modes to the /dial command.
|
|
||||||
|
|
||||||
> Interactive
|
|
||||||
The interactive mode is invoked with the command:
|
|
||||||
`/dial <destination>`
|
|
||||||
This will make the next gate the player activates dial the given destination if available.
|
|
||||||
|
|
||||||
> Direct
|
|
||||||
Direct dialing is used to open a gate directly to another without requiring the player to interact with the gate, it is invoked as such:
|
|
||||||
`/dial <source> <destination> <network>`
|
|
||||||
If the network is not supplied, the default Stargate network will be used. If the source/destination exist on the same network, and the player has access to them, the gates will be opened with a connection to eachother.
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
Not yet available.
|
Not yet available.
|
||||||
|
|||||||
Reference in New Issue
Block a user