Unity C# game jam

# AGENTS.md: Unity C# game jam

This is a Unity project for a game jam. A finished small game beats an unfinished big one.

## Jam rules
1. Core loop first: start → play → win/lose → restart. Nothing else until that works.
2. Offer the smallest version of any big request and park the rest in `CUTLIST.md`.
3. After the human calls feature freeze: bugs, juice, menus, audio and the build only.
4. Make a web build on day one (see the `unity-web-build` skill) so the final one is routine.

## The editor is part of the codebase
- You cannot see scenes, prefabs or inspector values. When a change needs editor work, say exactly what to do:
  "Select the Player prefab, add a `Health` component, set Max HP to 3".
- **Every asset has a `.meta` file holding its GUID.** When moving or renaming an asset outside Unity, move or rename
  its `.meta` with it, or references across the project break. Never delete `.meta` files. Prefer asking the human to
  rename in the Project window.
- Commit `Assets/`, `Packages/`, `ProjectSettings/`. Ignore `Library/`, `Temp/`, `Obj/`, `Logs/`, `UserSettings/`, `Build*/`.
- Renaming a serialised field loses its inspector value. Use `[FormerlySerializedAs("oldName")]` when renaming.

## C# conventions
- One `MonoBehaviour` per file; file name equals class name.
- Inspector fields: `[SerializeField] private float moveSpeed = 5f;` not public fields. Use `[Header]`, `[Range]`, `[Tooltip]`.
- Cache components in `Awake` (`rb = GetComponent<Rigidbody2D>();`). Use `[RequireComponent]` where a dependency is mandatory.
- Never call `GameObject.Find`, `FindObjectOfType`/`FindFirstObjectByType` or `GetComponent` inside `Update`.
- Physics in `FixedUpdate`; input and visuals in `Update`. Multiply by `Time.deltaTime` (or `fixedDeltaTime`) for frame-rate independence.
- Use `ScriptableObject` assets for tuning data (enemy stats, level settings) so designers tweak without code.
- Events: C# `event Action<int>` or `UnityEvent` for "something happened"; keep singletons to a GameManager and an AudioManager at most.
- Avoid per-frame allocations (LINQ, string concatenation, `new` lists in `Update`) — they cause stutters, especially on web.
- Object-pool anything spawned often (bullets, particles).
- Check which input system the project uses (`Packages/manifest.json` contains `com.unity.inputsystem`?) and stick to it.

## Before you say "done"
- Code compiles: ask the human to check the Console for errors, or run a batch-mode build.
- List the editor steps the human must do, numbered.

# CLAUDE.md

@AGENTS.md

## Claude Code notes
- Skills from this loadout live in `.claude/skills/`: `unity-web-build`. Use them when their description matches the task.
- Follow AGENTS.md above; where this file and AGENTS.md disagree, AGENTS.md wins.

<!-- From the Agent Loadout "Unity C# game jam" v1.0.0 — https://loadout.jnw-it.com/loadouts/unity-game-jam/ -->

# GEMINI.md

@./AGENTS.md

## Gemini CLI notes
- Skills from this loadout live in `.agents/skills/`: `unity-web-build`. Use them when their description matches the task.
- Follow AGENTS.md above; where this file and AGENTS.md disagree, AGENTS.md wins.

<!-- From the Agent Loadout "Unity C# game jam" v1.0.0 — https://loadout.jnw-it.com/loadouts/unity-game-jam/ -->

---
description: Unity C# script rules
globs: "Assets/**/*.cs"
alwaysApply: false
---

- `[SerializeField] private` for inspector fields, never public fields for tuning.
- Cache `GetComponent` results in `Awake`. No `Find*` or `GetComponent` calls in `Update`, `FixedUpdate` or `LateUpdate`.
- Rigidbody movement in `FixedUpdate`; read input in `Update`.
- No allocations in per-frame methods: no LINQ, no `new List<>`, no string building.
- File name must match the class name, or Unity cannot attach the script.
- When renaming a serialised field, add `[UnityEngine.Serialization.FormerlySerializedAs("oldName")]`.
- Editor-only code goes in an `Editor/` folder or inside `#if UNITY_EDITOR` so player builds do not break.
- Do not move or rename files without their `.meta` file.

---
name: unity-web-build
description: Build a Unity project for the web (WebGL) from the command line and prepare it for itch.io. Use when the user asks to build, export or upload their Unity game for the browser.
---

# Unity web build for itch.io

## 1. Add a build script (once)
Create `Assets/Editor/BuildScript.cs`:

```csharp
using System.Linq;
using UnityEditor;
using UnityEditor.Build.Reporting;
using UnityEngine;

public static class BuildScript
{
    public static void BuildWeb()
    {
        PlayerSettings.WebGL.compressionFormat = WebGLCompressionFormat.Gzip;
        PlayerSettings.WebGL.decompressionFallback = true; // works on hosts without Content-Encoding headers

        var scenes = EditorBuildSettings.scenes.Where(s => s.enabled).Select(s => s.path).ToArray();
        var report = BuildPipeline.BuildPlayer(new BuildPlayerOptions
        {
            scenes = scenes,
            locationPathName = "Build/Web",
            target = BuildTarget.WebGL,
            options = BuildOptions.None
        });

        Debug.Log($"Build {report.summary.result}: {report.summary.totalSize / (1024 * 1024)} MB");
        if (report.summary.result != BuildResult.Succeeded) EditorApplication.Exit(1);
    }
}
```

The human must have the **Web/WebGL Build Support** module installed for their editor version (Unity Hub → Installs → Add modules).
Scenes must be listed and ticked in Build Settings / Build Profiles.

## 2. Build in batch mode
Close the editor first (batch mode cannot open a project that is already open).

```sh
# Path to the editor varies: Unity Hub → Installs → ⋯ → Show in folder
"<path-to-Unity>" -batchmode -quit -projectPath . -executeMethod BuildScript.BuildWeb -logFile -
```
Exit code 0 means success. On failure, search the log for `error CS` (compile errors) or `Build Failed`.

## 3. Check and test
- `Build/Web` should contain `index.html`, `Build/` and `TemplateData/`.
- Serve locally (`npx serve Build/Web`) and ask the human to play for 30 seconds. Audio starts after the first click.
- If the build is over ~100 MB, suggest lowering texture max sizes and using compressed audio before upload.

## 4. Upload
- Zip the **contents** of `Build/Web` (so `index.html` is at the root of the zip), or use butler:
  `butler push Build/Web user/game-slug:html5`.
- On itch.io: Kind of project → HTML, tick "played in the browser", set the viewport to the canvas size, enable the fullscreen button.

## 5. Report
Build size, any warnings worth fixing, the upload channel, and the itch.io steps the human still needs to click.