Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Correcting example references to Stride.CommunityToolkit.Windows #136

Merged
merged 21 commits into from
May 26, 2024
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 .github/workflows/github-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ jobs:
working-directory: docs

- name: Deploy
uses: peaceiris/actions-gh-pages@v3.9.2
uses: peaceiris/actions-gh-pages@v4.0.0
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_site
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -348,3 +348,4 @@ MigrationBackup/

# Ionide (cross platform F# VS Code tools) working folder
.ionide/
/NDependOut
520 changes: 520 additions & 0 deletions Stride.CommunityToolkit.ndproj

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion Stride.CommunityToolkit.sln
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Example.Common", "examples\
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Stride.CommunityToolkit.Skyboxes", "src\Stride.CommunityToolkit.Skyboxes\Stride.CommunityToolkit.Skyboxes.csproj", "{423A1266-4A6D-425F-96CE-945A1802F711}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Stride.CommunityToolkit.Windows", "src\Stride.CommunityToolkit.Windows\Stride.CommunityToolkit.Windows.csproj", "{E5E01EDB-524C-4FC2-951B-321E5D08C972}"
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Stride.CommunityToolkit.Windows", "src\Stride.CommunityToolkit.Windows\Stride.CommunityToolkit.Windows.csproj", "{E5E01EDB-524C-4FC2-951B-321E5D08C972}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down
38 changes: 38 additions & 0 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Contributing

## Welcome Contributors

We appreciate your interest in contributing to the Stride Community Toolkit. This section provides all the information you need to get started, including guidelines, best practices, and resources to help you make meaningful contributions to the project. Whether you're fixing bugs, adding new features, or improving documentation, your efforts are valuable and greatly appreciated.

## Getting Started

Since the toolkit is currently in preview, we don't have extensive instructions for contributors. However, you can follow these general guidelines to get started:

- Feel free to make Pull Requests (PRs) directly to speed up your process. Optionally, create an issue on our [GitHub Issues](https://github.com/stride3d/stride-community-toolkit/issues) page, or work on an existing issue. Alternatively, you can start a discussion on our [GitHub Discussions](https://github.com/stride3d/stride-community-toolkit/discussions) page.
- For quick communication with the community, join our Discord server and participate in the #toolkit channel [here](https://discord.com/channels/500285081265635328/1179562410655363132).

## Documentation

We use DocFX for our documentation. The easiest way to contribute to the documentation is by looking at existing docs, duplicating pages, and updating the content accordingly. You can find helpful information on using DocFX and writing Markdown [here](https://dotnet.github.io/docfx/docs/markdown.html). We will also assist you in getting started with the documentation.

## Major Release Workflow

When preparing for a major release, such as upgrading from **.NET 8** to **.NET 9**, there are several key steps and pages that need to be updated. This section will list the necessary instructions to ensure a smooth transition.

### Steps for Major Release:

1. Update .NET reference on the Home page's `index.md`
1. Update .NET reference in `manual\gettings-started.md`
1. Update .NET reference in `manual\code-only\create-project.md`
1. Update `TargetFramework` in all `.csproj` files
1. Test all examples and ensure they work as expected

By following these steps, you can help ensure that each major release is well-documented and thoroughly tested, providing a smooth experience for all users of the toolkit.

## Additional Resources

- [Stride Community Toolkit GitHub Repository](https://github.com/stride3d/stride-community-toolkit)
- [Stride Game Engine GitHub Repository](https://github.com/stride3d/stride)
- [Stride Docs](https://doc.stride3d.net/)

Thank you for contributing to the Stride Community Toolkit 🙂.
17 changes: 9 additions & 8 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,15 @@
"_appTitle": "Stride Community Toolkit",
"_enableSearch": true,
"_appLogoPath": "media/stride-logo-blue-toolkit.svg",
"_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1 text-center small\"><p >Supported by the <a href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></p><p >Stride Community Toolkit Website v.1.0.0.1</p><p>&copy; .NET Foundation and Contributors</p></div>"
"_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1 text-center small\"><p >Supported by the <a href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></p><p >Stride Community Toolkit Website v.1.0.0.2</p><p>&copy; .NET Foundation and Contributors</p></div>"
},
"fileMetadata": {
"_appTitle": {
"tutorials/**/*.md": "Stride Tutorials",
"manual/**/*.md": "Stride Manual",
"ReleaseNotes/**/*.md": "Stride Release Notes",
"api/**/*.md": "Stride API"
"api/**/*.md": "Stride Community Toolkit API",
"tutorials/**/*.md": "Stride Community Toolkit Tutorials",
"release-notes/**/*.md": "Stride Community Toolkit Release Notes",
"manual/**/*.md": "Stride Community Toolkit Manual",
"contributing/**/*.md": "Stride Community Toolkit Contributing"
}
},
"sitemap": {
Expand All @@ -61,13 +62,13 @@
"release-notes/toc.yml",
"release-notes/**/*.md",
"manual/toc.yml",
"manual/**/*.md"
"manual/**/*.md",
"contributing/toc.yml",
"contributing/**/*.md"
]
},
{
"files": [
"articles/**.md",
"articles/**/toc.yml",
"toc.yml",
"*.md"
]
Expand Down
4 changes: 2 additions & 2 deletions docs/includes/global-note.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
> [!NOTE]
> The Stride Community Toolkit is currently in development. Documentation is incomplete and may contain errors. We published it early for your convenience, ahead of the toolkit's completion.
> [!WARNING]
> The toolkit is currently in development. Documentation is incomplete and may contain errors. We published it early for your convenience, ahead of the toolkit's completion.
5 changes: 4 additions & 1 deletion docs/includes/manual/examples/capsule-with-rigid-body.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
This code example demonstrates how to initialize a game, set up a basic 3D scene, create a 3D capsule entity, set its position, and add it to the scene using the extensions provided by the toolkit. The `CreatePrimitive()` method, a part of the toolkit, automatically equips the capsule entity with a rigid body and a collider. This example serves as a simple starting point for building a game with Stride, leveraging the utilities provided by the toolkit to simplify common game development tasks.
This code example demonstrates how to initialize a game, set up a basic 3D scene, add a skybox, create a 3D capsule entity, set its position, and add it to the scene using the extensions provided by the toolkit. The `Create3DPrimitive()` method, a part of the toolkit, automatically equips the capsule entity with a rigid body and a collider. This example serves as a simple starting point for building a game with Stride, leveraging the utilities provided by the toolkit to simplify common game development tasks.

> [!NOTE]
> This example requires the additional NuGet package `Stride.CommunityToolkit.Skyboxes`. Make sure to install it before running the code.
![Stride UI Example](../../../manual/code-only/examples/media/stride-game-engine-example01-basic-3d-scene.webp)
42 changes: 28 additions & 14 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
_disableToc: false
---
# Stride Community Toolkit Documentation

[![Join the chat at https://discord.gg/f6aerfE](https://img.shields.io/discord/500285081265635328.svg?style=flat&logo=discord&label=discord&logoColor=f2f2f2)](https://discord.gg/f6aerfE)
Expand All @@ -7,43 +10,54 @@

## 👋 Introduction

The [Stride Community Toolkit](https://github.com/stride3d/stride-community-toolkit) is a comprehensive set of C# helpers and [extensions](manual/entity-extensions/index.md) designed to enhance your experience with the [Stride Game Engine](https://www.stride3d.net/). It simplifies and exemplifies routine development tasks 🛠️, enabling you to build applications for Stride using **.NET 8** with ease 🎉.
The [Stride Community Toolkit](https://github.com/stride3d/stride-community-toolkit) is a set of C# helpers and [extensions](manual/animation-extensions/index.md) designed to enhance your experience with the [Stride Game Engine](https://www.stride3d.net/). It simplifies and streamlines routine development tasks 🛠️, making it easier to build applications for Stride using .NET 8 🎉.

> [!TIP]
> While the toolkit's extensions are helpful for many developers, experienced game developers may prefer to examine the toolkit's source code directly. The extensions are essentially convenience wrappers, and advanced users might benefit from implementing their own solutions based on the toolkit's code.
## 📦 Libraries

The toolkit includes the following libraries:

- `Stride.CommunityToolkit`: This is the core library. Use it for general-purpose extensions in a regular Stride project or for a code-only approach.
- `Stride.CommunityToolkit.Windows`: This library contains Windows-specific dependencies required for code-only approach.
- `Stride.CommunityToolkit.Skyboxes`: Enhances code-only projects by adding skybox functionality.

## 🔧 Installation

Available as a 📦 [NuGet package](https://www.nuget.org/packages/Stride.CommunityToolkit), the Stride Community Toolkit can be easily integrated into new or existing Stride Game C# projects. For more information on how to get started, please refer to the [Getting Started](manual/getting-started.md) page.
The toolkit, available as a 📦 [NuGet package](https://www.nuget.org/profiles/StrideCommunity), can be integrated into new or existing Stride Game C# projects. For more information on how to get started, please refer to the [Getting Started](manual/getting-started.md) page.

## 🚀 Rapid Prototyping and Development
## 🚀 Fast-Paced Development

This toolkit serves as our preferred solution for rapid 🏃 prototyping and accelerated game development. Unlike the more stable Stride Game Engine, the Stride Community Toolkit aims for a faster development momentum. As such, **breaking changes** are not only likely but should be expected. This approach allows us to quickly iterate and integrate new features and improvements. We believe this pace serves the needs of developers who are looking for cutting-edge tools and are comfortable with a more dynamic environment.
This toolkit serves as our preferred solution for rapid 🏃 prototyping and accelerated game development. Unlike the more stable Stride Game Engine, the Stride Community Toolkit aims for faster development momentum. As such, you should expect that **breaking changes** are likely to occur. This approach allows us to quickly iterate and integrate new features and improvements. We believe this pace serves the needs of developers who are looking for cutting-edge tools and are comfortable with a more dynamic environment.

## 🛠️ Toolkit Repository

The Stride Community Toolkit is an open-source, MIT licensed project hosted on GitHub and supported by the community. Access the source code or contribute 🤝 to the toolkit on its [GitHub Repository](https://github.com/stride3d/stride-community-toolkit).
The Stride Community Toolkit is an open-source, MIT-licensed project hosted on GitHub and supported by the community. Access the source code or contribute 🤝 to the toolkit on its [GitHub Repository](https://github.com/stride3d/stride-community-toolkit).

## 🎮 Game Engine Repository
## 🎮 Stride Game Engine Repository

Access the source code or contribute 🤝 to the Stride Game Engine on its [GitHub Repository](https://github.com/stride3d/stride). Explore a comprehensive guide on the [Stride Docs](https://doc.stride3d.net/) website.

## 📃 Documentation & Resources

Explore a range of resources to help you get the most out of the Stride Community Toolkit:
Explore a range of resources to help you get the most out of the toolkit:

- [Manual](manual/index.md): Get detailed guidance and best practices for using the toolkit.
- [Tutorials](tutorials/index.md): Step-by-step tutorials to help you learn various features of the toolkit.
- [Release Notes](release-notes/index.md): Stay updated with the latest changes and improvements.
- [API Reference](api/index.md): In-depth API documentation for a deep dive into the toolkit's capabilities.
- [Manual](manual/index.md): Detailed guidance and best practices for using the toolkit
- [Tutorials](tutorials/index.md): Step-by-step tutorials to help you learn various features of the toolkit
- [Release Notes](release-notes/index.md): Stay updated with the latest changes and improvements
- [API Reference](api/index.md): In-depth API documentation for a deep dive into the toolkit's capabilities

These resources are designed to provide comprehensive information and support for developers at all levels, from beginners to advanced users.
These resources provide comprehensive information and support for developers at all levels, from beginners to advanced users.

## 👥 Contributors

This section highlights the amazing contributors who have helped enhance the Stride Community Toolkit with their efforts.
We would like to thank our contributors for expanding the toolkit's capabilities:

- [DotLogix](https://github.com/dotlogix): Utility @Stride.CommunityToolkit.Rendering.Utilities.MeshBuilder, @Stride.CommunityToolkit.Rendering.Utilities.TextureCanvas and docs
- [Doprez](https://github.com/Doprez): Extensions
- [IXLLEGACYIXL](https://github.com/IXLLEGACYIXL): Extensions
- [Vaclav Elias](https://github.com/VaclavElias): Code only approach implementation, toolkit docs
- [Vaclav Elias](https://github.com/VaclavElias): Code-only approach implementation, toolkit docs
- [dfkeenan](https://github.com/dfkeenan): Previous toolkit implementation
- [Idomeneas1970](https://github.com/Idomeneas1970): Heightmap extensions
- [DockFrankenstein](https://github.com/DockFrankenstein): Script System Extensions
Loading