Pyline !

Author: LBO44

.github/workflows/main.yml

@@ -0,0 +1,63 @@
+name: Sync Engine
+
+on:
+  workflow_dispatch:
+  push:
+      branches:
+        - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+        with:
+          version: "latest"
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Build engine
+        run: uv run sonolus-py build
+
+      - name: Upload engine artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: pyline-engine
+          path: build/dist/engine/
+
+      - name: Checkout Server Repo
+        uses: actions/checkout@v4
+        with:
+          repository: LBO44/Sonolus-Rizline-Server
+          token: ${{ secrets.SERVER_REPO_TOKEN }}
+          path: server
+          sparse-checkout: |
+            engine
+          sparse-checkout-cone-mode: false
+
+      - name: Copy Engine Assets
+        run: |
+          mkdir server/engine/data -p
+          cp build/dist/engine/EnginePlayData server/engine/data/playData
+          cp build/dist/engine/EngineWatchData server/engine/data/watchData
+          cp build/dist/engine/EnginePreviewData server/engine/data/previewData
+          cp build/dist/engine/EngineTutorialData server/engine/data/tutorialData
+          cp build/dist/engine/EngineConfiguration server/engine/data/configuration
+          cp build/dist/engine/EngineRom server/engine/data/rom
+
+          cp -r convert/. server/engine/
+
+      - name: Commit Updated Engine to Server Repo
+        working-directory: server
+        run: |
+          git config --global user.name "github-actions"
+          git config --global user.email "actions@github.com"
+          git add --sparse .
+          git commit -m "Update engine assets with ${GITHUB_SHA}"
+          git push

.gitignore

@@ -0,0 +1,15 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+
+# generated resources
+resources/skins/
+resources/particles/
+resources/levels/*/data.json

README.md

@@ -0,0 +1,59 @@
+<h1 align=center>Sonolus Rizline Engine</h1>
+
+![Banner Image](https://github.com/user-attachments/assets/f346d82d-f1fb-4ce0-92cd-85b346e374bf)
+<p align="center">My recreation of <b>Rizline</b> in <a href="https://sonolus.com/">Sonolus</a> using <a href="https://sonolus.py.qwewqa.xyz/">Sonolus.py</a>.</p>
+
+**Try it now at: https://sonolus-rizline.vercel.app/ !**
+Currently featuring play and watch mode.
+
+## Quick Dev Setup
+1. Install [uv](https://docs.astral.sh/uv/), run `uv sync`.
+2. To add Rizline levels, copy one of the existing `resources/levels` folder, modify `item.json` with the new level name and change `chart.json` to the corresponding Rizline chart file.
+3. Convert Rizline chart to Sonolus data and generate corresponding skin and particle by running `convert/generate_resources.ts`, [pngjs](https://www.npmjs.com/package/pngjs) is used to generate skin textures.
+4. [Ensure your venv is activated](https://docs.astral.sh/uv/pip/environments/#using-a-virtual-environment).
+5. Run `sonolus-py dev`.
+
+
+## Custom Resources
+
+### Skin Sprites
+Since Sonolus doesn't have any way of drawing sprites with a custom colour, we need to generate and use a different skin texture for each level to match Rizline's levels colours.
+Some sprites have variation for normal and challenge time, like `Background Normal` | `Background Challenge`
+
+| Name                                            |
+| ----------------------------------------------- |
+| `Background Normal` \| `Challenge`              |
+| `Background Circle Normal` \| `Challenge`       |
+| `Fade Out Spawn`                                |
+| `Fade Out Judge`                                |
+| `Drag Note`                                     |
+| `Hold Note`                                     |
+| `Tap Note Normal` \| `Challenge`                |
+| `Hold Head Normal` \| `Challenge`               |
+| `Hold Head Decorator Normal` \| `Challenge`     |
+| `Hold Connector Normal` \| `Challenge`          |
+| `Hold Connector Fade Out Normal` \| `Challenge` |
+| `Miss Effect Overlay`                           |
+| `Miss Effect Cross`                             |
+| `Line Color 0`, …,`Line Color 31`               |
+| `Judge Ring Color 0`, …, `Judge Ring Color 31`  |
+| `Judge Ring Background`                         |
+| `Line Background`                               |
+
+### Particles
+Unlike with Skin we can change the colours by only modifying the data.
+
+| Name                            |
+| ------------------------------- |
+| `Hit Normal` \| `Hit Challenge` |
+| `Hit Challenge Extension`       |
+| `Bad`                           |
+
+### Effect Clips
+Default Sonolus effect names are used, however only `#PERFECT` (for Tap and Hold Start notes) and `#GREAT` (for Drag notes) are used.
+
+## Links
+- [Rhythm Game Wiki: Rizline](https://rgwiki.stary.pc.pl/wiki/Rizline), useful informations about Rizline files.
+- [Rizlib](https://gitlab.com/TadeLn/rizlib), Rust library to interact with the game files.
+- [Sonolus Website](https://sonolus.com/)
+- This repository is based on [Sonolus.py Template](https://github.com/qwewqa/sonolus.py-template-project)