Initial commit

Author: MercerK

.babelrc

@@ -0,0 +1,17 @@
+{
+  "ignore": ["node_modules/**/*"],
+  "presets": [
+    ["@babel/preset-typescript"],
+    ["@babel/preset-env",
+      {
+        "targets": {
+          "esmodules": true
+        }
+      }]
+  ],
+  "plugins": [
+    "@babel/plugin-proposal-class-properties",
+    "babel-plugin-add-module-exports",
+    "@babel/plugin-transform-classes"
+  ]
+}

.gitignore

@@ -0,0 +1,4 @@
+node_modules
+dist
+.env
+server

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "trailingComma": "es5",
+  "tabWidth": 2,
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 120,
+  "proseWrap": "always"
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021-present, Kyle Mercer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

deps/.gitkeep

@@ -0,0 +1,48 @@
+{
+  "author": "Kyle Mercer",
+  "name": "grakkit-boilerplate",
+  "description": "Boilerplate impl. using Babel, Webpack, and TypeScript",
+  "license": "MIT",
+  "version": "1.0.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MercerK/grakkit-boilerplate"
+  },
+  "keywords": [
+    "grakkit",
+    "minecraft"
+  ],
+  "dependencies": {
+    "@grakkit/stdlib-paper": "^1.0.12",
+    "grakkit-boilerplate-util": "^0.0.18",
+    "grakkit-sound-browser": "^0.0.5",
+    "lodash": "^4.17.21"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.14.3",
+    "@babel/core": "^7.14.3",
+    "@babel/plugin-proposal-class-properties": "^7.13.0",
+    "@babel/preset-env": "^7.14.2",
+    "@babel/preset-typescript": "^7.13.0",
+    "@types/lodash": "^4.14.178",
+    "@types/node": "^16.4.6",
+    "babel-loader": "^8.2.2",
+    "babel-plugin-add-module-exports": "^1.0.4",
+    "babel-plugin-transform-class-properties": "^6.24.1",
+    "concurrently": "^7.0.0",
+    "got": "^11.8.2",
+    "ts-node": "^10.0.0",
+    "typescript": "^4.5.5",
+    "webpack": "^5.37.0",
+    "webpack-cli": "^4.7.0"
+  },
+  "peerDependencies": {
+    "@grakkit/server": "^1.4.2"
+  },
+  "scripts": {
+    "start:server": "cd server & java -Xms2G -Xmx2G -jar server.jar -nogui",
+    "start:js": "ts-node --project tsconfig-node.json ./scripts/start",
+    "start": "concurrently \"npm run start:server\" \"npm run start:js\"",
+    "build": "webpack --env production"
+  }
+}

deps/java-express-0.0.10.jar

@@ -0,0 +1,72 @@
+# Grakkit Boilerplate
+
+> Useful boilerplate for creating stuff with [Grakkit](https://github.com/grakkit/grakkit)
+
+Grakkit is a Minecraft Server Plugin utilizing the GraalVM JavaScript Engine. This repository is a boilerplate
+implementation to quickly spawn up a workspace to get started using Babel, Webpack, and TypeScript.
+
+This boilerplate features a "Hot Reload" method, which speeds up development significantly. Whenever you make changes to
+your code during Runtime and hit save, it'll rebuild the solution then reload it on the server. This takes less than a
+second.
+
+![Hot Reload](./docs/assets/hotreload.gif)
+
+# Getting Started
+
+1. Click the "Use this template" in the top right.
+2. Once you have cloned the repo and have it locally, you'll need to do the following:
+
+- Download your preferred Minecraft Server Plugin implementation
+  - Grakkit only supports [Paper](https://papermc.io/downloads) or Minestom.
+- Place the server plugin jar file in the `./server` folder and rename it to `server.jar`.
+- Download the [Grakkit jar](https://github.com/grakkit/grakkit/releases) and place it in the `./server/plugins` folder.
+- Run `npm install` or `yarn`.
+- Open a terminal and run `npm run start:js` or `yarn start:js`. This will start the webpack.
+- Open another terminal and run `npm run start:server` or `yarn start:server`
+  - When running it for the first time, you'll need to accept the `EULA` in `./server/eula.txt`.
+  - After updating the `EULA`, you may need to restart the server.
+
+3. Once everything is up and running, you can now start developing in `./src/index.ts`.
+
+# What can you do with this?
+
+- Through Grakkit, you have access to both Java and Paper classes, objects, and types.
+- You can access the API of other server plugins, such as LibsDisguises, PlaceholderAPI, and so many more.
+- You can import existing JavaScript libraries and use them within your plugin, such as Lodash, Redux, Yaml, Immer, and
+  so many more.
+  - Note: NodeJS does not work within GraalVM, so you cannot use libraries expecting NodeJS API.
+  - Note: Fetch/Websockets/Multithreading can be a challenge.
+
+![Lodash](./docs/assets/lodash.gif)
+
+# How It Works
+
+## Development Mode `npm run start:js`/`yarn start:js`
+
+1. This spawns a webserver within the Minecraft server.
+2. When in development mode, it enables a new API route called `/reload`.
+3. The solution is built using webpack (which is _fast_) and it will put the compiled files in `server/plugins/grakkit`.
+4. Using a custom start up script in `scripts/start/index.ts`, it will build the solution, enable development mode, and
+   ping the `/reload` endpoint.
+   - Once the endpoint is hit, well, the server reloads grakkit.
+
+## Production Mode `npm run build`/`yarn build`
+
+1. Using webpack, it'll build the files to `/dist`. Any code relying on `development` will be disabled.
+2. This can be a useful step for deployments.
+
+# Startup
+
+1. Run `npm run start:js` or `yarn start:js`
+2. Run `npm run start:server` or `yarn start:server`
+
+OR
+
+1. Run `npm run start` or `yarn start`
+
+# Info
+
+## Deps Folder
+
+When developing plugins, you may need to hook into additional dependencies. You can add those jars to the `./deps`
+folder. If you need further customization, you can update `scripts/start/index.ts`.

docs/assets/hotreload.gif

@@ -0,0 +1,73 @@
+import webpack from 'webpack'
+import path from 'path'
+import fs from 'fs'
+import { clearWebpackConsole, displayWebpackMessages } from 'grakkit-boilerplate-util/dist/scripts'
+import got from 'got'
+
+function initializePaths() {
+  const root = path.join(__dirname, '..', '..')
+
+  return {
+    root,
+    deps: path.join(root, 'deps'),
+    grakkit: path.join(root, 'server', 'plugins', 'grakkit'),
+    config: path.join(root, 'webpack.config.js'),
+  }
+}
+
+const paths = initializePaths()
+const createConfig = require(paths.config)
+
+function copyDependencies() {
+  const files = fs.readdirSync(paths.deps).filter((f) => f.includes('.jar') || f === 'config.yml')
+
+  files.forEach((file) => fs.copyFileSync(path.join(paths.deps, file), path.join(paths.grakkit, file)))
+}
+
+async function main() {
+  const config = createConfig({ dev: true })
+
+  copyDependencies()
+
+  let compiler: webpack.Compiler
+  try {
+    compiler = webpack(config)
+  } catch (err) {
+    console.log(err)
+
+    process.exit(1)
+  }
+
+  clearWebpackConsole()
+
+  compiler.hooks.invalid.tap('invalid', () => {
+    clearWebpackConsole()
+
+    console.log('Compiling...')
+  })
+
+  compiler.hooks.done.tap('done', async (stats) => {
+    clearWebpackConsole()
+    displayWebpackMessages(stats)
+
+    handleReload()
+  })
+
+  return compiler.watch({}, (stats) => {
+    console.log(stats)
+  })
+}
+
+async function handleReload() {
+  try {
+    const req = await got.get('http://localhost:4000/reload', { timeout: 1000 })
+    console.log('Reload successful')
+
+    return
+  } catch (err) {
+    console.log('Failed to connect...')
+    return setTimeout(handleReload, 1000)
+  }
+}
+
+main()

docs/assets/lodash.gif

@@ -0,0 +1,63 @@
+import { obePlayer } from '@grakkit/types-paper'
+import { event, server, command } from '@grakkit/stdlib-paper'
+// You can use the existing npm modules within Minecraft
+import debounce from 'lodash/debounce'
+// You can import other grakkit plugins into your own as well!
+import { SoundBrowser } from 'grakkit-sound-browser'
+
+function initializePlayerJoin() {
+  event('org.bukkit.event.player.PlayerJoinEvent', (event) => {
+    const player = event.getPlayer()
+
+    sendPlayerMessage(player, 'Hello! Welcome to Grakkit Boilerplate!')
+
+    setTimeout(() => {
+      sendPlayerMessage(player, 'Enjoy your stay!')
+      sendPlayerMessage(player, 'You can check out the soundBrowser by running `/soundbrowser` in chat.')
+    }, 5000)
+
+    player.getWorld().setTime(600)
+  })
+}
+
+function initializePlayerQuit() {
+  event('org.bukkit.event.player.PlayerQuitEvent', (event) => {
+    server.broadcastMessage(`${event.getPlayer().getName()} has left! Please come back soon.`)
+  })
+}
+
+function initializeChunkLoad() {
+  let count = 0
+  const debouncedFn = debounce(() => {
+    server.broadcastMessage(`${count} Chunks have been loaded.`)
+    count = 0
+  }, 1000)
+
+  event('org.bukkit.event.world.ChunkLoadEvent', (event) => {
+    count++
+    debouncedFn()
+  })
+}
+
+export function initializeDemo() {
+  // Initializes events
+  initializePlayerJoin()
+  initializePlayerQuit()
+  initializeChunkLoad()
+
+  // Initializes Command
+  command({
+    name: 'help-grakkit',
+    execute: (sender) => {
+      sender.sendMessage('For more information on Grakkit, checkout https://github.com/grakkit/grakkit')
+    },
+  })
+
+  SoundBrowser.initialize()
+}
+
+function sendPlayerMessage(player: obePlayer, msg: string) {
+  // Some typings are not a 100% match, but will allow you to work regardless.
+  // In this instance, it expects "nmbacBaseComponent", but it will allow a string.
+  player.sendMessage(msg as any)
+}

package.json

@@ -0,0 +1,5 @@
+import { initializeAutoReload } from 'grakkit-boilerplate-util'
+import { initializeDemo } from './demo'
+
+initializeDemo()
+initializeAutoReload()

readme.md

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "es2019",
+    "lib": ["DOM","es2019"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": true,
+    "noImplicitAny": false,
+    "outDir": "temp"
+  },  
+  "exclude": [
+    "node_modules"
+  ]
+}

scripts/start/index.ts

@@ -0,0 +1,23 @@
+{
+  "compilerOptions": {
+    "strict": true,
+    "declaration": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "incremental": true,
+    "lib": [ "ES2015", "ES2016", "ES2017", "ES2018", "ES2019", "ES2020" ],
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "resolveJsonModule": true,
+    "rootDir": "./",
+    "skipLibCheck": true,
+    "target": "es2020",
+    "watch": true,
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules"
+  ]
+}