up3

.github/CONTRIBUTING.md

@@ -0,0 +1,66 @@
+# Contributing to Dragonfly
+
+First, thank you for your interest in contributing to Dragonfly. :tada:
+
+The following is a set of guidelines for contributing to Dragonfly. These are guidelines and in
+general it is recommended to stick to them when contributing, but you should use your best
+judgement. Feel free to propose changes to this document in our Discord.
+
+### Issues
+Issues are very welcome, both in the form of bug reports and feature requests. 
+
+When opening a bug report, please try to provide as much information as you can to reproduce the issue. When opening a 
+feature request, please be as clear as you can and provide concrete examples of how you think the proposed feature 
+should work. The more precise you are, the easier it is for someone to pick up your request. Don't be afraid to propose
+any ideas you might have, they may help people looking to pick up your feature request!
+
+As soon as a maintainer sees your issue and has enough information, your issue will be added to a milestone that
+indicates when we hope to have your issue resolved.
+
+### Pull Requests
+In general, it is recommended to discuss any changes you would like to make in our Discord to
+before making changes, unless the change-set is otherwise small or limited to a specific part of
+the code base.
+
+When reviewing pull requests, we aim to reach the following goals with the code proposed:
+* Maintain the quality of the source code.
+* Stick to the standard formatting of Go (go fmt).
+* Provide a well-documented, simple and clean codebase.
+
+To make sure your pull request satisfies those points, we recommend you do the following before
+opening a pull request:
+* Run `go fmt` on any files you have changed to ensure the formatting is correct. Some IDEs have
+  integration with this tool to run it automatically when committing. GoLand has a box that may be
+  checked in the bottom-right corner when creating a commit.
+* Make sure to provide documentation for symbols where adequate. We generally follow the following
+  conventions for documentation in pull requests:
+  - Exported symbols (TypeName, FunctionName) should always have documentation over them, but if
+    the function exists merely to satisfy an interface, the documentation may read 
+    `// FunctionName ...` or be completely absent if the method has no functional behaviour.
+  - Unexported symbols (typeName, functionName) _should_ have documentation, but doing so is not
+    mandatory if the function is very simple and needs no clarification.
+* Make sure to use British English and proper punctuation throughout symbol names, variables and
+  documentation.
+* Where possible, try to expose as few exported symbols (functions, types) as possible, unless 
+  strictly necessary. This makes it easier for us to change code in the future and ensures that 
+  users cannot use functions not suitable for the API.
+* In big functions it can become difficult to track the execution flow. Try to `return` as quickly
+  possible in functions so that the main code flow is minimally indented and therefore easy to 
+  track and understand.
+* In places where there are three or more sequential variable declarations, these should be grouped
+  into a single `var ( )` block.
+* Try to be conservative with the usage of generics. While these are often useful, they can quickly
+  pollute code if used in excess. Consider carefully if generics are needed, particularly for 
+  exported types and functions. Don't hesitate on using them if they are able to clean up the code
+  significantly.
+* We strive to have only completely functional features in the codebase. While we recognise that
+  it is not always possible to provide full functionality for a feature in a single pull request,
+  you should attempt to do so to the extent that you can. Specific smaller features part of the
+  pull request that cannot be implemented yet should be marked with a `// TODO: ...` comment so
+  that we can implement these when the required functionality is present.
+* When you open a PR, we assume you have tested your code and made sure it is working as intended.
+  As a general recommendation, you should enable the Minecraft Content Log in the Profile settings
+  so that it becomes obvious when invalid data is sent to the client.
+  
+If you run into a problem or otherwise need help with your pull request, please feel free to reach
+out to us on Discord, so we can work towards a complete pull request together.

.github/workflows/pr.yml

@@ -0,0 +1,22 @@
+name: Build
+on: [pull_request]
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v6
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version-file: go.mod
+
+      - name: Lint
+        run: make lint
+
+      - name: Test
+        run: go test ./...

.github/workflows/pr_target.yml

@@ -0,0 +1,41 @@
+name: Deploy
+on:
+  pull_request_target:
+    types: [opened, synchronize, reopened, closed]
+jobs:
+
+  deploy:
+    name: Deploy
+    if: github.event.action != 'closed'
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v6
+        with:
+          ref: refs/pull/${{ github.event.pull_request.number }}/merge
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version-file: go.mod
+
+      - name: Build
+        run: go build -o dragonfly_exe -v .
+
+      - name: Deploy test server
+        run: |
+          curl -X POST https://df-mc.dev/pullrequest \
+            -H "X-API-Key: ${{ secrets.API_KEY }}" \
+            -F "pr=${{ github.event.pull_request.number }}" \
+            -F "binary=@dragonfly_exe"
+
+  cleanup:
+    name: Cleanup
+    if: github.event.action == 'closed'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Delete test server
+        run: |
+          curl -X DELETE https://df-mc.dev/pullrequest/${{ github.event.pull_request.number }} \
+            -H "X-API-Key: ${{ secrets.API_KEY }}"

.github/workflows/push.yml

@@ -0,0 +1,93 @@
+name: Build and deploy
+on: [push]
+jobs:
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v6
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version-file: go.mod
+
+      - name: Lint
+        run: make lint
+
+      - name: Test
+        run: go test ./...
+
+  deploy:
+    name: Deploy
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.repository == 'df-mc/dragonfly'
+    steps:
+
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v6
+
+      - name: Set up Go
+        uses: actions/setup-go@v6
+        with:
+          go-version-file: go.mod
+
+      - name: Build
+        run: go build -o dragonfly_exe -v .
+
+      - name: Set SSH info
+        env:
+          SSH_KNOWN_HOSTS: ${{ secrets.VPS_KNOWN_HOSTS }}
+          SSH_PRIVATE_KEY: ${{ secrets.VPS_PRIVATE_KEY }}
+        run: |
+          mkdir -p ~/.ssh/
+          echo "$SSH_KNOWN_HOSTS" > ~/.ssh/known_hosts
+          echo "$SSH_PRIVATE_KEY" > ~/.ssh/id_rsa
+          chmod 600 ~/.ssh/id_rsa
+
+      - name: Stop server
+        env:
+          HOST: ${{ secrets.VPS_HOST }}
+        run: |
+          ssh -i ~/.ssh/id_rsa $HOST screen -d -R -S dragonfly -X stuff '^C'
+          ssh -i ~/.ssh/id_rsa $HOST rm -f dragonfly_exe
+
+      - name: Transfer executable
+        env:
+          HOST: ${{ secrets.VPS_HOST }}
+        run: |
+          scp -i ~/.ssh/id_rsa dragonfly_exe $HOST:/home/dragonfly_exe
+
+      - name: Restart server
+        env:
+          HOST: ${{ secrets.VPS_HOST }}
+        run: |
+          ssh -i ~/.ssh/id_rsa $HOST "screen -d -R -S dragonfly -X stuff '/home/dragonfly_exe\n'"
+
+  update_contributors:
+    name: Update Contributors
+    runs-on: ubuntu-latest
+    if: github.repository == 'df-mc/dragonfly' && github.ref == 'refs/heads/master'
+    steps:
+      - uses: actions/create-github-app-token@v3
+        id: app-token
+        with:
+          client-id: ${{ vars.PUSH_CLIENT_ID }}
+          private-key: ${{ secrets.PUSH_SECRET }}
+      - name: Checkout Repository
+        uses: actions/checkout@v6
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+      - name: Fetch Contributors
+        run: |
+          CONTRIBUTOR_DATA=$(curl -H "Accept: application/vnd.github+json" https://api.github.com/repos/df-mc/dragonfly/contributors?per_page=9999)
+          echo $CONTRIBUTOR_DATA
+          if [ $(echo $CONTRIBUTOR_DATA | jq type) == '"array"' ]; then echo -e "// Code generated by .github/workflows/push.yml; DO NOT EDIT\n\npackage session\n\n// enchantNames are names translated to the 'Standard Galactic Alphabet' client-side. The names generally have no meaning\n// on the vanilla server implementation, so we can sneak some easter eggs in here without anyone noticing.\nvar enchantNames = []string{"$(echo $CONTRIBUTOR_DATA | jq .[].login | sed -r -e "s/([^A-Z\"])([A-Z])/\1 \2/g" | sed "s/./\L&/g" | sort | sed -z "s/\n/,/g")"}" > server/session/enchantment_texts.go && gofmt -w server/session/enchantment_texts.go; fi
+      - name: Push Changes
+        uses: stefanzweifel/git-auto-commit-action@v7
+        with:
+          commit_message: "updated contributor list"