ci: add benching

.github/workflows/bench.yml

@@ -0,0 +1,35 @@
+on:
+  pull_request:
+    types: [opened, reopened, edited, synchronize]
+
+env:
+  RUST_NIGHTLY_TOOLCHAIN: nightly-2024-03-24
+
+jobs:
+  benchmark_pr_branch:
+    name: Continuous Benchmarking PRs with Bencher
+    # DO NOT REMOVE: For handling Fork PRs see Pull Requests from Forks
+    if: github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository
+    permissions:
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@master
+        with:
+          toolchain: ${{ env.RUST_NIGHTLY_TOOLCHAIN }}
+
+      - uses: bencherdev/bencher@main
+      - name: Track PR Benchmarks with Bencher
+        run: |
+          bencher run \
+          --project hyperion \
+          --token '${{ secrets.BENCHER_API_TOKEN }}' \
+          --branch '${{ github.head_ref }}' \
+          --branch-start-point '${{ github.base_ref }}' \
+          --branch-start-point-hash '${{ github.event.pull_request.base.sha }}' \
+          --testbed ci-runner \
+          --adapter json \
+          --err \
+          --github-actions '${{ secrets.GITHUB_TOKEN }}' \
+          cargo bench --bench=sort

CONTRIBUTING.md

@@ -11,6 +11,7 @@ Please [join our Discord server](https://discord.gg/PBfnDtj5Wb).
       - [As a software developer](#as-a-software-developer)
       - [As an event organizer/facilitator/sponsor](#as-an-event-organizerfacilitatorsponsor)
       - [As a beta/pen tester](#as-a-betapen-tester)
+    - [How will anti-cheat be implemented?](#how-will-anti-cheat-be-implemented)
     - [As a software developer how should I contribute?](#as-a-software-developer-how-should-i-contribute)
 
 # FAQ
@@ -64,6 +65,15 @@ You are a good person to contribute to this project if you are:
 #### As a beta/pen tester
 - You think outside of the box and are determined to try to break the server.
 
+### How will anti-cheat be implemented?
+- Good question.
+- Will there be some type of proxy server? hmmm maybe.
+- We will probably want a decently naïve anti-cheat system that will be able to give us a confidence score for each player cheating.
+  - Players who are doing "too well" will be flagged for moderators to take action.
+  - We will have several moderations who will be able to take action on flagged players.
+
+
+
 ### As a software developer how should I contribute?
 - Look at the [milestones](https://github.com/andrewgazelka/hyperion/milestones). Currently, we are on [PvP Sword test server](https://github.com/andrewgazelka/hyperion/milestone/1).
 - If there is an issue that is not assigned to anyone, you can pick it up and assign it to yourself.

crates/broadcast/README.md

@@ -1 +1,4 @@
-# broadcast
+# broadcast
+
+> [!NOTE]  
+> Broadcast is not currently being used anywhere in the codebase and does not work properly. Tests need to be added to it.

crates/bvh/README.md

@@ -1 +1,3 @@
-#0 bvh
+# bvh
+
+This implements a Bounding Volume Hierarchy (BVH) that is used to accelerate collision detection and other spatial queries.