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
2 changes: 1 addition & 1 deletion Directory.Build.props
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<NuGetAudit>false</NuGetAudit>
<!-- The SDK version (docs/guide/sdk.md): Alpha, 0.x; incompatible API changes may happen between Alpha versions.
Engine assemblies carry it and every demo package records it. Games set their own <Version>. -->
<MicroEngineVersion>0.5.0-alpha.2</MicroEngineVersion>
<MicroEngineVersion>0.6.0-alpha.1</MicroEngineVersion>
<Version>$(MicroEngineVersion)</Version>
</PropertyGroup>
<!-- Browser packages are published (web/build.sh passes MicroEngineWebPackage=true): the engine and games they
Expand Down
2 changes: 1 addition & 1 deletion docs/api/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API reference

The public types of the MicroEngine SDK 0.5.0-alpha.2, one page per namespace and per type: signatures, parameters, default
The public types of the MicroEngine SDK 0.6.0-alpha.1, one page per namespace and per type: signatures, parameters, default
values and the descriptions written in the engine's source. It covers the four engine packages (`MicroEngine`,
`MicroEngine.Sdl`, `MicroEngine.Raylib`, `MicroEngine.Desktop`); the `microengine` tool is documented in
[The microengine tool](../guide/cli.md).
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/hello-engine.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ folder builds anywhere:
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>
</Project>
```
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/first-game.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ template's files, with `MyGame` where your project's name goes.
</Project>
```

In your project `MICROENGINE_VERSION` is the tool's version (`0.5.0-alpha.2`). The second group is the game's
In your project `MICROENGINE_VERSION` is the tool's version (`0.6.0-alpha.1`). The second group is the game's
identity: every package `microengine package` builds takes its name, id, version, icon and orientation from there, and
nowhere else. The browser, Android and iOS hosts call the game's `Configure` entry point (below), the same one
`Program.cs` uses, so there is nothing to keep in step.
Expand Down
8 changes: 4 additions & 4 deletions docs/guide/getting-microengine.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ packages on [nuget.org](https://www.nuget.org/packages/MicroEngine): the engine,
`microengine` command-line tool and a project template. This page installs them and checks that everything works; the next page,
[Your first game](first-game.md), creates and runs a game.

The current version is **0.5.0-alpha.2**, an Alpha pre-release ([Versions and compatibility](sdk.md)). Because it is a
The current version is **0.6.0-alpha.1**, an Alpha pre-release ([Versions and compatibility](sdk.md)). Because it is a
pre-release, NuGet commands need `--prerelease` or the exact version.

Only want to play the demos? They are on the [demo pages](/demos/), in the browser and as downloads
Expand All @@ -32,20 +32,20 @@ dotnet tool install -g MicroEngine.Cli --prerelease
microengine version
```

`microengine version` prints `0.5.0-alpha.2`. The tool creates, runs, builds and packages games
`microengine version` prints `0.6.0-alpha.1`. The tool creates, runs, builds and packages games
([The microengine tool](cli.md)).

If the shell says `microengine` is not found, the folder of .NET global tools is not on your `PATH`: add
`%USERPROFILE%\.dotnet\tools` (Windows) or `~/.dotnet/tools` (Linux, macOS) to it and open a new terminal. To install
an exact version instead of the newest pre-release: `dotnet tool install -g MicroEngine.Cli --version 0.5.0-alpha.2`.
an exact version instead of the newest pre-release: `dotnet tool install -g MicroEngine.Cli --version 0.6.0-alpha.1`.

## 3. The project template

`microengine new` installs the template (`MicroEngine.Templates`) at the tool's own version the first time it runs, so
there is nothing to do. To install it yourself, for example to use `dotnet new` or an IDE's "New project" dialog:

```bash
dotnet new install MicroEngine.Templates::0.5.0-alpha.2
dotnet new install MicroEngine.Templates::0.6.0-alpha.1
dotnet new microengine-game -n StarCourier --app-id com.yourstudio.starcourier --title "Star Courier"
```

Expand Down
2 changes: 1 addition & 1 deletion docs/guide/project-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ samples/HelloEngine/
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>
</Project>
```
Expand Down
8 changes: 5 additions & 3 deletions docs/guide/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ One section per SDK version, newest first. The SDK is in Alpha: a version may ch
every such change is in the [migration notes](../migrations.md). Releases are tagged `sdk-v<version>`; the demo
releases (`v0.1.0`, `v0.2.0`...) are separate.

## Next release
## 0.6.0-alpha.1

An eighth package: `MicroEngine.Physics.Box2D`, optional, for dynamic bodies.
An eighth package: `MicroEngine.Physics.Box2D`, optional, for dynamic bodies. Diagnostics for finding out why a game
misbehaves, and packaging with a .NET SDK newer than 10. The UI components and the project property deprecated earlier
are removed: read the [migration notes](../migrations.md#060-alpha1) before updating.

**New**

Expand Down Expand Up @@ -45,7 +47,7 @@ An eighth package: `MicroEngine.Physics.Box2D`, optional, for dynamic bodies.

- `DialogueBox`, `Typewriter`, `SelectionList`, `Toasts`, `Toast`, `AchievementToasts`, `AchievementsScene`,
`Game.UseAchievements` and `Game.AchievementToasts`, deprecated in 0.5.0-alpha.2. Build them from widgets and call
`TrackAchievements` ([migration notes](../migrations.md#next-release)).
`TrackAchievements` ([migration notes](../migrations.md#060-alpha1)).
- The `MicroEngineGameFactory` project property, deprecated in 0.5.0-alpha.1. `microengine package` builds browser,
Android and iOS packages from the game's `Configure(HostBuilder)` entry point only, and stops with the method to add
when a game has none. The tutorial's Gem Garden declares the entry point from its first step.
Expand Down
4 changes: 2 additions & 2 deletions docs/guide/sdk.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Versions and compatibility

**MicroEngine SDK 0.5.0-alpha.2 — Alpha.** It is on nuget.org: [`MicroEngine.Cli`](https://www.nuget.org/packages/MicroEngine.Cli)
**MicroEngine SDK 0.6.0-alpha.1 — Alpha.** It is on nuget.org: [`MicroEngine.Cli`](https://www.nuget.org/packages/MicroEngine.Cli)
and the five other packages below ([release notes](release-notes.md)). [Getting MicroEngine](getting-microengine.md)
shows how to install it.

Expand Down Expand Up @@ -49,6 +49,6 @@ One part of the engine stays out of every published package: the 3D path

## Published version and development

The documentation describes the published SDK, **0.5.0-alpha.2**, and every code sample on this site is built against
The documentation describes the published SDK, **0.6.0-alpha.1**, and every code sample on this site is built against
the packages on nuget.org. The documentation and the SDK are published together, so a page never describes an engine
the packages do not have.
2 changes: 1 addition & 1 deletion docs/guide/status.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# What MicroEngine offers today

**MicroEngine SDK 0.5.0-alpha.2.** A working 2D engine for .NET 10, open source under the MIT License, installed from
**MicroEngine SDK 0.6.0-alpha.1.** A working 2D engine for .NET 10, open source under the MIT License, installed from
nuget.org ([Getting MicroEngine](getting-microengine.md)). Games built with it run on Windows, Linux, macOS, Android,
iOS and in web browsers. It is in Alpha: public APIs may still change between 0.x versions ([Versions](sdk.md)).

Expand Down
10 changes: 5 additions & 5 deletions docs/guide/updating.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,24 +17,24 @@ The [release notes](release-notes.md) say what each version adds, changes and fi

```bash
dotnet tool update -g MicroEngine.Cli --prerelease
dotnet new install MicroEngine.Templates::0.5.0-alpha.2
dotnet new install MicroEngine.Templates::0.6.0-alpha.1
```

Replace `0.5.0-alpha.2` with the version you are moving to. The template only matters for new projects:
Replace `0.6.0-alpha.1` with the version you are moving to. The template only matters for new projects:
`microengine new` installs the template of the tool's version when it is missing.

## 3. Update the game's packages

In the game's project file, set every `MicroEngine.*` package to the same version as the tool:

```xml
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
```

or let `dotnet` edit the file:

```bash
dotnet add package MicroEngine.Desktop --version 0.5.0-alpha.2
dotnet add package MicroEngine.Desktop --version 0.6.0-alpha.1
```

## 4. Read the migration notes, build and test
Expand All @@ -57,7 +57,7 @@ for that game only, as a local tool:

```bash
dotnet new tool-manifest
dotnet tool install MicroEngine.Cli --version 0.5.0-alpha.2
dotnet tool install MicroEngine.Cli --version 0.6.0-alpha.1
dotnet tool run microengine version
```

Expand Down
2 changes: 1 addition & 1 deletion docs/manual/text.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ TTF/OTF font whose text is shaped by HarfBuzz, the shaping engine browsers and o
next to the engine:

```xml
<PackageReference Include="MicroEngine.Text.Shaping" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Text.Shaping" Version="0.6.0-alpha.1" />
```

It is a package of its own because HarfBuzz is a native library: games that only write Latin text do not carry it.
Expand Down
2 changes: 1 addition & 1 deletion docs/manual/world.md
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ games that need what the tile backend refuses: dynamic bodies, rotation, circles
collision, friction and mass. It is an optional package; the tile backend needs none:

```xml
<PackageReference Include="MicroEngine.Physics.Box2D" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Physics.Box2D" Version="0.6.0-alpha.1" />
```

Choose the backend where the world is made; code that uses only the core then runs on either. Keep the tile backend
Expand Down
2 changes: 1 addition & 1 deletion docs/migrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ What changes between SDK versions and how to update a game. MicroEngine is in Al
a version may change public APIs incompatibly, and when it does, the change is listed here with the version that makes
it. Newest first.

## Next release
## 0.6.0-alpha.1

### Removed UI components

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/01-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ GemGarden/
<ItemGroup>
<!-- The engine with the desktop platforms (SDL 3 by default, raylib). A game that ships SDL only can reference
MicroEngine.Sdl instead. -->
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>

<ItemGroup>
Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/12-packaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ it by) comes from the second group of the project file. For the release, set the
<ItemGroup>
<!-- The engine with the desktop platforms (SDL 3 by default, raylib). A game that ships SDL only can reference
MicroEngine.Sdl instead. -->
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>

<ItemGroup>
Expand Down Expand Up @@ -69,7 +69,7 @@ Orientation landscape
Factory new GemGarden.MainGame()
Content ...\GemGarden\Content\
Licence (none)
Engine MicroEngine 0.5.0-alpha.2, net10.0
Engine MicroEngine 0.6.0-alpha.1, net10.0
```

`Licence (none)`: a `LICENSE`, `LICENSE.txt` or `LICENSE.md` file next to the project is shipped in every package as
Expand Down
2 changes: 1 addition & 1 deletion samples/AssetGallery/AssetGallery.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,6 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>
</Project>
4 changes: 2 additions & 2 deletions samples/Examples/Examples.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
</PropertyGroup>

<ItemGroup>
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
<!-- Shaped text for the right-to-left example: optional, with HarfBuzz. -->
<PackageReference Include="MicroEngine.Text.Shaping" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Text.Shaping" Version="0.6.0-alpha.1" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion samples/GemGarden/part1-scenes/GemGarden.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<ItemGroup>
<!-- The engine with the desktop platforms (SDL 3 by default, raylib). A game that ships SDL only can reference
MicroEngine.Sdl instead. -->
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion samples/GemGarden/part2-hero/GemGarden.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<ItemGroup>
<!-- The engine with the desktop platforms (SDL 3 by default, raylib). A game that ships SDL only can reference
MicroEngine.Sdl instead. -->
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion samples/GemGarden/part3-garden/GemGarden.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<ItemGroup>
<!-- The engine with the desktop platforms (SDL 3 by default, raylib). A game that ships SDL only can reference
MicroEngine.Sdl instead. -->
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion samples/GemGarden/part4-complete/GemGarden.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<ItemGroup>
<!-- The engine with the desktop platforms (SDL 3 by default, raylib). A game that ships SDL only can reference
MicroEngine.Sdl instead. -->
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion samples/HelloEngine/HelloEngine.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@
<ImplicitUsings>enable</ImplicitUsings>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
</ItemGroup>
</Project>
4 changes: 2 additions & 2 deletions samples/PhysicsSubstitution/PhysicsSubstitution.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
<Description>One platformer's gameplay code on two physics backends.</Description>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="MicroEngine.Desktop" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Physics.Box2D" Version="0.5.0-alpha.2" />
<PackageReference Include="MicroEngine.Desktop" Version="0.6.0-alpha.1" />
<PackageReference Include="MicroEngine.Physics.Box2D" Version="0.6.0-alpha.1" />
</ItemGroup>
</Project>
2 changes: 1 addition & 1 deletion sdk/version.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
"documented": "0.5.0-alpha.2"
"documented": "0.6.0-alpha.1"
}
Loading