Merge pull request #2 from oganexon/develop

1.0.1

Author: SteelAlloy

README.md

@@ -21,21 +21,26 @@
 
 ## Table of Contents
 
-- [Installation](#installation)
-  - [Usage](#usage)
-    - [list](#list)
-    - [tpll](#tpll)
-    - [tpdms](#tpdms)
-    - [draw](#draw)
-  - [Find a railroad name](#find-a-railroad-name)
-  - [Roadmap](#roadmap)
-  - [Contributing](#contributing)
-  - [License](#license)
-  - [Contact](#contact)
-
-
-
-## About The Project
+- [Table of Contents](#table-of-contents)
+- [✨ About The Project](#%e2%9c%a8-about-the-project)
+  - [Built With](#built-with)
+- [Getting Started](#getting-started)
+  - [Prerequisites](#prerequisites)
+- [📦 Installation](#%f0%9f%93%a6-installation)
+- [🚀 Usage](#%f0%9f%9a%80-usage)
+  - [list](#list)
+  - [tpll](#tpll)
+  - [tpdms](#tpdms)
+  - [draw](#draw)
+- [🔍 Find a railroad name](#%f0%9f%94%8d-find-a-railroad-name)
+- [📜 Roadmap](#%f0%9f%93%9c-roadmap)
+- [🏗️ Contributing](#%f0%9f%8f%97%ef%b8%8f-contributing)
+- [License](#license)
+- [Contact](#contact)
+
+
+
+## ✨ About The Project
 
 ![Product Name Screen Shot](images/rails.png)
 
@@ -50,14 +55,11 @@ This set of tools will allow you to enjoy a better experience on BTE and build t
 ## Getting Started
 
 
-
 ### Prerequisites
 
 You must have WorldEdit as a minimum but install the BTE modpack, it's preferable.
 
-##
-
-# Installation
+## 📦 Installation
 
 1. Download the [Rhino Javacsript interpreter](https://developer.mozilla.org/en-US/docs/Mozilla/Projects/Rhino) for Java,
 which you can get from [here](https://github.com/mozilla/rhino/releases/download/Rhino1_7_12_Release/rhino-1.7.12.zip).
@@ -70,7 +72,7 @@ Open the zip file, go to `/lib` and move `rhino-1.7.12.jar` (or newer) to your `
 
 
 
-## Usage
+## 🚀 Usage
 
 ```bash
 /cs <COMMAND> [ARGS]
@@ -85,6 +87,8 @@ These are WorldEdit scripts, if blocks are modified you have access to `//undo`.
 
 Do you need another function? Request it [here](https://github.com/oganexon/BTE-tools/issues).
 
+The first execution of a command will take longer than the others because the script has to be compiled.
+
 
 
 ### list
@@ -147,7 +151,7 @@ Setup :
  - Get a geoJSON file of valid tracings / OR
  - Choose one of the following links:
    - [Rails - bounding box](http://overpass-turbo.eu/s/TwW) (Select the desired region using the map)
-   - [Rails - name](http://overpass-turbo.eu/s/TwY) (Replace with a specific railroad name) [(find a railroad name)](#find-a-railroad-name)
+   - [Rails - name](http://overpass-turbo.eu/s/TwY) (Replace with a specific railroad name) [(find a railroad name)](#%f0%9f%94%8d-find-a-railroad-name)
  - Click `Run` > `Export` > `download/copy as GeoJSON`
  - Place the file in the `drawings` folder.
 
@@ -160,7 +164,7 @@ Examples :
 
 
 
-## Find a railroad name
+## 🔍 Find a railroad name
 
 To find a railway name, right click near the rails and click on `Query features`
 
@@ -176,21 +180,22 @@ And finally, get the name.
 
 
 
-## Roadmap
+## 📜 Roadmap
 
 See the [open issues](https://github.com/oganexon/BTE-tools/issues) for a list of proposed features (and known issues).
 
 
 
-## Contributing
+## 🏗️ Contributing
 
 Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
 
 1. Fork the Project
 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the Branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
+4. Make sure that `yarn build` and `yarn lint` do not generate errors
+5. Push to the Branch (`git push origin feature/AmazingFeature`)
+6. Open a Pull Request
 
 
 

gulpfile.babel.js

@@ -3,7 +3,7 @@ const babel = require('gulp-babel')
 const uglify = require('gulp-uglify')
 const bro = require('gulp-bro')
 
-const files = ['tpll', 'tpdms', 'draw']
+const files = ['tpll', 'tpdms', 'draw', 'list', 'help']
 
 exports.default = function () {
   return src(`src/+(${files.join('|')}).js`)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "bte-tools",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Awesome tools and scripts to enhance your experience on the Build The Earth project!",
   "scripts": {
     "lint": "standard src/**/* --fix",

src/draw.js

@@ -7,11 +7,11 @@ importPackage(Packages.com.sk89q.worldedit)
 importPackage(Packages.com.sk89q.worldedit.math)
 importPackage(Packages.com.sk89q.worldedit.blocks)
 
-const usage = '/cs draw <file> <block> [options] \n' +
-  ' • §o/cs draw rails1 iron_block\n' +
-  ' • §o/cs draw file3 stone u\n' +
-  'Options:\n' +
-  ' • §lu§r§c Draw a block above'
+const usage = `/cs draw <file> <block> [options]
+ • §o/cs draw rails1 iron_block
+ • §o/cs draw file3 stone u
+Options:
+ • §lu§r§c Draw a block above`
 
 context.checkArgs(2, 3, usage)
 

src/help.js

@@ -0,0 +1 @@
+require('./list')

src/list.js

@@ -0,0 +1,9 @@
+/* global player */
+
+const list = `Usage: /cs <COMMAND> [ARGS]
+ • list : Lists all available commands.
+ • tpll : Replaces the tpll command.
+ • tpdms : Same as tpll but takes degrees minutes seconds (such as 47°35'6.32"N 6°53'50.06"E ).
+ • draw : Traces any imported shape of an OpenStreetMap query - railroads, roads, etc.`
+
+player.print(list)

src/tpdms.js

@@ -4,9 +4,9 @@ const getProjection = require('./getProjection')
 importPackage(Packages.com.sk89q.worldedit)
 importPackage(Packages.com.sk89q.worldedit.math)
 
-const usage = '<latitude> <longitude> [altitude]\n' +
-' • §o/cs tpdms 47°35\'6.32"N 6°53\'50.06"E\n' +
-' • §o/cs tpdms 47°35\'6.32"N, 6°53\'50.06"E 370'
+const usage = `<latitude> <longitude> [altitude]
+ • §o/cs tpdms 47°35'6.32"N 6°53'50.06"E
+ • §o/cs tpdms 47°35'6.32"N, 6°53'50.06"E 370`
 
 context.checkArgs(2, 3, usage)
 

src/tpll.js

@@ -4,9 +4,9 @@ const getProjection = require('./getProjection')
 importPackage(Packages.com.sk89q.worldedit)
 importPackage(Packages.com.sk89q.worldedit.math)
 
-const usage = '<latitude> <longitude> [altitude]\n' +
-' • §o/cs tpll 47.58523 6.89725\n' +
-' • §o/cs tpll 47.58523, 6.89725 370'
+const usage = `<latitude> <longitude> [altitude]
+ • §o/cs tpll 47.58523 6.89725
+ • §o/cs tpll 47.58523, 6.89725 370`
 
 context.checkArgs(2, 3, usage)