merge with mascal

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "composer"
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

.github/workflows/ghpage.yml

@@ -0,0 +1,41 @@
+name: Deploy to GitHub Pages from latest tag
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tagged commit
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Fix version and cache bust
+        run: |
+          sed -i -E 's/(<!--VERSION-->Version: ).+/\1'"${{ github.ref_name }}"'/' js/menu.js
+          # Cache bust top js and css
+          VERSION="${{ github.ref_name }}"
+          ESCAPED_VERSION=$(printf '%s' "$VERSION" | sha1sum | cut -c1-8)
+
+          find . -name '*.html' -print0 | xargs -0 sed -E -i'' 's/\.(css|js)(\?[^"]*)?">/.\1?'$ESCAPED_VERSION'">/g'
+          find . -name '*.js' -print0 | xargs -0 sed -E -i'' '/^[[:space:]]*import.*\.js"/s/(\.js)(\?[^"]*)?"/\.js?'$ESCAPED_VERSION'"/g'
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: '.'
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Create Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Clean up files with sed
+        run: |
+          # Remove all preload statements
+          sed -i '/<link rel="preload"/d' *.html
+
+          # Cache bust top js and css
+          VERSION="${{ github.ref_name }}"
+          ESCAPED_VERSION=$(printf '%s' "$VERSION" | sha1sum | cut -c1-8)
+          find . -name '*.html' -print0 | xargs -0 sed -E -i'' 's/\.(css|js)(\?[^"]*)?">/.\1?'$ESCAPED_VERSION'">/g'
+          find . -name '*.js' -print0 | xargs -0 sed -E -i'' '/^[[:space:]]*import.*\.js"/s/(\.js)(\?[^"]*)?"/\.js?'$ESCAPED_VERSION'"/g'
+
+          # Put a fixed version
+          sed -i -E 's/(<!--VERSION-->Version: ).+/\1'"${{ github.ref_name }}"'/' js/menu.js
+
+      - name: Create custom tarball
+        run: |
+          sudo apt install composer &&
+          composer install &&
+          tar -czf ${{ runner.temp }}/CoRT-${{ github.ref_name }}.tar.gz \
+            --transform "s,^,CoRT-${{ github.ref_name }}/," \
+            *
+
+      - name: Create Release
+        uses: softprops/action-gh-release@v1
+        with:
+          name: ${{ github.ref_name }}
+          body: |
+            ### About
+
+            This is an automated release.
+
+            See https://github.com/mascaldotfr/CoRT/tree/main/deploy/README.md to deploy it
+
+            To setup CoRT on managed webhosting or integrating it on your own server, use **CoRT-${{ github.ref_name }}.tar.gz** instead of the source code.
+
+            ### Changelog
+          draft: true
+          prerelease: false
+          generate_release_notes: true
+          files: ${{ runner.temp }}/CoRT-${{ github.ref_name }}.tar.gz
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,11 +1,9 @@
-collect/data.*
-ping.js
-warstatus/*.json
-warstatus/*.json.gz
-warstatus/stats/*.json
-warstatus/stats/*.json.gz
-warstatus/stats/*.sqlite
-__pycache__**
+# dynamic API data
+api/var/*
+!api/var/README.md
+
+# Composer modules
+vendor
 
 # for macOS users
-.DS_Store
+.DS_Store

CONTRIBUTING.md

@@ -11,18 +11,14 @@ If you plan to bring code improvements:
    maintaining.
 2. Keep the style consistent, even if sometimes it's gross like not using dot
    notation for hashes.
-3. The javascript used in CoRT must follow ECMAScript <= 8, please use
-   [JSHint](https://jshint.com/) to check this out, or mention
-   you didn't. Linux usage:
+3. Optionally use [JSHint](https://jshint.com/). Linux usage:
    ```shell
    cd /tmp
    npm install jshint
    cd node_modules/jshint
-   echo '{ "esversion"     : 8 }' > jshintrc
-   ./jshint -c jshintrc /where/is/CoRT/js/*.js | grep esversion
-   # Should return nothing out of chartist.js which is not considered essential
+   echo '{ "esversion": 11, "sub": true }' > jshintrc
+   ./bin/jshint -c jshintrc /where/is/CoRT/js/*.js
    ```
-4. If you touch the python code, try to not adding extra modules as a dependency.
 
 ### Why using Firefox 78 as a baseline
 
@@ -41,7 +37,6 @@ in a virtual machine to test.
 Note that this requirement will change over time, for example if TLS technology
 changes and makes this version unable to connect to https sites.
 
-
 ### Commit hook for versioning in the footer
 
 This is mostly a note to myself.
@@ -59,5 +54,5 @@ git add "${GIT_WORK_TREE}/js/menu.js"
 echo "Updated last commit date"
 ```
 
-Don't forget to make it executable. This will update the versoin for each
+Don't forget to make it executable. This will update the version for each
 commit, including non user facing changes.

README.md

@@ -1,3 +1,7 @@
+
+> [!IMPORTANT]
+> **CoRT is in maintenance mode: no new features will be added, only minor fixes or data updates. The site will stay up though.**
+
 # Champions of Regnum trainer (and more)
 
 Since the famous regnumsentinel trainer is dead, all is left are operating
@@ -9,12 +13,13 @@ This is a (simpler) knockoff of the regnumsentinel website trainer, this one
 will be alive as long as GitHub exists and is open source software. On top of
 that, there are countdown pages for bosses and BZ, WZ status and statistics.
 
-The website just requires a webserver serving static files to run, everything
-is run client side, with the exception of the WZ status and statistics (see the
-`warstatus` directory) that can partly be replaced by a link to NGE's official
-page, and anonymous setup collection (see the `collect` directory) which by
-default only works for https://mascaldotfr.github.io and can be completely
-skipped.
+The trainer just requires a webserver serving static files to run, everything
+is run client side. All the rest depends on an API server though.
+
+Deploying CoRT (with or without the API) is explained [there](deploy/README.md)
+
+There is also a [wiki](https://github.com/mascaldotfr/CoRT/wiki) containing
+extra infos about using and deploying CoRT.
 
 ## Known issues
 
@@ -26,16 +31,8 @@ skipped.
   to have a database server, since it then would require a separate server and
   a domain for such a feature, that could go down like regnumsentinel.
 
-## Setting a local webserver
-
-If you want to make changes to CoRT or run it locally, you can use python to
-[create a temporary local webserver](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Tools_and_setup/set_up_a_local_testing_server#using_python).
-
 ## Hidden pages
 
-* **[tstats.html](https://mascaldotfr.github.io/CoRT/tstats.html)** is CoRT's own
-  Trainer statistics page. For more infos on why it's not the default, see
-  [the collect README](collect/README.md#Javascript).
 * **[beta.html](https://mascaldotfr.github.io/CoRT/beta.html)** is a part of the
   [upgrade cycle process](UPDATING.md).
 * **[tests.html](https://mascaldotfr.github.io/CoRT/tests.html)** includes
@@ -70,6 +67,8 @@ If you want to make changes to CoRT or run it locally, you can use python to
   [Anpu](https://github.com/Anpu) did a thing or two about it as well iirc.
 * [Joshua2504](https://github.com/Joshua2504) and
   [Shaiko](https://github.com/Shaiko35) from https://cor-forum.de/ for keeping
-  the spell database updated
+  the spell database updated before I took over
 * Slartibartfast, the regnumsentinel.com creator, site that gave me big hints about
   the UI should be done.
+* Halvdan. His own trainer stats page has been a major influence on
+  [tstats.html](https://mascaldotfr.github.io/CoRT/tstats.html)

UPDATING.md

@@ -1,48 +1,77 @@
-# TRAINER UPDATE PROCESS
+# UPDATE PROCESS
+
+
+## TRAINER
 
 Upgrade cycle when balance changes are released by NGE. Note that doing the
 change will require you to know how to operate a webserver to test, and doing
 some minor changes in the source code. While not complicated, you still need to
 know these basics.
 
-## Doing a balance update
+### Doing a balance update
 
 There are shorter ways to do so, but this way you can update a new trainer
 dataset beta after beta, until the final release, making 0-day releases of the
 live version without spending a lot of time on the said release day.
 
-### Create a new version
+#### Create a new version
 
 As soon as the first beta/rc is released, remove the `data/beta` directory and
 copy the newest version folder to `data/beta` (called "beta folder" later).
 
-### Change the trainer data
+#### Change the trainer data
 
 Modify the new `trainerdata.json` in the beta folder with the new balance
 changes in [#experimental](https://discord.com/channels/542061814704373782/542403024417456138).
 
 Until the final release is live, you can checkout `beta.html` to test things
 out, beta after beta.
 
-### Change the icons
+#### Change the icons
 
 Icons size is 47px width x 48px height. The ratio hasn't been kept to deal with
 some artifacts as there are different icon styles used by the game (square, rounded,
 with or without black border).
 
 **It's not recommended to re-edit the images from the older version**, due to the
 quality loss it implies. Lossless icons for all skills are available in the
-[CoRT Icons pack](https://github.com/mascaldotfr/CoRT/releases).
+[CoRT Icons pack](https://github.com/mascaldotfr/CoRT-icons).
 
 That pack also includes a python script to automatically refresh skills icons from
 your edited `trainerdata.json`. Its usage is explained in the pack's README, and
 is the **heavily recommended method**.
 
-### Making the new version available on the website once the new version is live
+#### Making the new version available on the website once the new version is live
 
 Copy the beta folder to `data/trainer/1.x.x` according to the new version number.
 
 Update the array containing all available versions in
 `js/trainertools/constants.js` with the newest version last.
 
 That's it.
+
+
+## BOSSES
+
+It's very important to check out bosses respawns at least every 3 months, as
+the respawn time is slowly drifting in the future.
+
+Updating the bosses requires to change `api/bin/bosses/BossesCalculator.php`
+with a Unix timestamp corresponding to the observated boss respawn.
+
+If you run MacOS or Linux, run this in a Terminal while waiting for the boss
+and press `Ctrl-C` when you see it. The last number is the good Unix timestamp:
+
+```shell
+while :; do date +%s; sleep 1; done
+```
+
+Alternatively, you can check out [this website](https://time.is/Unix_time) but
+you can't stop the counter.
+
+
+## BZ
+
+Updating the BZ beginning and ending times requires to change
+`api/bin/bz/Battlezone.php` with their respective hours in UTC (currently, the
+ingame schedule shows UTC hours already), while keeping the ascending order.

api/MAINTENANCE.md

@@ -0,0 +1,22 @@
+# MAINTENANCE
+
+This API endpoint allows to display a message in a red card on top of each
+page, to warn for servers issues and potentially other stuff, if
+`/api/var/maintenance.txt` exists and is non-empty.
+
+## URL
+
+https://cort.thebus.top/api/var/maintenance.txt
+
+## Usage
+
+### Add a maintenance message
+
+Create/Open the `maintenance.txt` file inside `/api/var`, and put your
+maintenance message there. HTML is allowed.
+
+### Remove a maintenance message
+
+Just empty the file. It must be zero byte long.
+
+It's not recommended to delete the file, for SEO reasons.

api/README.md

@@ -0,0 +1,34 @@
+# APIs
+
+## About
+
+Each API endpoint has a README.md explaining what they do.
+
+The whole API is written in PHP.
+
+See the [deploy docs](../deploy/README.md) as well if you want to deploy it.
+
+## READMEs list
+
+- [setups collector and trainer stats](bin/collect/README.md)
+- [bosses](bin/bosses/README.md)
+- [bz](bin/bz/README.md)
+- [warstatus](bin/warstatus/README.md)
+- [warzone stats and events](bin/warstatus/stats/README.md)
+- [sentinel](bin/sentinel/README.md)
+
+Special stuff:
+
+- [put a maintenance message](MAINTENANCE.md)
+
+## API endpoints
+
+To get the whole list:
+
+1. Open https://mascaldotfr.github.io/CoRT/
+2. Open the dev tools (F12)
+3. Paste this line in the console and press enter:
+
+```js
+(await import("./js/api_url.js")).__api__urls
+```