Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 62 additions & 0 deletions .github/workflows/deploy-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: Deploy to GitHub Pages

on:
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 20

steps:
- name: Check out CPCJS
uses: actions/checkout@v7
with:
path: cpcjs

- name: Check out the Caprice32 web-compatible core
uses: actions/checkout@v7
with:
repository: smichea/caprice32
ref: agent/add-emscripten-yield
path: caprice32

- name: Set up Emscripten
uses: mymindstorm/setup-emsdk@v16
with:
version: latest
actions-cache-folder: emsdk-cache

- name: Build the browser emulator
run: npm run build
working-directory: cpcjs

- name: Configure GitHub Pages
uses: actions/configure-pages@v6

- name: Upload the Pages artifact
uses: actions/upload-pages-artifact@v5
with:
path: cpcjs/public

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
timeout-minutes: 10

steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v5
41 changes: 41 additions & 0 deletions .github/workflows/e2e.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: End-to-end tests

on:
push:
pull_request:

jobs:
playwright:
runs-on: ubuntu-latest
timeout-minutes: 30

steps:
- name: Check out CPCJS
uses: actions/checkout@v4
with:
path: cpcjs

- name: Check out the Caprice32 web-compatible core
uses: actions/checkout@v4
with:
repository: smichea/caprice32
ref: agent/add-emscripten-yield
path: caprice32

- name: Set up Emscripten
uses: mymindstorm/setup-emsdk@v14
with:
version: latest
actions-cache-folder: emsdk-cache

- name: Install JavaScript dependencies
run: npm ci
working-directory: cpcjs

- name: Install Chromium
run: npx playwright install --with-deps chromium
working-directory: cpcjs

- name: Run unit and end-to-end tests
run: npm test
working-directory: cpcjs
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
public/emulator/
node_modules/
npm-debug.log*
.tools/
playwright-report/
test-results/
4 changes: 4 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
This project is licensed under the GNU General Public License version 2.

The complete license text is available in the Caprice32 source tree at
../caprice32/COPYING.txt and at https://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
95 changes: 93 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,93 @@
# cpcjs
amstrad cpc emulator in js
# CPCJS

> [!WARNING]
> **Projet en construction.** Le port de l’émulateur est encore expérimental
> et n’est pas fonctionnel pour le moment. Il n’est pas encore possible de
> jouer correctement à des jeux CPC dans le navigateur.

CPCJS est le port navigateur de [Caprice32](https://github.com/ColinPitrat/caprice32).
Le cœur C++ original est compilé en WebAssembly et JavaScript avec Emscripten;
SDL2 relie l’écran, le son, le clavier et les manettes aux API du navigateur.

Formats acceptés: DSK, SNA, CDT, VOC, CPR, IPF, RAW et ZIP.

## Prérequis

- Emscripten (`em++` dans le `PATH`)
- Node.js 18 ou supérieur
- les sources Caprice32 dans `../caprice32`, ou leur chemin dans
`CAPRICE32_DIR`

Sur Ubuntu/Debian, Emscripten peut être installé avec:

```sh
sudo apt install emscripten
```

## Construire et jouer

```sh
npm run build
npm run serve
```

Ouvrir ensuite <http://localhost:8080>, choisir une image de jeu, puis cliquer
dans l’écran pour donner le focus au clavier. Le son démarre après cette action
utilisateur, conformément aux règles des navigateurs.

Le build produit `public/emulator/caprice32.js`, `caprice32.wasm` et le paquet de
données préchargé. Ces artefacts ne sont pas versionnés. Le navigateur doit être
servi via HTTP; ouvrir directement `index.html` avec `file://` ne fonctionne pas.

## Contrôles

- clavier CPC: clavier physique
- joystick: flèches, `Z` et `X`
- menu Caprice32: `F1`
- plein écran: bouton de l’interface ou `Ctrl` + `Entrée`

Pour changer de disque après le démarrage, utilisez le menu Caprice32 (`F1`).
Pour démarrer directement avec une autre image, rechargez la page.

## Tests

Installer Chromium pour Playwright une première fois, puis lancer la suite:

```sh
npm install
npx playwright install chromium
npm test
```

`npm test` reconstruit le module WebAssembly, puis valide dans un vrai Chromium
headless les deux parcours suivants:

- démarrage du CPC 6128 sans image, affichage vidéo et progression des frames;
- chargement de l’image disque de test, saisie de `RUN"HELLO` et exécution du
programme BASIC jusqu’à la modification effective de l’écran et la sortie
exacte `Hello, World !` sur le port imprimante émulé.

La fixture est issue des tests intégrés GPL-2.0 de Caprice32. Ces scénarios
valident le pipeline navigateur de bout en bout; ils ne signifient pas encore
que l’ensemble du catalogue de jeux CPC est compatible.

## Déployer manuellement sur GitHub Pages

Une seule fois, ouvrir **Settings → Pages → Build and deployment** dans le
dépôt GitHub et choisir **GitHub Actions** comme source.

Pour chaque déploiement:

1. ouvrir l’onglet **Actions** du dépôt;
2. choisir le workflow **Deploy to GitHub Pages**;
3. cliquer sur **Run workflow**, sélectionner la branche à publier, puis
confirmer avec **Run workflow**.

Le workflow reconstruit Caprice32 en WebAssembly, publie le contenu de
`public/` et affiche l’URL du site dans le job `deploy`. Il est uniquement
déclenché à la demande et ne déploie rien automatiquement lors d’un push.

## Licence

Caprice32 et ce port sont distribués sous GPL-2.0. Les ROM incluses dans le
dépôt Caprice32 sont empaquetées au moment du build.
79 changes: 79 additions & 0 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"name": "cpcjs",
"version": "0.1.0",
"private": true,
"type": "module",
"description": "Caprice32 port for playing Amstrad CPC software in a browser",
"scripts": {
"build": "./scripts/build.sh",
"serve": "npx --yes serve public -l 8080",
"test": "npm run test:unit && npm run test:e2e",
"test:unit": "node --test test/*.test.mjs",
"test:e2e": "npm run build && playwright test",
"test:e2e:only": "playwright test"
},
"devDependencies": {
"@playwright/test": "^1.62.1"
},
"license": "GPL-2.0-only",
"devDependencies": {
"@playwright/test": "^1.62.1"
}
}
21 changes: 21 additions & 0 deletions playwright.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { defineConfig, devices } from '@playwright/test';

export default defineConfig({
testDir: './test/e2e',
fullyParallel: false,
workers: 1,
timeout: 45_000,
expect: { timeout: 15_000 },
use: {
...devices['Desktop Chrome'],
baseURL: 'http://127.0.0.1:4173',
trace: 'retain-on-failure',
screenshot: 'only-on-failure'
},
webServer: {
command: 'npx serve public -l 4173 --no-clipboard',
url: 'http://127.0.0.1:4173',
reuseExistingServer: false,
timeout: 30_000
}
});
37 changes: 37 additions & 0 deletions public/app.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
:root {
color-scheme: dark;
font-family: Inter, ui-sans-serif, system-ui, sans-serif;
background: #090d18;
color: #edf3ff;
}

* { box-sizing: border-box; }
body { margin: 0; min-height: 100vh; background: radial-gradient(circle at 50% -20%, #26395f, #090d18 55%); }
button, .file-button { font: inherit; }
.shell { width: min(1040px, 94vw); margin: 0 auto; padding: 36px 0 50px; }
header { display: flex; justify-content: space-between; align-items: end; margin-bottom: 18px; }
.eyebrow { margin: 0 0 4px; color: #7fd5ff; letter-spacing: .2em; font: 700 11px/1.2 ui-monospace, monospace; }
h1 { margin: 0; font-size: clamp(38px, 7vw, 68px); line-height: .9; letter-spacing: -.06em; }
h1 span { color: #ffcc45; }
.status { margin: 0; padding: 8px 12px; border: 1px solid #314361; border-radius: 999px; color: #aebbd0; font-size: 13px; }
.status[data-state="ready"] { color: #88efbd; border-color: #246044; }
.status[data-state="running"] { color: #7fd5ff; border-color: #245b75; }
.status[data-state="error"] { color: #ff9e9e; border-color: #713636; }
.machine { padding: clamp(12px, 2.2vw, 24px); border: 1px solid #314361; border-radius: 22px; background: linear-gradient(145deg, #1a2437, #101724); box-shadow: 0 30px 80px #0009; }
.screen-frame { position: relative; overflow: hidden; aspect-ratio: 768/540; border: 12px solid #05070c; border-radius: 10px; background: #000; }
canvas { display: block; width: 100%; height: 100%; outline: none; image-rendering: pixelated; }
.screen-message { position: absolute; inset: 0; display: grid; place-content: center; gap: 8px; text-align: center; background: radial-gradient(circle, #14264a, #050811 72%); color: #93a9cc; }
.screen-message strong { color: #f5f8ff; font-size: clamp(20px, 4vw, 34px); }
.screen-message[hidden] { display: none; }
.controls { display: flex; flex-wrap: wrap; gap: 10px; margin-top: 18px; }
#game-file { position: absolute; inline-size: 1px; block-size: 1px; opacity: 0; }
button, .file-button { border: 1px solid #3c506e; border-radius: 9px; padding: 11px 16px; background: #19253a; color: #eaf1ff; cursor: pointer; transition: .15s ease; }
button:hover:not(:disabled), .file-button:hover { transform: translateY(-1px); background: #22334f; }
.file-button { background: #ffd04d; border-color: #ffd04d; color: #171204; font-weight: 800; }
button:disabled { opacity: .45; cursor: default; }
.help { display: grid; grid-template-columns: repeat(4, 1fr); gap: 10px; margin-top: 14px; }
.help div { display: flex; align-items: center; gap: 6px; min-height: 56px; padding: 10px; border: 1px solid #263650; border-radius: 10px; color: #9fafc7; font-size: 12px; }
kbd { padding: 4px 6px; border: 1px solid #465a79; border-bottom-width: 3px; border-radius: 5px; background: #182235; color: #fff; font: 700 11px ui-monospace, monospace; }
details { margin-top: 16px; color: #8697b1; font-size: 13px; }
pre { max-height: 220px; overflow: auto; padding: 14px; border-radius: 8px; background: #05070c; white-space: pre-wrap; }
@media (max-width: 720px) { header { align-items: start; flex-direction: column; gap: 14px; } .help { grid-template-columns: 1fr 1fr; } }
Loading
Loading