mcblocky 0.1.0.pre.alpha.pre.7 → 0.1.0.pre.alpha.pre.8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWE1ZWFiMzY3MDg5Yzk4YWE2YTRjYTgwYjViYWE4MTAwM2Y5YjUzNQ==
+    ZjhiZTU3YzYzM2JkMDViNTQzMDY3OGI4YzY1NzVhODI1NmIzNDFhZA==
   data.tar.gz: !binary |-
-    ZjVjMWY0MjIzNDNiMTMxMTM4ZTk1NzA4YWJkNmNmN2Q4MDI3YTc1OQ==
+    OGZjNjQxMjdhOGU5OTU0MTM4NTEzMzI1YTAyZmM5YWZlOTk1OTAxMg==
 SHA512:
   metadata.gz: !binary |-
-    OTljNzRmNjY3NzUzOGI5NWY0ZjM0ZmFhNDNhYzVlNjJmYTc3NWMzZTc4ODkx
-    MjA5NjUwYzIyMWEzMmQ1NjA5MzA2MmZhMDQ2OTY5YWE5ODE5YTU0YWJmNzYy
-    YTZiNTg4YzMyY2E4Y2UxMTU2ZWI2ZWRiNzFkYTAyOWI1ZDEyOTY=
+    MzM1OGZiM2FjZjQxNGJiN2YzNjAwMGE0NTI5YTE3YTA3YzMwODU4NTg5NGY4
+    YzdjYWE4MWY1YWRjMTMxMDBjMmI1NTM0ZjhiOTllMjIzMTI0M2YzOTM1N2M1
+    MzUyOGE1ODJjMTFmNDZmZTkyNjcyOGQyNjdjNWQxNzk3MGYzM2M=
   data.tar.gz: !binary |-
-    ZjNkMTM0MmI3ZGUzOTViYzg1YWY4ZDhlNTY5ODlhZjVhZDE2MDM2MDIyOWVh
-    ZTY3MmVlYmNkZGZkNzRmMjlhNDliMDVjNDdkNThkNWQ3NjMxYzEwNjcyZDA2
-    ZmQ2Y2JiZTZkZjIxYjE4MWM4YWJiM2IwNDIxZjllN2RkZTQ5YTE=
+    MDFlZmUwOTBmMmZlNGYzYzM5ODA0NTNmMWFkOGMyOWU4YjczNDJmNWQ1Mzkw
+    NmFlZjI1ZGU4N2RlY2RhOTM4MDVlYmJkYjZjMDc0Yzg3ZDM5OWIxOTZiMTY4
+    OWEzOTQ5MDk3MzAzM2UyNGI3NzMzMGFmMDZiNTAwZGRjYjlmMjQ=

data/.gitignore

@@ -3,7 +3,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/README.md

@@ -3,7 +3,7 @@
 McBlocky is a Ruby DSL for creating Minecraft command block contraptions and
 maps.
 
-[![Build Status](https://travis-ci.org/DeltaWhy/mcblocky.svg?branch=master)](https://travis-ci.org/DeltaWhy/mcblocky)
+[![Build Status](https://travis-ci.org/DeltaWhy/mcblocky.svg?branch=master)](https://travis-ci.org/DeltaWhy/mcblocky)[![Gem Version](https://badge.fury.io/rb/mcblocky.svg)](https://badge.fury.io/rb/mcblocky)
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 

data/doc/Helpers.md

@@ -0,0 +1,15 @@
+# Helpers
+You can define helpers for frequently used commands to make them easier to run. Helpers are triggered by sending `!name` in the chat, and are executed in the server console.
+
+Currently the DSL commands are not available inside a helper block -- instead use `server.command` to send the command as a string, or `server.say` to send a console message.
+
+A helper block receives two arguments: the first is an array of words that were given after the helper name, the second is the username of the player who triggered the helper.
+
+## Examples
+```ruby
+helper 'blue' do |args, user|
+  # filter out any color codes from the username
+  user = user.gsub(/[^A-Za-z0-9_]./, '')
+  server.command "scoreboard teams join Blue #{user}"
+end
+```

data/doc/Introduction.md

@@ -1,4 +1,3 @@
-
 # McBlocky
 McBlocky is a Ruby DSL for creating Minecraft command block contraptions and maps. It allows you to write Ruby code that gets translated into commands and command blocks in the Minecraft world. Because it does everything by executing commands in the server console, you can see the results of your changes in-game almost immediately after you hit 'Save' in your editor -- no need to restart the server to run MCEdit.
 
@@ -137,7 +136,7 @@ end
 ```
 
 ## Next steps
-Check out the [examples folder](../examples) for some longer examples. Then try making one of your own! Also have a look at the rest of the [documentation](../doc) *(coming soon)*.
+Check out the [examples folder](../examples) for some longer examples. Then try making one of your own! Also have a look at the rest of the [documentation](../doc).
 
 Please report bugs and feature requests on the [issue tracker](https://github.com/DeltaWhy/mcblocky/issues). I will also accept pull requests for the code, documentation, and examples.
 

data/doc/Selectors.md

@@ -0,0 +1,19 @@
+# Selectors
+Many Minecraft commands accept an entity selector -- something like `@e[type=ArmorStand,x=1,y=2,z=3,r=1]`. McBlocky also understands selectors, which look slightly different in Ruby:
+```ruby
+@e[type: 'ArmorStand', x: 1, y: 2, z: 3, r: 1]
+```
+
+You can also save a partial selector to a variable and add more arguments to it later:
+```ruby
+foo = @a[x: 1, y: 2, z: 3, r: 1]
+foo[team: 'Red'] # "@a[x=1,y=2,z=3,r=1,team=Red]"
+foo[team: 'Blue'] # "@a[x=1,y=2,z=3,r=1,team=Blue]"
+foo # "@a[x=1,y=2,z=3,r=1]"
+```
+
+As a shorthand, you can pass a `Location` object instead of the x, y, and z arguments.
+```ruby
+l = Location.new(1, 2, 3)
+@a[loc: l] # "@a[x=1,y=2,z=3]"
+```

data/doc/Syntax.md

@@ -0,0 +1,194 @@
+# Syntax
+McBlocky syntax is, first and foremost, Ruby syntax. If you're not familiar with Ruby you should check out [Ruby in Twenty Minutes](https://www.ruby-lang.org/en/documentation/quickstart/) first, as it's a bit different from most other programming languages.
+
+To do anything useful with McBlocky you'll need to call its functions. Several top-level functions are available, most of which take a Ruby block. More commands are available inside these blocks depending on what the function is.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+
+- [Top level functions](#top-level-functions)
+  - [require and require_relative](#require-and-require_relative)
+  - [helper](#helper)
+  - [initial](#initial)
+  - [cleanup](#cleanup)
+  - [after](#after)
+  - [setblock](#setblock)
+  - [fill](#fill)
+  - [at](#at)
+  - [repeat](#repeat)
+  - [chest](#chest)
+  - [trapped_chest](#trapped_chest)
+  - [dispenser](#dispenser)
+  - [dropper](#dropper)
+  - [furnace](#furnace)
+- [Command context](#command-context)
+  - [execute](#execute)
+  - [detect](#detect)
+  - [gamerule](#gamerule)
+  - [scoreboard](#scoreboard)
+- [Container context](#container-context)
+  - [item](#item)
+  - [item_in_slot](#item_in_slot)
+- [NBT and JSON](#nbt-and-json)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Top level functions
+### require and require_relative
+These are actually Ruby functions, but it's worth mentioning that they work in McBlocky. `require` given a relative path will evaluate it relative to the root of your project (the location of your `config.yml`). `require_relative` evaluates relative to the *current file*.
+
+### helper
+```ruby
+helper name do |args, user|
+  # helper context
+end
+```
+See [Helpers.md].
+
+### initial
+```ruby
+initial do
+  # command context
+end
+```
+Commands to be executed before setting any blocks.
+
+### cleanup
+```ruby
+cleanup do
+  # command context
+end
+```
+Commands to be executed before reloading the file.
+
+### after
+```ruby
+after do
+  # command context
+end
+```
+Commands to be executed after setting all blocks.
+
+### setblock
+```ruby
+setblock x, y, z, kind, data, replacemode, nbt
+# does not take a block
+```
+Set a specific block in the world. The top level `setblock` is smart when reloading, so you should use it instead of `setblock` inside an `initial` context.
+
+### fill
+```ruby
+fill x1, y1, z1, x2, y2, z2, kind, data
+```
+Fill an area in the world. Be careful with this one as a typo can be very destructive.
+
+### at
+```ruby
+at x, y, z, data, kind, nbt do
+  # command context
+end
+```
+Place a command block with the command given. `kind` can be `:normal`, `:chain`, or `:repeating`. Note that you can only have one command inside the block.
+
+### repeat
+```ruby
+repeat x1, y1, z1, x2, y2, z2 do
+  # command context
+end
+```
+Place a repeating command block chain within an area. Commands within this block will execute in order every tick. Ordering between different blocks depends on their world position.
+
+### chest
+```ruby
+chest x, y, z, data do
+  # container context
+end
+```
+Place a chest in the world with the given contents.
+
+### trapped_chest
+```ruby
+chest x, y, z, data do
+  # container context
+end
+```
+Place a trapped chest in the world with the given contents.
+
+### dispenser
+```ruby
+chest x, y, z, data do
+  # container context
+end
+```
+Place a dispenser in the world with the given contents.
+
+### dropper
+```ruby
+chest x, y, z, data do
+  # container context
+end
+```
+Place a dropper in the world with the given contents.
+
+### furnace
+```ruby
+chest x, y, z, data do
+  # container context
+end
+```
+Place a furnace in the world with the given contents.
+
+
+## Command context
+All Minecraft commands are available within a command context. The following shorthands are also available:
+
+### execute
+```ruby
+execute selector ... do
+  # command context
+end
+```
+Commands inside the block are prefixed by the given `execute` fragment. If you do not specify any arguments after the selector, it will add the `~ ~ ~` for you.
+
+### detect
+```ruby
+detect selector ... do
+  # command context
+end
+```
+Shorthand for `execute selector, '~ ~ ~', :detect ...`. If you do not specify any arguments after the selector, it will add `~ ~ ~` for you.
+
+### gamerule
+```ruby
+gamerule do
+  rule value
+  rule value
+  ...
+end
+```
+Commands inside the block are treated as names of gamerules to set.
+
+### scoreboard
+```ruby
+scoreboard ... do
+  ...
+end
+```
+Commands inside the block are prefixed with the arguments given.
+
+## Container context
+### item
+```ruby
+item kind, count, damage, nbt
+```
+Add an item to the next available slot in this container.
+
+### item_in_slot
+```ruby
+item_in_slot slot, kind, count, damage, nbt
+```
+Add an item to a specific slot in this container.
+
+## NBT and JSON
+Ruby hashes can usually be automatically converted to an NBT or JSON string (whichever is appropriate for a given command). If this conversion doesn't happen, you can use `to_nbt` or `to_json`, available in any context.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mcblocky
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.pre.7
+  version: 0.1.0.pre.alpha.pre.8
 platform: ruby
 authors:
 - Michael Limiero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,7 +98,10 @@ files:
 - bin/console
 - bin/setup
 - bin/workon.cmd
+- doc/Helpers.md
 - doc/Introduction.md
+- doc/Selectors.md
+- doc/Syntax.md
 - examples/ctf/arena.rb
 - examples/ctf/config.example.yml
 - examples/ctf/ctf.rb