Files
prometeu-studio/README.md
T
bquarkz 2d8f6436e4
Test / Tests and coverage
Intrepid/Prometeu/Studio/pipeline/head This commit looks good
feat(studio): refine Play workspace and project preferences (WRK-001D)
2026-11-22 15:45:09 +00:00

123 lines
5.7 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Prometeu Studio
Prometeu Studio is the desktop development environment for the Prometeu toolchain.
It combines a JavaFX application with compiler integration, asset packing, project
services and runtime orchestration in a multi-module Java/Gradle build.
## Requirements
- JDK 25 for compilation, tests and the bundled application runtime
- The included Gradle wrapper (Gradle 9.3.1)
- A desktop environment capable of running JavaFX
- A qualified native Prometeu runtime installation for running games
## Getting Started
Run these commands from the Studio repository root:
```bash
./gradlew :prometeu-app:run
```
`./gradlew run` from this repository root also starts only the product. The
standalone foundation shell is an explicit developer command,
`./gradlew :prometeu-studio-ui-javafx-2:run`; it does not open after Studio exits.
The project chooser contains project commands and a Prometeu Studio menu. Open
**Prometeu Studio > Preferences** for language, theme, typeface, text scale and the default
runtime installation. Closing the chooser exits Studio without opening a shell.
Open an existing project and use the global **Play/Stop** button and separate
**Pause/Resume** toggle. **Project > Settings** contains an optional
runtime override and memory card settings. Projects inherit the Studio runtime
when the override is empty. Games with saves require an existing development save
image or an explicitly disposable session; disposable mode resets when the project
closes. Use **Project > Close project** before opening another project.
The top controls stay on the right, leaving room for menus; project information
appears in the compact header.
The workspace has balanced space above and below the tabs, with the active tab's
gold outline enclosing its content.
The **Gameplay** tab fits the image to its available surface. The footer follows
the selected tab and shows Gameplay's effective scale. Enable **Manual scale** for
a 25–400% slider; oversized manual images scroll.
Drag the divider between game and logs to give either region more room. Automatic
scale follows the available game area; manual scale keeps your chosen size.
Window position, normal size and maximization are remembered for the project
chooser and separately for each project.
The default frontend is `prometeu-studio-ui-javafx-2`. It provides project opening
and integrated Play; editors, Assets/DEV/Shipper workspaces and MCP grant controls
are outside its current UI. Play prepares a cartridge directory for execution;
distribution/export is a separate concern.
See the [development guide](docs/development.md) for installation, runtime
qualification, IntelliJ setup, MCP integration and integration test commands.
The [integrated Play specification](docs/specs/studio/14.%20Integrated%20Play%20Specification.md)
defines execution, input and save behavior.
## Build and Test
```bash
./gradlew build
./gradlew test
./gradlew jacocoTestReport
```
`test` runs unit tests and excludes JUnit `@Tag("integration")`. The aggregated
JaCoCo report uses unit test results. Process, network and desktop checks have
[separate opt-in commands](docs/development.md#integration-checks).
Stage a complete installation with its bundled Java runtime:
```bash
./gradlew :prometeu-app:stageStudioInstallation
```
The default installation root is
`~/Library/Application Support/Prometeu/Studio`; `current` selects its active
version. See [installation and development](docs/development.md#installation-and-intellij-development)
for an isolated development installation.
## Repository Structure
| Area | Responsibility |
| --- | --- |
| `prometeu-app` | Spring Boot composition, concrete adapters, packaging and the `p.studio.app.StudioLauncher` entry point |
| `prometeu-studio-api` | Toolkit-neutral Studio contracts and operations |
| `prometeu-studio-core` | JavaFX-free project, session, asset, shipper and execution services |
| `prometeu-studio-ui-javafx-2` | Default frontend and presentation foundation |
| `prometeu-studio-ui-javafx` | Previous frontend retained for adapter compatibility checks |
| `prometeu-compiler` | Compiler core, build pipeline, frontend APIs and PBS frontend |
| `prometeu-packer` | Asset packing APIs and implementation |
| `prometeu-infra` | Shared infrastructure |
| `test-projects` | Sample projects and integration fixtures |
| `docs` | Technical guides, specifications and architecture references |
| `discussion/lessons` | Published engineering lessons and their assets |
Run `./gradlew projects` to list the complete module graph.
Start with `prometeu-app` for application bootstrap, then read
`prometeu-studio-api` and `prometeu-studio-core` for contracts and services.
The [JavaFX 2 module guide](prometeu-studio-ui-javafx-2/README.md) covers the current
frontend. Follow the compiler and packer modules for their respective pipelines.
<a id="external-coding-agents-mcp"></a>
## Documentation
- [Development guide](docs/development.md): installation, MCP, troubleshooting and integration checks
- [Specification guide](docs/specs/README.md): domain ownership and reading order
- [Studio](docs/specs/studio/README.md): application, services and integration contracts
- [Compiler](docs/specs/compiler/README.md): shared compiler contracts
- [PBS](docs/specs/compiler-languages/pbs/README.md): language and SDK
- [Packer](docs/specs/packer/README.md): asset and packaging contracts
- [VM architecture](docs/vm-arch/README.md): VM/ISA references and provenance
- [VS Code extension](tools/vscode-extension/README.md): language tooling and external source navigation
Engineering discussions, decisions, plans, build/acceptance results and pending
investigations belong to the enclosing
[Prometeu Engineering workspace](../README.md) in
[AI Engineering](../.ai-engineering/README.md). See [AGENTS.md](AGENTS.md) before
contributing.