Skip to content

Commit

Permalink
Clean up some old things
Browse files Browse the repository at this point in the history
- API 10 was released
- API 9 is now legacy
- Fix some broken links
- We're on .NET 8 now
  • Loading branch information
KazWolfe committed Aug 12, 2024
1 parent 0111cfc commit 162bea4
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 40 deletions.
2 changes: 1 addition & 1 deletion docs/building/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ environment and building Dalamud.
- [Visual Studio 2022](https://visualstudio.microsoft.com/vs/)
- Both the "Desktop Development with C++" and "Desktop Development with .NET"
workloads are required.
- [.NET 7.0 SDK](https://dotnet.microsoft.com/download/dotnet/7.0)
- [.NET 8.0 SDK](https://dotnet.microsoft.com/download/dotnet/8.0)
- This is included with Visual Studio 2022, but you can also install it
separately if desired.
- [Git](https://git-scm.com/downloads)
Expand Down
9 changes: 5 additions & 4 deletions docs/plugin-development/reverse-engineering/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,11 @@ used to automatically generate one.

### Using Game Functions

There are two major ways that a developer can use a function: \[creating a hook]
(interaction/expanding-game-events.md) to intercept a function, or
[creating a delegate](interaction/calling-game-code.md) to use that function
from their plugin.
There are two major ways that a developer can use a function:
[creating a hook](../interaction/expanding-game-events.md#hooking-functions) to
intercept a function, or
[creating a delegate](../interaction/calling-game-code.md#delegating-with-sigscanner)
to use that function from their plugin.

Developers will use hooks when they want to intercept, modify, cancel, or
otherwise act upon a function call. For example, a plugin that wants to know
Expand Down
21 changes: 8 additions & 13 deletions docs/versions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,11 @@ Dalamud has two major concepts in terms of versioning: **API Level** and

## Summary

| Channel | Branch | API Level | Stability | Recommended For |
| ------- | -------- | --------- | --------- | --------------------------------------------------------- |
| Release | `master` | 8 | Highest | Auto-assigned to most users |
| Canary | `master` | 8 | Very High | Auto-assigned to a small number of users |
| Staging | `master` | 8 | Medium | Core/plugin developers, testing-inclined users |
| v9 | `v9` | 9 | Low | Core/plugin developers who want to get a head start on v9 |
| Channel | Branch | API Level | Stability | Recommended For |
| ------- | -------- | --------- | --------- | ---------------------------------------------- |
| Release | `master` | 10 | Highest | Auto-assigned to most users |
| Canary | `master` | 10 | Very High | Auto-assigned to a small number of users |
| Staging | `master` | 10 | Medium | Core/plugin developers, testing-inclined users |

## API Level

Expand All @@ -26,8 +25,7 @@ API Level will not work with newer versions of Dalamud.

For Dalamud v9 and higher, the API Level will _always_ match the major version
number - i.e. Dalamud 9.0.0 will have API Level 9, Dalamud 10.0.0 will have API
Level 10, etc. For the current release version of Dalamud (7.x), the current API
level is 8.
Level 10, etc.

Before Dalamud v9, the API level did not have a direct relation to the Dalamud
version. The API level was incremented whenever a breaking change was made to
Expand All @@ -49,6 +47,8 @@ level.

| API Level | First Dalamud Version | First Game Version | .NET Version | First Commit |
| --------- | --------------------- | ------------------ | ------------ | ------------------------------------------------------------------------------------------------- |
| 10 | 10.0.0.0 | Patch 7.0 | .NET 8.0 | [2024-07-05](https://github.com/goatcorp/Dalamud/releases/tag/10.0.0.0) |
| 9 | 9.0.0.0 | Patch 6.5 | .NET 7.0 | [2023-10-05](https://github.com/goatcorp/Dalamud/releases/tag/9.0.0.1) |
| 8 | 7.4.0.0 | Patch 6.3 | .NET 7.0 | [2023-01-10](https://github.com/goatcorp/Dalamud/commit/251359abe92ed805f1163f1a9da28a0aa4f891cb) |
| 7 | 7.0.0.0 | Patch 6.2 | .NET 6.0 | [2022-08-23](https://github.com/goatcorp/Dalamud/commit/6692d560296baab7758a372df10794cdf3717c17) |
| 6 | 6.4.0.0 | Patch 6.1 | .NET 5.0 | [2022-04-13](https://github.com/goatcorp/Dalamud/commit/d9f3800257fe1fa5621b9c13028c06911555889c) |
Expand Down Expand Up @@ -87,10 +87,6 @@ time through the "Branch Switcher" option in the `/xldev` > `Dalamud` menu.
- **Staging (`stg`)**: This channel is updated with the latest commits to
`master`, before a release version is tagged. New features are made available
here before being moved to Canary/Release.
- **v9**: This channel tracks the latest commits to the `v9` branch. This branch
is the current development branch for Dalamud v9, and is recommended only for
developers to use, as it has breaking changes (including an API level bump).
[You can view information on what's new in v9 here.](v9)

### Branches

Expand All @@ -102,4 +98,3 @@ The current main branches are:

- `master`: The main development branch for Dalamud. This branch is used for all
releases, and is the default branch for all pull requests.
- `v9`: The development branch for Dalamud v9.
17 changes: 4 additions & 13 deletions docs/versions/v10.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,14 @@
# What's New in Dalamud v10

:::warning

Dalamud v10 is still under active development. This list is not yet exhaustive
and will be appended as we get closer to the intended release date.

:::

Dalamud v10 is the next major version of Dalamud, to be released together with
Patch 7.0. This is a high-level overview of changes. You can see a code diff of
all of these changes
[here.](https://github.com/goatcorp/dalamud/compare/master...apiX)
Dalamud v10 is the current major version of Dalamud, and was released with Patch
7.0. This is a high-level overview of changes. You can see a code diff of all of
these changes [here.](https://github.com/goatcorp/dalamud/compare/master...apiX)

## Key Information

- **Branch:** `apiX`
([view on GitHub](https://github.com/goatcorp/Dalamud/tree/apiX))
- **Release Date:** Targeted to release alongside Patch 7.0 (estimated June
2024).
- **Release Date:** July 5, 2024
- **API Level:** 10
- **.NET Version:** .NET 8.0

Expand Down
13 changes: 4 additions & 9 deletions docs/versions/v9.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# What's New in Dalamud v9

Dalamud v9 is the next major version of Dalamud, to be released together with
Patch 6.5. This is a high-level overview of changes. You can see a code diff of
all of these changes
[here.](https://github.com/goatcorp/dalamud/compare/master...v9)
Dalamud v9 was a prior version of Dalamud, released together with Patch 6.5.
This is a high-level overview of changes. You can see a code diff of all of
these changes [here.](https://github.com/goatcorp/dalamud/compare/master...v9)

## Key Information

Expand All @@ -12,11 +11,7 @@ all of these changes
- **Release Date:** Targeted to release alongside Patch 6.5 (estimated
September/October 2023).
- **API Level:** 9
- **.NET Version:** .NET 7.0
- .NET 8 is due for official release in November 2023. Due to release timing,
we will be targeting .NET 7.0 for v9, and will upgrade to .NET 8 in a future
release, when we can confirm that it is stable on all platforms (Windows,
Wine, OS X).
- **.NET Version:** .NET 7.0 / .NET 8.0

## New Features

Expand Down

0 comments on commit 162bea4

Please sign in to comment.